man: Convert network-description(8) to asciidoc
authorMichael Tremer <michael.tremer@ipfire.org>
Sun, 30 Sep 2018 19:24:48 +0000 (21:24 +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>
Makefile.am
man/include-description.txt [new file with mode: 0644]
man/network-description.xml [deleted file]

index 55d5d18..287a111 100644 (file)
@@ -456,7 +456,6 @@ MANPAGES = \
        man/firewall-settings.8 \
        man/network.8 \
        man/network-color.8 \
-       man/network-description.8 \
        man/network-device.8 \
        man/network-dhcp.8 \
        man/network-dns-server.8 \
diff --git a/man/include-description.txt b/man/include-description.txt
new file mode 100644 (file)
index 0000000..a39ba55
--- /dev/null
@@ -0,0 +1,11 @@
+'description edit'::
+       This command opens an editor and allows you to edit title and description.
+
+       NOTE: The formation of the description is similar to a git commit.
+       Every description has a title, the first line of the description.
+       The title is shown on the status page and in the web user interface.
+       It should be something short like "Office Lan" or "DMZ".
+       After the title can follow a longer description.
+
+'description show'::
+       Prints the description.
diff --git a/man/network-description.xml b/man/network-description.xml
deleted file mode 100644 (file)
index f1722b4..0000000
+++ /dev/null
@@ -1,92 +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-color">
-       <refentryinfo>
-               <title>networ-color</title>
-               <productname>network</productname>
-
-               <authorgroup>
-                       <author>
-                               <contrib>Developer</contrib>
-                               <firstname>Jonatan</firstname>
-                               <surname>Schlag</surname>
-                               <email>jonatan.schlag@ipfire.org</email>
-                       </author>
-               </authorgroup>
-       </refentryinfo>
-
-       <refmeta>
-               <refentrytitle>network-description</refentrytitle>
-               <manvolnum>8</manvolnum>
-       </refmeta>
-
-       <refnamediv>
-               <refname>network-description</refname>
-               <refpurpose>Network Configuration Control Program</refpurpose>
-       </refnamediv>
-
-       <refsect1>
-               <title>Description</title>
-
-               <para>
-                       The <command>description</command> command make it possible to add descriptions to zone and ports.
-                       A description is similar to a git commit. Every description has a title, the first line of the describtion file.
-                       The title is shown on the status page and in the webinterface. It should be something short like Office Lan or DMZ.
-                       After the title can follow a longer description. You can write whatever you want.
-                       This longer description is shown via the <command>show</command> command
-               </para>
-       </refsect1>
-
-       <refsect1>
-               <title>Commands</title>
-
-               <para>
-                       The following commands are understood:
-               </para>
-
-               <variablelist>
-                       <varlistentry>
-                               <term>
-                                       <command>edit</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                       This command opens an editor and allows you to edit title and description.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-                       <varlistentry>
-                               <term>
-                                       <command>show</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               This command prints title and the longer description in a nice way.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-       </variablelist>
-       </refsect1>
-       <refsect1>
-               <title>See Also</title>
-
-               <para>
-                       <citerefentry>
-                               <refentrytitle>network</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>,
-                       <citerefentry>
-                               <refentrytitle>network-zone</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>,
-                       <citerefentry>
-                               <refentrytitle>network-port</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>
-               </para>
-       </refsect1>
-</refentry>