[Python-modules-commits] [wifi] 12/13: Add manpage for wifi binary

[Ethan Ward]

This is an automated email from the git hooks/post-receive script.

ethanward-guest pushed a commit to branch master
in repository wifi.

commit 5f357db77a4eca69465f0dfb3efbd08a41daab21
Author: Ethan Ward <ethan.ward at mycroft.ai>
Date:   Fri Aug 11 16:59:21 2017 -0500

    Add manpage for wifi binary
---
 debian/wifi.1 | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)

diff --git a/debian/wifi.1 b/debian/wifi.1
new file mode 100644
index 0000000..6564730
--- /dev/null
+++ b/debian/wifi.1
@@ -0,0 +1,77 @@
+.TH man 1 "11 August 2017" "0.3.8" "wifi manpage"
+.SH NAME
+wifi \- a command line wrapper for iwlist and /etc/network/interfaces
+.SH SYNOPSIS
+wifi [-h | --help] [-i INTERFACE | --interface INTERFACE] [-f FILE | --file FILE]
+            command [command positional arguments]
+.SH DESCRIPTION
+Wifi provides a command line wrapper for iwlist and /etc/network/interfaces
+that makes it easier to connect the WiFi networks from the command line.
+.SH OPTIONS
+.TP
+.B [-h | --help]
+Prints a help message and exits.
+.TP
+.B [-i INTERFACE | --interface INTERFACE]
+Specifies which interface to use (wlan0, eth0, etc.)
+.TP
+.B [-f FILE | --file FILE]
+Specifies which file for scheme storage
+.SH COMMANDS
+.TP
+.B scan [-h]
+Shows a list of available networks
+
+optional arguments:
+  -h, --help    show a help message and exit
+.TP
+.B list [-h]
+Shows a list of networks already configured
+
+optional arguments:
+  -h, --help    show a help message and exit
+.TP
+.B config [-h] SCHEME [SSID]
+Prints the configuration to connect to a new network.
+
+positional arguments:
+  SCHEME      A memorable nickname for a wireless network. If SSID is not
+              provided, the network will be guessed using SCHEME.
+  SSID        The SSID for the network to which you wish to connect. This is
+              fuzzy matched, so you don't have to be precise.
+
+optional arguments:
+  -h, --help    show a help message and exit
+.TP
+.B add [-h] SCHEME [SSID]
+Prints the configuration to connect to a new network.
+
+positional arguments:
+  SCHEME      A memorable nickname for a wireless network. If SSID is not
+              provided, the network will be guessed using SCHEME.
+  SSID        The SSID for the network to which you wish to connect. This is
+              fuzzy matched, so you don't have to be precise.
+
+optional arguments:
+  -h, --help    show a help message and exit
+.TP
+.B connect [-h] [-a] SCHEME
+Connects to the network corresponding to SCHEME.
+
+positional arguments:
+  SCHEME        The nickname of the network to which you wish to connect.
+
+optional arguments:
+  -h, --help    show a help message and exit
+  -a, --ad-hoc  Connect to a network without storing it in the config file
+.TP
+.B autoconnect [-h]
+Searches for saved schemes that are currently available and connects to the first one it finds.
+
+optional arguments:
+  -h, --help  show this help message and exit
+.SH SEE ALSO
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Ethan Ward <ethan.ward at mycroft.ai>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/wifi.git