Add command line parameter documentation

This commit is contained in:
Simon Stürz 2018-10-15 11:41:43 +02:00
parent 1bac0c4723
commit cd43518b11

View File

@ -3,6 +3,39 @@
This daemon allows to set up the wireless network using a bluetooth LE connection. The daemon will automatically start a bluetooth low energy server This daemon allows to set up the wireless network using a bluetooth LE connection. The daemon will automatically start a bluetooth low energy server
if the system is currently not connected to any network. Once the system is connected, the daemon will shutdown the bluetooth server. if the system is currently not connected to any network. Once the system is connected, the daemon will shutdown the bluetooth server.
# Command line parameters
$ nymea-network-manager --help
Usage:nymea-networkmanager [options]
This daemon allows to configure a wifi network using a bluetooth low energy connection.
Copyright © 2018 Simon Stürz <simon.stuerz@guh.io>
Options:
-h, --help Displays this help.
-v, --version Displays version information.
-d, --debug Enable more debug output.
-a, --advertise-name <NAME> The name of the bluetooth server.
Default "nymea".
-p, --platform-name <NAME> The name of the platform this daemon
is running. Default "nymea-box".
-t, --timeout <SECONDS> The timeout of the bluetooth server.
Minimum value is 10. Default "60".
-m, --mode <offline | always | start> Run the daemon in a specific mode.
Default "offline".
- offline: this mode starts the
bluetooth server once the device is
offline and not connected to any LAN
network.
- always: this mode enables the
bluetooth server as long the
application is running.
- start: this mode starts the bluetooth
server for 3 minutes on start and shuts
down after a connection.
# Bluetooth GATT profile # Bluetooth GATT profile
------------------------------------------- -------------------------------------------