.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "comitup\-cli" "1" "April 2018" "" ""
.hy
.SH NAME
.PP
comitup\-cli \- command\-line interface for comitup network
management
.SS SYNOPSIS
.IP
.nf
\f[C]
$\ `comitup\-cli`

State:\ HOTSPOT
Connection:\ hotspot\-1234
Points:
\ \ \ \ 1:\ MyAccessPoint
\ \ \ \ 2:\ HisAccessPoint
Available\ Commands:
\ \ \ \ (r)eload
\ \ \ \ (q)uit
\ \ \ \ connect\ to\ (<n>)
command?:
\f[]
.fi
.SS DESCRIPTION
.PP
The \f[B]comitup\-cli\f[] 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.
.PP
If the comitup(8) service is not running, \f[B]comitup\-cli\f[] will
immediately exit.
.PP
Display:
.IP \[bu] 2
\f[B]State\f[]
.RS 2
.PP
The \f[B]comitup\f[] states are \f[B]HOTSPOT\f[], \f[B]CONNECTING\f[],
and \f[B]CONNECTED\f[].
.PP
In the \f[B]HOTSPOT\f[] mode, \f[B]comitup\f[] creates a wifi hotspot
with the name \f[B]comitup\-<nn>\f[], where <nn> is a persistent
4\-digit number.
.PP
Once in \f[B]HOTSPOT\f[] mode, the system will occasionally (~1/min)
cycle through available defined connections, by transitioning to the
\f[B]CONNECTING\f[] mode.
The Access Point list is updated by this process.
Any command issued by \f[B]comitup\-cli\f[] will cause the next timeout
instance to be skipped.
.PP
Once a connection is established, the system will be in the
\f[B]CONNECTED\f[] mode.
If the connection is lost, failed, or deleted, the system will
transition back to the \f[B]HOTSPOT\f[] state.
.RE
.IP \[bu] 2
\f[B]Connection\f[]
.RS 2
.PP
The \f[C]ssid\f[] of the current active connection.
.RE
.IP \[bu] 2
\f[B]Points\f[]
.RS 2
.PP
While in the \f[B]HOTSPOT\f[] mode, \f[B]comitup\-cli\f[] will list the
currently\-visible access points, by \f[C]ssid\f[].
Access points with the strongest signal are sorted to the top of the
list.
The entries are numbered, for use with the \f[B]connect\f[] command.
.RE
.PP
Commands:
.IP \[bu] 2
\f[B]r\f[] \- \f[B]Reload\f[]
.RS 2
.PP
Refresh the displayed state, mode, and list of access points.
.RE
.IP \[bu] 2
\f[B]q\f[] \- \f[B]Quit\f[]
.RS 2
.PP
Exit \f[B]comitup.cli\f[].
.RE
.IP \[bu] 2
\f[B]d\f[] \- \f[B]Delete connection\f[]
.RS 2
.PP
Delete the configuration information for the current wifi connection.
This will cause \f[B]comitup\f[] to transition to the \f[B]HOTSPOT\f[]
mode.
.PP
This command is not available in the \f[B]HOTSPOT\f[] mode.
.RE
.IP \[bu] 2
\f[B]<n>\f[] \- \f[B]Connect to access point <n>\f[]
.RS 2
.PP
Define a connection for the selected access point, and then attempt to
connect.
.PP
This command is only available in the \f[B]HOTSPOT\f[] mode.
.RE
.IP \[bu] 2
\f[B]m\f[] \- \f[B]Manual connection\f[]
.RS 2
.PP
Enter an SSID manually.
.RE
.IP \[bu] 2
\f[B]i\f[] \- \f[B]Get information\f[]
.RS 2
.PP
Return the comitup version and host name for the current instance.
.RE
.SS COPYRIGHT
.PP
Comitup is Copyright (C) 2016\-2017 David Steele <steele\@debian.org>
.SS SEE ALSO
.PP
comitup(8), comitup\-conf(5), comitup\-web(8)