manpage: Add command options and examples for iwctl

This commit is contained in:
Tim Kourt 2019-10-29 13:03:44 -07:00 committed by Denis Kenzior
parent 8d73480d99
commit d2bbdea24f
1 changed files with 48 additions and 2 deletions

View File

@ -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
========