Update README help message
This commit is contained in:
parent
044a8a7cdd
commit
cde075d09d
61
README.md
61
README.md
@ -53,32 +53,41 @@ this repository and it will be installed to /etc/nymea-networkmanager.conf with
|
|||||||
$ nymea-network-manager --help
|
$ nymea-network-manager --help
|
||||||
Usage:nymea-networkmanager [options]
|
Usage:nymea-networkmanager [options]
|
||||||
|
|
||||||
This daemon allows to configure a wifi network using a bluetooth low energy connection.
|
This daemon allows to configure a wifi network using a bluetooth low energy connection.
|
||||||
|
|
||||||
Copyright © 2018 Simon Stürz <simon.stuerz@guh.io>
|
Copyright © 2018 - 2019 Simon Stürz <simon.stuerz@guh.io>
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help Displays this help.
|
-h, --help Displays this help.
|
||||||
-v, --version Displays version information.
|
-v, --version Displays version information.
|
||||||
-d, --debug Enable more debug output.
|
-d, --debug Enable more debug output.
|
||||||
-a, --advertise-name <NAME> The name of the bluetooth server.
|
-a, --advertise-name <NAME> The name of the bluetooth
|
||||||
Default "nymea".
|
server. Default "BT WLAN setup".
|
||||||
-p, --platform-name <NAME> The name of the platform this daemon
|
-p, --platform-name <NAME> The name of the platform this
|
||||||
is running. Default "nymea-box".
|
daemon is running. Default
|
||||||
-t, --timeout <SECONDS> The timeout of the bluetooth server.
|
"nymea-box".
|
||||||
Minimum value is 10. Default "60".
|
-t, --timeout <SECONDS> The timeout of the bluetooth
|
||||||
-m, --mode <offline | always | start> Run the daemon in a specific mode.
|
server. Minimum value is 10.
|
||||||
Default "offline".
|
Default "60".
|
||||||
- offline: this mode starts the
|
-m, --mode <offline | once | always | start> Run the daemon in a specific
|
||||||
bluetooth server once the device is
|
mode. Default is "offline".
|
||||||
offline and not connected to any LAN
|
- offline: this mode starts the
|
||||||
network.
|
bluetooth server once the device
|
||||||
- always: this mode enables the
|
is offline and not connected to
|
||||||
bluetooth server as long the
|
any LAN network.
|
||||||
application is running.
|
- once: this mode starts the
|
||||||
- start: this mode starts the bluetooth
|
bluetooth server only if no
|
||||||
server for 3 minutes on start and shuts
|
network configuration exists.
|
||||||
down after a connection.
|
Once a network connection exists
|
||||||
|
the server will never start
|
||||||
|
again.
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user