man: convert nmtui(1) manual to docbook refentry

5 files changed, 138 insertions, 2 deletions

diff --git a/configure.ac b/configure.ac
index 447bb375e3..b0eb788afd 100644
--- a/configure.ac
+++ b/configure.ac
@@ -962,6 +962,7 @@ GTK_DOC_CHECK(1.0)
 install_pregen_manpages=no
 if test "$enable_gtk_doc" != "yes" \
 	-a -f man/nmcli.1 \
+	-a -f man/nmtui.1 \
 	-a -f man/NetworkManager.conf.5 \
 	-a -f man/nm-settings.5 \
 	-a -f man/nm-settings-keyfile.5 \
@@ -1077,7 +1078,6 @@ introspection/all.xml
 man/Makefile
 man/nm-system-settings.conf.5
 man/nm-online.1
-man/nmtui.1
 po/Makefile.in
 policy/Makefile
 policy/org.freedesktop.NetworkManager.policy.in
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
index 7174b3a479..3d329bc04b 100644
--- a/docs/api/Makefile.am
+++ b/docs/api/Makefile.am
@@ -81,6 +81,7 @@ content_files = \
 	$(top_builddir)/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml \
 	$(top_builddir)/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml \
 	$(top_builddir)/man/nmcli.xml \
+	$(top_builddir)/man/nmtui.xml \
 	$(top_builddir)/man/NetworkManager.xml \
 	$(top_builddir)/man/NetworkManager.conf.xml \
 	$(top_builddir)/man/nmcli-examples.xml \
diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml
index 584908a26b..ea08e9f85d 100644
--- a/docs/api/network-manager-docs.xml
+++ b/docs/api/network-manager-docs.xml
@@ -145,6 +145,7 @@
   <chapter id="manpages">
     <title>UNIX Manual Pages</title>
     <xi:include href="../../man/nmcli.xml"/>
+    <xi:include href="../../man/nmtui.xml"/>
     <xi:include href="../../man/NetworkManager.xml"/>
     <xi:include href="../../man/NetworkManager.conf.xml"/>
     <xi:include href="../../man/nmcli-examples.xml"/>
diff --git a/man/Makefile.am b/man/Makefile.am
index 5154a48dca..29f78c1139 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -69,12 +69,12 @@ CLEANFILES +=				\
 endif
 
 configure_generated_man_pages =		\
-	nmtui.1				\
 	nm-online.1			\
 	nm-system-settings.conf.5
 
 docbook_generated_man_pages =		\
 	nmcli.1				\
+	nmtui.1				\
 	NetworkManager.8		\
 	NetworkManager.conf.5		\
 	nmcli-examples.5
diff --git a/man/nmtui.xml b/man/nmtui.xml
new file mode 100644
index 0000000000..e203c7d04f
--- /dev/null
+++ b/man/nmtui.xml
@@ -0,0 +1,134 @@
+<?xml version='1.0'?>
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  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 2010 - 2016 Red Hat, Inc.
+-->
+
+<refentry id='nmtui'>
+
+  <refentryinfo>
+    <title>nmtui</title>
+    <author>NetworkManager developers</author>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>nmtui</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="source">NetworkManager</refmiscinfo>
+    <refmiscinfo class="manual">General Commands Manual</refmiscinfo>
+    <refmiscinfo class="version">1.2</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>nmtui</refname>
+    <refpurpose>Text User Interface for controlling NetworkManager</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command><group choice='plain'>
+        <arg choice='plain'>nmtui-edit</arg>
+        <arg choice='plain'>nmtui edit</arg>
+      </group></command>
+      <arg choice='plain'>
+        <group choice='req'>
+          <arg choice='plain'><replaceable>name</replaceable></arg>
+          <arg choice='plain'><replaceable>id</replaceable></arg>
+        </group>
+      </arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command><group choice='plain'>
+        <arg choice='plain'>nmtui-connect</arg>
+        <arg choice='plain'>nmtui connect</arg>
+      </group></command>
+      <arg choice='plain'>
+        <group choice='req'>
+          <arg choice='plain'><replaceable>name</replaceable></arg>
+          <arg choice='plain'><replaceable>uuid</replaceable></arg>
+          <arg choice='plain'><replaceable>device</replaceable></arg>
+          <arg choice='plain'><replaceable>SSID</replaceable></arg>
+        </group>
+      </arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command><group choice='plain'>
+        <arg choice='plain'>nmtui-hostname</arg>
+        <arg choice='plain'>nmtui hostname</arg>
+      </group></command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'><title>Description</title>
+    <para><command>nmtui</command> is a curses‐based TUI application for
+    interacting with NetworkManager. When starting <command>nmtui</command>, the
+    user is prompted to choose the activity to perform unless it was specified as
+    the first argument.</para>
+
+    <para>The supported activities are:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>edit</option></term>
+        <listitem>
+          <para>Show a connection editor that supports adding, modifying, viewing and
+          deleting connections. It provides similar functionality as
+          <command>nm-connection-editor</command>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>connect</option></term>
+        <listitem>
+          <para>Show a list of available connections, with the option to activate or
+          deactivate them. It provides similar functionality as
+          <command>nm-applet</command>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>hostname</option></term>
+        <listitem>
+          <para>Set the system hostname.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>Corresponding to above activities, <command>nmtui</command> also comes
+    with binaries named <command>nmtui-edit</command>,
+    <command>nmtui-connect</command>, and <command>nmtui-hostname</command> to skip
+    the selection of the activities.</para>
+  </refsect1>
+
+  <refsect1 id='see_also'><title>See Also</title>
+    <para><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+  </refsect1>
+
+</refentry>