man: add color documentation

Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>

diff --git a/Makefile.am b/Makefile.am
index 2bbc537861ba468124e523fb7e785d4dc3c0ffa0..8b869a80f4f1adcea7ebf7c1e33b0ba4880b6bf5 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -332,6 +332,7 @@ INSTALL_DIRS += \
 MANPAGES = \
        man/firewall-settings.8 \
        man/network.8 \
 MANPAGES = \
        man/firewall-settings.8 \
        man/network.8 \

+       man/network-color.8 \

        man/network-device.8 \
        man/network-dhcp.8 \
        man/network-dns-server.8 \
        man/network-device.8 \
        man/network-dhcp.8 \
        man/network-dns-server.8 \

diff --git a/man/network-color.xml b/man/network-color.xml
new file mode 100644 (file)
index 0000000..d8fce73
--- /dev/null
+++ b/man/network-color.xml
@@ -0,0 +1,91 @@
+<?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-color</refentrytitle>
+               <manvolnum>8</manvolnum>
+       </refmeta>
+
+       <refnamediv>
+               <refname>network-color</refname>
+               <refpurpose>Network Configuration Control Program</refpurpose>
+       </refnamediv>
+
+       <refsect1>
+               <title>Description</title>
+
+               <para>
+                       The <command>color</command> helps to manage colors for zone and ports.
+                       The color is shown in the webinterface and on the status page of  a port or zone.
+                       and make it much easier to identify a port or a zone.
+               </para>
+       </refsect1>
+
+       <refsect1>
+               <title>Commands</title>
+
+               <para>
+                       The following commands are understood:
+               </para>
+
+               <variablelist>
+                       <varlistentry>
+                               <term>
+                                       <command>set <replaceable>hex-color-value</replaceable></command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               The color of a zone or port are set with the <command>set</command> command.
+                                               It is always required to pass a valid color hex value like 880400.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+                       <varlistentry>
+                               <term>
+                                       <command>reset</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               This reset the color of a zone or port to white.
+                                       </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 181bd8c69cacb72fef4d5ff70119be87188e78ae..92d35d8ba3c5c37199785f3a13ce73069f903454 100644 (file)
--- a/man/network-port.xml
+++ b/man/network-port.xml
@@ -147,6 +147,23 @@
                                        </para>
                                </listitem>
                        </varlistentry>
                                        </para>
                                </listitem>
                        </varlistentry>

+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>PORT</replaceable> color</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               With this command you can set a color for a port.
+                                               See
+                                               <citerefentry>
+                                               <refentrytitle>network-color</refentrytitle>
+                                               <manvolnum>8</manvolnum>,
+                                               </citerefentry>
+                                               for more information.
+                                       </para>
+                               </listitem>
+                       </varlistentry>

 
                        <varlistentry>
                                <term>
 
                        <varlistentry>
                                <term>

diff --git a/man/network-zone.xml b/man/network-zone.xml
index cd7017a33e452dd653cebc7e3bd0f43bc6d1df9f..817ad26efb2d0c56bd3bf9f7ad5059aaff26cb20 100644 (file)
--- a/man/network-zone.xml
+++ b/man/network-zone.xml
@@ -164,7 +164,23 @@
                                        </para>
                                </listitem>
                        </varlistentry>
                                        </para>
                                </listitem>
                        </varlistentry>

+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable> color</command>
+                               </term>

 
 

+                               <listitem>
+                                       <para>
+                                               This command make is possible to set a color for a zone.
+                                               See
+                                               <citerefentry>
+                                               <refentrytitle>network-color</refentrytitle>
+                                               <manvolnum>8</manvolnum>,
+                                               </citerefentry>
+                                               for more information.
+                                       </para>
+                               </listitem>
+                       </varlistentry>

                        <varlistentry>
                                <term>
                                        <command><replaceable>ZONE</replaceable> identify</command>
                        <varlistentry>
                                <term>
                                        <command><replaceable>ZONE</replaceable> identify</command>