man/nmtui.1.in

   1 .\" nmtui (1) manual page
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public Licence along
  19 .\" with this manual; if not, write to the Free Software Foundation, Inc.,
  20 .\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21 .\"
  22 .\" Copyright 2014 Red Hat, Inc.
  23 .\"
  24 .TH NMTUI "1" "2014-11-06" "NetworkManager 1.2"
  25
  26 .SH NAME
  27 nmtui \- Text User Interface for controlling NetworkManager
  28 .SH SYNOPSIS
  29 .B nmtui
  30 .RI " [ " edit " | " connect " | " hostname " ] [ ... ] "
  31 .P
  32 .B nmtui\-edit
  33 .RI " [ " connection-id " | " connection-name " ] "
  34 .P
  35 .B nmtui\-connect
  36 .RI " [ " connection-name " | " connection-uuid " | " device-name " | " Wi-Fi-SSID " ] "
  37 .P
  38 .B nmtui\-hostname
  39
  40 .SH DESCRIPTION
  41 .B nmtui
  42 is a curses\(hybased TUI application for interacting with \fINetworkManager\fP.
  43 .P
  44 When starting \fInmtui\fP, the user is prompted to choose the activity to perform
  45 unless it was specified as the first argument.
  46 .P
  47 The supported activities are:
  48 .IP \(em 4
  49 \fIedit\fP: show a connection editor that supports adding, modifying, viewing and deleting
  50 connections. It provides similar functionality as \fInm\-connection\-editor\fP.
  51 .IP \(em 4
  52 \fIconnect\fP: show a list of available connections, with the option to activate or deactivate
  53 them. It provides similar functionality as \fInm\-applet\fP.
  54 .IP \(em 4
  55 \fIhostname\fP: set the system hostname.
  56
  57 .P
  58 Corresponding to above activities, \fInmtui\fP also comes with binaries named
  59 \fInmtui\-edit\fP, \fInmtui\-connect\fP, and \fInmtui-hostname\fP to skip the selection
  60 of the activities.
  61
  62 .SH SEE ALSO
  63 .BR NetworkManager(8),
  64 .BR nmcli(1).
  65 .BR nm\-applet(1).
  66 .BR nm\-connection\-editor(1).