Signed-off-by: Jonatan Schlag jonatan.schlag@ipfire.org --- Makefile.am | 1 + man/network-description.xml | 92 +++++++++++++++++++++++++++++++++++++++++++++ man/network-port.xml | 16 ++++++++ man/network-zone.xml | 17 +++++++++ 4 files changed, 126 insertions(+) create mode 100644 man/network-description.xml

diff --git a/Makefile.am b/Makefile.am index 08050d9..9124288 100644 --- a/Makefile.am +++ b/Makefile.am @@ -334,6 +334,7 @@ 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/network-description.xml b/man/network-description.xml new file mode 100644 index 0000000..f1722b4 --- /dev/null +++ b/man/network-description.xml @@ -0,0 +1,92 @@ +<?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> diff --git a/man/network-port.xml b/man/network-port.xml index 92d35d8..4cbf6ca 100644 --- a/man/network-port.xml +++ b/man/network-port.xml @@ -164,7 +164,23 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term> + <command><replaceable>PORT</replaceable>description</command> + </term>

+ <listitem> + <para> + This command allows you to add a description to a port. + See + <citerefentry> + <refentrytitle>network-description</refentrytitle> + <manvolnum>8</manvolnum>, + </citerefentry> + for more information. + </para> + </listitem> + </varlistentry> <varlistentry> <term> <command><replaceable>PORT</replaceable> edit <arg choice="opt" rep="repeat">ARGUMENTS</arg></command> diff --git a/man/network-zone.xml b/man/network-zone.xml index 817ad26..2a86a45 100644 --- a/man/network-zone.xml +++ b/man/network-zone.xml @@ -183,6 +183,23 @@ </varlistentry> <varlistentry> <term> + <command><replaceable>ZONE</replaceable>description</command> + </term> + + <listitem> + <para> + This command make is possible to add a description to a zone. + See + <citerefentry> + <refentrytitle>network-description</refentrytitle> + <manvolnum>8</manvolnum>, + </citerefentry> + for more information. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <command><replaceable>ZONE</replaceable> identify</command> </term>