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>
This commit is contained in:
Thomas Haller
2014-11-05 23:38:19 +01:00
parent 75a0ac080f
commit 1e8b681d4f
4 changed files with 80 additions and 0 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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)

66
man/nmtui.1.in Normal file
View File

@@ -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).