From cde075d09d9279afc005980966415bf8bfb99b00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 11 Jan 2019 00:04:07 +0100 Subject: [PATCH] Update README help message --- README.md | 61 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index a4dd6a3..93a5bbf 100644 --- a/README.md +++ b/README.md @@ -53,32 +53,41 @@ this repository and it will be installed to /etc/nymea-networkmanager.conf with $ 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 - - Options: - -h, --help Displays this help. - -v, --version Displays version information. - -d, --debug Enable more debug output. - -a, --advertise-name The name of the bluetooth server. - Default "nymea". - -p, --platform-name The name of the platform this daemon - is running. Default "nymea-box". - -t, --timeout The timeout of the bluetooth server. - Minimum value is 10. Default "60". - -m, --mode 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. +This daemon allows to configure a wifi network using a bluetooth low energy connection. + +Copyright © 2018 - 2019 Simon Stürz + +Options: + -h, --help Displays this help. + -v, --version Displays version information. + -d, --debug Enable more debug output. + -a, --advertise-name The name of the bluetooth + server. Default "BT WLAN setup". + -p, --platform-name The name of the platform this + daemon is running. Default + "nymea-box". + -t, --timeout The timeout of the bluetooth + server. Minimum value is 10. + Default "60". + -m, --mode Run the daemon in a specific + mode. Default is "offline". + - offline: this mode starts the + bluetooth server once the device + is offline and not connected to + any LAN network. + - once: this mode starts the + bluetooth server only if no + network configuration exists. + 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.