man: Convert network-device(8) to asciidoc
authorMichael Tremer <michael.tremer@ipfire.org>
Sun, 30 Sep 2018 19:40:53 +0000 (21:40 +0200)
committerMichael Tremer <michael.tremer@ipfire.org>
Sun, 31 Mar 2019 12:47:04 +0000 (14:47 +0200)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
man/network-device.txt [new file with mode: 0644]
man/network-device.xml [deleted file]

diff --git a/man/network-device.txt b/man/network-device.txt
new file mode 100644 (file)
index 0000000..33fcefa
--- /dev/null
@@ -0,0 +1,61 @@
+network(8)
+==========
+
+NAME
+----
+network-device - Controls network devices
+
+SYNOPSIS
+--------
+[verse]
+'network device' [<options>] <command> ...
+
+DESCRIPTION
+-----------
+The 'network device' command shows low-level status information
+of network devices and other things.
+
+COMMANDS
+--------
+The following commands are understood:
+
+'list'::
+       This command shows a list of all device that are currently present
+       on this system. This includes PHYs and serial devices as well.
+
+'DEVICE discover'::
+       Runs a discovery for many hooks on the given device.
+
+       This will check if the hook can find for example a DHCP server or
+       DSLAM and thus predict for what the device should be used.
+
+'DEVICE identify'::
+       This command only works for Ethernet adapters and will make those
+       that support this feature flash for a few seconds.
+
+       It is handy to find the right device to put the cable in.
+
+'DEVICE monitor'::
+       This command creates a monitor interface for wireless modules.
+
+       An instance of link:tcpdump[8] will be started and show all
+       frames that are sent or received on the 802.11 layer (layer 2).
+
+'DEVICE status'::
+       This will show you very detailed information about the given device.
+
+'DEVICE unlock'::
+       This command will unlock the SIM card in a modem.
+       Only serial devices are supported which are the most 4G or 3G modems.
+
+       For the PIN or PUK code, the user will be prompted.
+
+AUTHORS
+-------
+Michael Tremer
+
+SEE ALSO
+--------
+link:network[8]
+link:network-port[8]
+link:network-zone[8]
diff --git a/man/network-device.xml b/man/network-device.xml
deleted file mode 100644 (file)
index 11dc04e..0000000
+++ /dev/null
@@ -1,165 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
-       "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<refentry id="network-device">
-       <refentryinfo>
-               <title>network-device</title>
-               <productname>network</productname>
-
-               <authorgroup>
-                       <author>
-                               <contrib>Developer</contrib>
-                               <firstname>Michael</firstname>
-                               <surname>Tremer</surname>
-                               <email>michael.tremer@ipfire.org</email>
-                       </author>
-               </authorgroup>
-       </refentryinfo>
-
-       <refmeta>
-               <refentrytitle>network-device</refentrytitle>
-               <manvolnum>8</manvolnum>
-       </refmeta>
-
-       <refnamediv>
-               <refname>network-device</refname>
-               <refpurpose>Network Configuration Control Program</refpurpose>
-       </refnamediv>
-
-       <refsynopsisdiv>
-               <cmdsynopsis>
-                       <command>network device <arg choice="plain">COMMAND</arg></command>
-               </cmdsynopsis>
-       </refsynopsisdiv>
-
-       <refsect1>
-               <title>Description</title>
-
-               <para>
-                       With help of the <command>device</command> subcommands, it is very easy
-                       to get status information about network devices and to do some more
-                       things.
-               </para>
-       </refsect1>
-
-       <refsect1>
-               <title>Commands</title>
-
-               <para>
-                       The following commands are understood:
-               </para>
-
-               <variablelist>
-                       <varlistentry>
-                               <term>
-                                       <command>list</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               The <command>list</command> command will show a list
-                                               of all devices that are currently plugged in or active
-                                               on the system.
-                                               This includes PHYs and serial devices as well.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command><replaceable>DEVICE</replaceable> status</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               This will show you very detailed information about the given
-                                               device.
-                                       </para>
-                                       <para>
-                                               This is all about the ethernet parts of the device and
-                                               does not contain any IP information as this is defined
-                                               as a zone (<citerefentry>
-                                                       <refentrytitle>network-zone</refentrytitle>
-                                                       <manvolnum>8</manvolnum>
-                                               </citerefentry>).
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command><replaceable>DEVICE</replaceable> identify</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               This command only works for Ethernet adapters and will
-                                               make those that support this feature flash for a few
-                                               seconds.
-                                               It is handy to find the right device to put the cable in.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command><replaceable>DEVICE</replaceable> discover</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Runs a discovery for many hooks on the given device.
-                                               This will check if the hook can find for example a DHCP
-                                               server or DSLAM and thus predict for what the device
-                                               should be used.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command><replaceable>DEVICE</replaceable> unlock</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               This command will unlock the SIM card in a modem.
-                                               Only serial devices are supported which are the most
-                                               UMTS or 3G modems.
-                                       </para>
-                                       <para>
-                                               For the PIN or PUK code, the user will be prompted.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command><replaceable>DEVICE</replaceable> monitor</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               The <command>monitor</command> command is used to
-                                               create a monitor interface for wireless modules.
-                                               An instance of tcpdump will be started and show
-                                               all frames that are sent or received on the 802.11
-                                               layer (layer 2) of the wireless network.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-               </variablelist>
-       </refsect1>
-
-       <refsect1>
-               <title>See Also</title>
-
-               <para>
-                       <citerefentry>
-                               <refentrytitle>network</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>
-               </para>
-       </refsect1>
-</refentry>