[PATCH] manpage: Add command options and examples for iwctl

[PATCH] manpage: Add command options and examples for iwctl

[Tim Kourt]

[-- Attachment #1: Type: text/plain, Size: 1694 bytes --]

---
 client/iwctl.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/client/iwctl.rst b/client/iwctl.rst
index 51873965..54af4b7d 100644
--- a/client/iwctl.rst
+++ b/client/iwctl.rst
@@ -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
 ========
-- 
2.13.6

Re: [PATCH] manpage: Add command options and examples for iwctl

[Denis Kenzior]

[-- Attachment #1: Type: text/plain, Size: 233 bytes --]

Hi Tim,

On 10/29/19 2:45 PM, Tim Kourt wrote:
> ---
>   client/iwctl.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
>   1 file changed, 48 insertions(+), 2 deletions(-)
> 

Applied, thanks.

Regards,
-Denis