.\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . .TH "COMITUP\-CLI" "1" "January 2017" "" "" . .SH "NAME" \fBcomitup\-cli\fR \- command\-line interface for comitup network management . .SH "SYNOPSIS" . .nf $ `comitup\-cli` State: HOTSPOT Connection: hotspot\-1234 Points: 1: MyAccessPoint 2: HisAccessPoint Available Commands: (r)eload (q)uit connect to () command?: . .fi . .SH "DESCRIPTION" The \fBcomitup\-cli\fR utility provides access to the comitup(8) D\-Bus interface\. It is intended to serve as a debug tool, and a source code example for connecting to the interface\. . .P If the comitup(8) service is not running, \fBcomitup\-cli\fR will immediately exit\. . .P Display: . .IP "\(bu" 4 \fBState\fR . .IP The \fBcomitup\fR states are \fBHOTSPOT\fR, \fBCONNECTING\fR, and \fBCONNECTED\fR\. . .IP In the \fBHOTSPOT\fR mode, \fBcomitup\fR creates a wifi hotspot with the name \fBcomitup\-\fR, where is a persistent 4\-digit number\. . .IP Once in \fBHOTSPOT\fR mode, the system will occasionally (~1/min) cycle through available defined connections, by transitioning to the \fBCONNECTING\fR mode\. The Access Point list is updated by this process\. Any command issued by \fBcomitup\-cli\fR will cause the next timeout instance to be skipped\. . .IP Once a connection is established, the system will be in the \fBCONNECTED\fR mode\. If the connection is lost, failed, or deleted, the system will transition back to the \fBHOTSPOT\fR state\. . .IP "\(bu" 4 \fBConnection\fR . .IP The \fBssid\fR of the current active connection\. . .IP "\(bu" 4 \fBPoints\fR . .IP While in the \fBHOTSPOT\fR mode, \fBcomitup\-cli\fR will list the currently\-visible access points, by \fBssid\fR\. Access points with the strongest signal are sorted to the top of the list\. The entries are numbered, for use with the \fBconnect\fR command\. . .IP "" 0 . .P Commands: . .IP "\(bu" 4 \fBr\fR \- \fBReload\fR . .IP Refresh the displayed state, mode, and list of access points\. . .IP "\(bu" 4 \fBq\fR \- \fBQuit\fR . .IP Exit \fBcomitup\.cli\fR\. . .IP "\(bu" 4 \fBd\fR \- \fBDelete connection\fR . .IP Delete the configuration information for the current wifi connection\. This will cause \fBcomitup\fR to transition to the \fBHOTSPOT\fR mode\. . .IP This command is not available in the \fBHOTSPOT\fR mode\. . .IP "\(bu" 4 \fB\fR \- \fBConnect to access point \fR . .IP Define a connection for the selected access point, and then attempt to connect\. . .IP This command is only available in the \fBHOTSPOT\fR mode\. . .IP "\(bu" 4 \fBm\fR \- \fBManual connection\fR . .IP Enter an SSID manually\. . .IP "\(bu" 4 \fBi\fR \- \fBGet information\fR . .IP Return the comitup version and host name for the current instance\. . .IP "" 0 . .SH "COPYRIGHT" Comitup is Copyright (C) 2016\-2017 David Steele . .SH "SEE ALSO" comitup(8), comitup\-conf(5), comitup\-web(8)