From d2bbdea24f85797b6509791f655be8397c1d2ebc Mon Sep 17 00:00:00 2001 From: Tim Kourt Date: Tue, 29 Oct 2019 13:03:44 -0700 Subject: [PATCH] manpage: Add command options and examples for iwctl --- client/iwctl.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/client/iwctl.rst b/client/iwctl.rst index 51873965..7bdc1c26 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 ========