diff options
author | Thomas Haller <thaller@redhat.com> | 2014-11-05 23:38:19 +0100 |
---|---|---|
committer | Thomas Haller <thaller@redhat.com> | 2014-11-11 16:01:38 +0100 |
commit | 1e8b681d4f10c2b5e9478ec4972cad64aa1f8e7c (patch) | |
tree | cc32641e2dcc1c9f717802fa213386a7a18902cb | |
parent | 75a0ac080f8ea6124020d02a2e0a67affd55ee65 (diff) | |
download | NetworkManager-1e8b681d4f10c2b5e9478ec4972cad64aa1f8e7c.tar.gz |
man: add manual page for nmtui(1)
https://bugzilla.gnome.org/show_bug.cgi?id=739710
Branch: th/bgo739710_man_nmtui
Signed-off-by: Thomas Haller <thaller@redhat.com>
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | contrib/fedora/rpm/NetworkManager.spec | 4 | ||||
-rw-r--r-- | man/Makefile.am | 9 | ||||
-rw-r--r-- | man/nmtui.1.in | 66 |
4 files changed, 80 insertions, 0 deletions
diff --git a/configure.ac b/configure.ac index 61f8656871..2aecae72b7 100644 --- a/configure.ac +++ b/configure.ac @@ -975,6 +975,7 @@ man/NetworkManager.conf.xml man/nm-system-settings.conf.5 man/nm-online.1 man/nmcli.1 +man/nmtui.1 po/Makefile.in policy/Makefile policy/org.freedesktop.NetworkManager.policy.in diff --git a/contrib/fedora/rpm/NetworkManager.spec b/contrib/fedora/rpm/NetworkManager.spec index b0c76790b9..b19159bde8 100644 --- a/contrib/fedora/rpm/NetworkManager.spec +++ b/contrib/fedora/rpm/NetworkManager.spec @@ -521,6 +521,9 @@ fi %{_libexecdir}/nm-iface-helper %dir %{_libdir}/NetworkManager %{_libdir}/NetworkManager/libnm-settings-plugin*.so +%if 0%{?with_nmtui} +%exclude %{_mandir}/man1/nmtui* +%endif %{_mandir}/man1/* %{_mandir}/man5/* %{_mandir}/man8/* @@ -651,6 +654,7 @@ fi %{_bindir}/nmtui-edit %{_bindir}/nmtui-connect %{_bindir}/nmtui-hostname +%{_mandir}/man1/nmtui* %endif %changelog diff --git a/man/Makefile.am b/man/Makefile.am index 376a8b42ac..66f479dd53 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -52,6 +52,7 @@ endif configure_generated_man_pages = \ nmcli.1 \ + nmtui.1 \ nm-online.1 \ nm-system-settings.conf.5 @@ -82,6 +83,14 @@ DISTCLEANFILES = \ man_MANS += $(configure_generated_man_pages) +links = nmtui-edit nmtui-connect nmtui-hostname + +install-data-hook: + for link in $(links); do \ + ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ + done + + if ENABLE_GTK_DOC man_MANS += $(docbook_generated_man_pages) CLEANFILES += $(docbook_generated_man_pages) diff --git a/man/nmtui.1.in b/man/nmtui.1.in new file mode 100644 index 0000000000..2aa99eb96a --- /dev/null +++ b/man/nmtui.1.in @@ -0,0 +1,66 @@ +.\" nmtui (1) manual page +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public Licence along +.\" with this manual; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +.\" +.\" Copyright (C) 2014 Red Hat, Inc. +.\" +.TH NMTUI "1" "6 November 2014" + +.SH NAME +nmtui \- Text User Interface for controlling NetworkManager +.SH SYNOPSIS +.B nmtui +.RI " [ " edit " | " connect " | " hostname " ] [ ... ] " +.P +.B nmtui\-edit +.RI " [ " connection-id " | " connection-name " ] " +.P +.B nmtui\-connect +.RI " [ " connection-name " | " connection-uuid " | " device-name " | " Wi-Fi-SSID " ] " +.P +.B nmtui\-hostname + +.SH DESCRIPTION +.B nmtui +is a curses\(hybased TUI application for interacting with \fINetworkManager\fP. +.P +When starting \fInmtui\fP, the user is prompted to choose the activity to perform +unless it was specified as first argument. +.P +The supported activities are: +.IP \(em 4 +\fIedit\fP: show a connection editor that supports adding, modifying, viewing and deleting. +It provides similar functionality as \fInm\-connection\-editor\fP. +.IP \(em 4 +\fIconnect\fP: show a list of available connections, with the option to activate or deactivate +them. It provides similar functionality as \fInm\-applet\fP. +.IP \(em 4 +\fIhostname\fP: set the system hostname. + +.P +Corresponding to above activities, \fInmtui\fP also comes with binaries named +\fInmtui\-edit\fP, \fInmtui\-connect\fP, and \fInmtui-hostname\fP to skip the selection +of the actvities. + +.SH SEE ALSO +.BR NetworkManager(8), +.BR nmcli(1). +.BR nm\-applet(1). +.BR nm\-connection\-editor(1). |