From: Michael Tremer <michael.tremer@ipfire.org>
Date: Sun, 30 Sep 2018 19:24:48 +0000 (+0200)
Subject: man: Convert network-description(8) to asciidoc
X-Git-Url: http://git.ipfire.org/?p=people%2Fms%2Fnetwork.git;a=commitdiff_plain;h=c601b69e5d8db595fee00241702ee8bd2689c49e

man: Convert network-description(8) to asciidoc

Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
---

diff --git a/Makefile.am b/Makefile.am
index 55d5d188..287a1117 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -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
index 00000000..a39ba55c
--- /dev/null
+++ b/man/include-description.txt
@@ -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
index f1722b44..00000000
--- a/man/network-description.xml
+++ /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>