Skip to contentSkip to conversation

manpage: Add command options and examples for iwctl

PATCH Applied Tim Kourt 2 participants 2 messages Oct 29, 2019

lore
Share & tools
lore

Tim Kourt

author
#0 lore raw

PATCH 1/1 manpage: Add command options and examples for iwctl

---
 client/iwctl.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)
client/iwctl.rst +48 -2
index 51873965..54af4b7d 100644
@@ -16,12 +16,58 @@ Internet wireless control utility
 SYNOPSIS
 ========
 
-**iwctl** [*options* ...]
+**iwctl** [*options* ...] [*commands* ...]
 
 DESCRIPTION
 ===========
 
-Tool for configuring **iwd** daemon via D-Bus interface.
+Tool for configuring **iwd** daemon via D-Bus interface. It supports both an
+interactive mode and command line mode.
+
+OPTIONS
+=======
+
+--username, -u          Provide username.
+--password, -p          Provide password.
+--passphrase, -P        Provide passphrase.
+--dont-ask, -v          Don’t ask for missing credentials.
+--help, -h              Show help message and exit.
+
+EXAMPLES
+========
+
+Interactive mode
+----------------
+
+To start an interactive mode and list all available commands do:
+.. code-block::
+
+   $ iwctl
+   [iwd]# help
+
+To connect to a network:
+.. code-block::
+
+   [iwd]# device list
+   [iwd]# station DEVICE scan
+   [iwd]# station DEVICE get-networks
+   [iwd]# station DEVICE connect SSID
+
+Command line mode
+----------------------
+
+To list all available commands in command line mode and exit do:
+.. code-block::
+
+   $ iwctl --help
+
+To connect to a network:
+.. code-block::
+
+   $ iwctl device list
+   $ iwctl station DEVICE scan
+   $ iwctl station DEVICE get-networks
+   $ iwctl --passphrase=PASSPHRASE station DEVICE connect SSID
 
 SEE ALSO
 ========
Signature · 1 line
2.13.6
#1 lore raw

Hi Tim,

Quoted 4 lines · Tim Kourt
---
  client/iwctl.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
  1 file changed, 48 insertions(+), 2 deletions(-)

Applied, thanks.

Regards,
-Denis