[network-manager-applet/nma-0-9-8] man: add manpages for nm-applet and nm-connection-editor (bgo #594726) (rh #564465) (rh #564467)



commit 0e05a90448fee532ddadfab2e8469b6b9b0f877c
Author: Dan Williams <dcbw redhat com>
Date:   Fri Feb 15 15:46:09 2013 -0600

    man: add manpages for nm-applet and nm-connection-editor (bgo #594726) (rh #564465) (rh #564467)

 Makefile.am                   |    2 +-
 configure.ac                  |    3 ++
 man/Makefile.am               |    2 +
 man/nm-applet.1.in            |   43 +++++++++++++++++++++++++++++
 man/nm-connection-editor.1.in |   60 +++++++++++++++++++++++++++++++++++++++++
 5 files changed, 109 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 6bdfb0d..608110f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,7 +2,7 @@ include $(GLIB_MAKEFILE)
 
 ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
 
-SUBDIRS = src icons po
+SUBDIRS = src icons po man
 
 EXTRA_DIST =                           \
        CONTRIBUTING                    \
diff --git a/configure.ac b/configure.ac
index 85b21ab..0641f80 100644
--- a/configure.ac
+++ b/configure.ac
@@ -268,5 +268,8 @@ icons/32/Makefile
 icons/48/Makefile
 icons/scalable/Makefile
 po/Makefile.in
+man/Makefile
+man/nm-applet.1
+man/nm-connection-editor.1
 ])
 AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..06ab1bb
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,2 @@
+man_MANS = nm-applet.1 nm-connection-editor.1
+
diff --git a/man/nm-applet.1.in b/man/nm-applet.1.in
new file mode 100644
index 0000000..165e2c3
--- /dev/null
+++ b/man/nm-applet.1.in
@@ -0,0 +1,43 @@
+.\" nm-applet (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) 2013 Red Hat, Inc.
+.\"
+.TH NM-APPLET "1" "15 February 2013"
+
+.SH NAME
+nm-applet \- network monitor and control GUI applet
+.SH SYNOPSIS
+.B nm-applet
+.RI " [ " OPTIONS " ]
+
+.SH DESCRIPTION
+.B nm-applet
+is a GTK-based GUI applet to monitor network status and devices and to start
+and stop network connections managed by NetworkManager.  \fInm\-applet\fP
+is normally started at login by the desktop session manager and does not
+need to be run manually.  \fInm\-online\fP conforms to the XDG System Tray
+specification and requires that the desktop environment provide a System Tray
+implementation in which the applet will be embedded.
+
+.SH SEE ALSO
+.BR NetworkManager(8),
+.BR nm-connection-editor(1).
diff --git a/man/nm-connection-editor.1.in b/man/nm-connection-editor.1.in
new file mode 100644
index 0000000..5ccd21d
--- /dev/null
+++ b/man/nm-connection-editor.1.in
@@ -0,0 +1,60 @@
+.\" nm-connection-editor (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) 2013 Red Hat, Inc.
+.\"
+.TH NM-CONNECTION-EDITOR "1" "15 February 2013"
+
+.SH NAME
+nm-connection-editor \- network connection editor for NetworkManager
+.SH SYNOPSIS
+.B nm-connection-editor
+.RI " [ " OPTIONS " ]
+
+.SH DESCRIPTION
+.B nm-connection-editor
+is a GTK-based application to add, remove, and modify network connections
+stored by NetworkManager.  NetworkManager must be running for any network
+connections to be added, removed, or modified.
+
+.SH OPTIONS
+.TP
+.B \-t, \-\-type=<type>
+Type of connection to create or show.  Values are NetworkManager
+setting names, eg "802-3-ethernet", "802-11-wireless", "bridge", "bond",
+"wimax", "infiniband", "vlan", etc.  Does nothing if \-\-create or \-\-show
+is not given.
+.TP
+.B \-x, \-\-show
+Expand or collapse the network list to highlight the network connection type
+given by \-\-type.
+.TP
+.B \-x, \-\-create
+Create a new connection of the type given by \-\-type and allow the user to
+modify connection details.
+.TP
+.B \-q, \-\-edit=<uuid>
+Show the network connection edit window for the connection of the given UUID.
+
+.SH SEE ALSO
+.BR nmcli(1),
+.BR NetworkManager(8),
+.BR nm-applet(1).


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]