.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "comitup-cli" "8" "February 2019" "" ""
.hy
.SH NAME
.PP
comitup-cli \- command-line interface for comitup network management
.SS SYNOPSIS
.IP
.nf
\f[C]
$ \[ga]comitup-cli\[ga]

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