All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tim Kourt <tim.a.kourt@linux.intel.com>
To: iwd@lists.01.org
Subject: [PATCH] manpage: Add command options and examples for iwctl
Date: Tue, 29 Oct 2019 12:45:45 -0700	[thread overview]
Message-ID: <20191029194545.6619-1-tim.a.kourt@linux.intel.com> (raw)

[-- 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

             reply	other threads:[~2019-10-29 19:45 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-29 19:45 Tim Kourt [this message]
2019-10-29 20:07 ` [PATCH] manpage: Add command options and examples for iwctl Denis Kenzior

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191029194545.6619-1-tim.a.kourt@linux.intel.com \
    --to=tim.a.kourt@linux.intel.com \
    --cc=iwd@lists.01.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.