man: convert nm-online(1) manual to docbook refentry

6 files changed, 172 insertions, 78 deletions

diff --git a/configure.ac b/configure.ac
index b0eb788afd..641968003c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -963,6 +963,7 @@ install_pregen_manpages=no
 if test "$enable_gtk_doc" != "yes" \
 	-a -f man/nmcli.1 \
 	-a -f man/nmtui.1 \
+	-a -f man/nm-online.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/Makefile
 introspection/all.xml
 man/Makefile
 man/nm-system-settings.conf.5
-man/nm-online.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 3d329bc04b..957977239d 100644
--- a/docs/api/Makefile.am
+++ b/docs/api/Makefile.am
@@ -82,6 +82,7 @@ content_files = \
 	$(top_builddir)/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml \
 	$(top_builddir)/man/nmcli.xml \
 	$(top_builddir)/man/nmtui.xml \
+	$(top_builddir)/man/nm-online.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 ea08e9f85d..3cf2c9edb0 100644
--- a/docs/api/network-manager-docs.xml
+++ b/docs/api/network-manager-docs.xml
@@ -146,6 +146,7 @@
     <title>UNIX Manual Pages</title>
     <xi:include href="../../man/nmcli.xml"/>
     <xi:include href="../../man/nmtui.xml"/>
+    <xi:include href="../../man/nm-online.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 29f78c1139..dc535aa2f5 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -69,12 +69,12 @@ CLEANFILES +=				\
 endif
 
 configure_generated_man_pages =		\
-	nm-online.1			\
 	nm-system-settings.conf.5
 
 docbook_generated_man_pages =		\
 	nmcli.1				\
 	nmtui.1				\
+	nm-online.1			\
 	NetworkManager.8		\
 	NetworkManager.conf.5		\
 	nmcli-examples.5
diff --git a/man/nm-online.1.in b/man/nm-online.1.in
deleted file mode 100644
index 4ee6fb1dca..0000000000
--- a/man/nm-online.1.in
+++ /dev/null
@@ -1,76 +0,0 @@
-.\" nm-online (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) 2010 - 2014 Red Hat, Inc.
-.\"
-.TH NM-ONLINE "1" "2014-03-25" "NetworkManager 1.2"
-
-.SH NAME
-nm-online \- ask NetworkManager whether the network is connected
-.SH SYNOPSIS
-.B nm-online
-.RI " [ " OPTIONS " ]
-
-.SH DESCRIPTION
-.B nm-online
-is a utility to find out whether we are online. It is done by asking
-NetworkManager about its status. When run, \fInm\-online\fP waits until
-NetworkManager reports an active connection, or specified timeout expires. On
-exit, the returned status code should be checked (see the return codes below).
-.P
-By default NetworkManager waits for IPv4 dynamic addressing to complete but does
-not wait for the "auto" IPv6 dynamic addressing.  To wait for IPv6 addressing to
-complete, either (1) change the network connection's IPv6 "may-fail" setting to "no",
-and/or (2) change the IPv6 addressing method to "manual" or "dhcp", to indicate that
-IPv6 connectivity is expected.
-.SH OPTIONS
-.TP
-.B \-t, \-\-timeout <timeout_value>
-Time to wait for a connection, in seconds.  If the option is not provided,
-the default timeout is 30 seconds.
-.TP
-.B \-x, \-\-exit
-Exit immediately if NetworkManager is not running or connecting.
-.TP
-.B \-q, \-\-quiet
-Don't print anything.
-.TP
-.B \-s, \-\-wait-for-startup
-Wait for NetworkManager startup to complete, rather than waiting for
-network connectivity specifically. Startup is considered complete once
-NetworkManager has activated (or attempted to activate) every
-auto-activate connection which is available given the current network
-state. (This is generally only useful at boot time; after startup has
-completed, \fInm-online -s\fP will just return immediately, regardless
-of the current network state.)
-
-.SH EXIT STATUS
-
-.IP "0" 4
-Success - already online or connection established within given timeout
-.IP "1" 4
-Offline or not online within given timeout
-.IP "2" 4
-Unspecified error
-
-.SH SEE ALSO
-.BR nmcli (1),
-.BR NetworkManager(8).
diff --git a/man/nm-online.xml b/man/nm-online.xml
new file mode 100644
index 0000000000..ff7815618d
--- /dev/null
+++ b/man/nm-online.xml
@@ -0,0 +1,168 @@
+<?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">
+
+<!--
+  nm-online(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='nm-online'>
+
+  <refentryinfo>
+    <title>nm-online</title>
+    <author>NetworkManager developers</author>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>nm-online</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>nm-online</refname>
+    <refpurpose>ask NetworkManager whether the network is connected</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>nm-online</command>
+      <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'><title>Description</title>
+    <para><command>nm-online</command> is a utility to find out whether we are
+    online. It is done by asking NetworkManager about its status. When run,
+    <command>nm-online</command> waits until NetworkManager reports an active
+    connection, or specified timeout expires. On exit, the returned status code
+    should be checked (see the return codes below).</para>
+
+    <para>By default NetworkManager waits for IPv4 dynamic addressing to complete
+    but does not wait for the <literal>auto</literal> IPv6 dynamic addressing. To
+    wait for IPv6 addressing to complete, either (1) change the network
+    connection's IPv6 <literal>may-fail</literal> setting to <literal>no</literal>,
+    and/or (2) change the IPv6 addressing method to <literal>manual</literal> or
+    <literal>dhcp</literal>, to indicate that IPv6 connectivity is expected.</para>
+  </refsect1>
+
+  <refsect1 id='options'><title>Options</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <group choice='plain'>
+            <arg choice='plain'><option>-t</option></arg>
+            <arg choice='plain'><option>--timeout</option></arg>
+          </group>
+          <arg choice='plain'><replaceable>seconds</replaceable></arg>
+        </term>
+
+        <listitem>
+          <para>Time to wait for a connection, in seconds. If the option is not provided,
+          the default timeout is 30 seconds.</para>
+        </listitem>
+      </varlistentry>
+
+
+      <varlistentry>
+        <term><group choice='plain'>
+          <arg choice='plain'><option>-x</option></arg>
+          <arg choice='plain'><option>--exit</option></arg>
+        </group></term>
+
+        <listitem>
+          <para>Exit immediately if NetworkManager is not running or connecting.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><group choice='plain'>
+          <arg choice='plain'><option>-q</option></arg>
+          <arg choice='plain'><option>--quiet</option></arg>
+        </group></term>
+
+        <listitem>
+          <para>Don't print anything.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><group choice='plain'>
+          <arg choice='plain'><option>-s</option></arg>
+          <arg choice='plain'><option>--wait-for-startup</option></arg>
+        </group></term>
+
+        <listitem>
+          <para>Wait for NetworkManager startup to complete, rather than waiting for
+          network connectivity specifically. Startup is considered complete once
+          NetworkManager has activated (or attempted to activate) every auto-activate
+          connection which is available given the current network state. (This is
+          generally only useful at boot time; after startup has completed,
+          <command>nm-online -s</command> will just return immediately, regardless of the
+          current network state.)</para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='exit_status'><title>Exit Status</title>
+
+    <para><command>nm-online</command> exits with status 0 if it succeeds, a value
+    greater than 0 is returned if an error occurs.</para>
+
+    <variablelist spacing='compact' termlength='3'>
+      <varlistentry>
+        <term><errorcode>0</errorcode></term>
+        <listitem>
+          <para>Success &ndash; already online or connection established within given timeout.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><errorcode>1</errorcode></term>
+        <listitem>
+          <para>Offline or not online within given timeout.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><errorcode>2</errorcode></term>
+        <listitem>
+          <para>Unknown or unspecified error.</para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='see_also'><title>See Also</title>
+    <para><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+  </refsect1>
+
+</refentry>