public inbox for network@lists.ipfire.org
 help / color / mirror / Atom feed
* [PATCH 1/2] man: add color documentation
@ 2017-07-10 15:10 Jonatan Schlag
  2017-07-10 15:10 ` [PATCH 2/2] man: add documentation for the description command Jonatan Schlag
  0 siblings, 1 reply; 2+ messages in thread
From: Jonatan Schlag @ 2017-07-10 15:10 UTC (permalink / raw)
  To: network

[-- Attachment #1: Type: text/plain, Size: 4585 bytes --]

Signed-off-by: Jonatan Schlag <jonatan.schlag(a)ipfire.org>
---
 Makefile.am           |  1 +
 man/network-color.xml | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++
 man/network-port.xml  | 17 ++++++++++
 man/network-zone.xml  | 16 +++++++++
 4 files changed, 125 insertions(+)
 create mode 100644 man/network-color.xml

diff --git a/Makefile.am b/Makefile.am
index 32e7166..08050d9 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -333,6 +333,7 @@ INSTALL_DIRS += \
 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 \
diff --git a/man/network-color.xml b/man/network-color.xml
new file mode 100644
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(a)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 181bd8c..92d35d8 100644
--- a/man/network-port.xml
+++ b/man/network-port.xml
@@ -147,6 +147,23 @@
 					</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>
diff --git a/man/network-zone.xml b/man/network-zone.xml
index cd7017a..817ad26 100644
--- a/man/network-zone.xml
+++ b/man/network-zone.xml
@@ -164,7 +164,23 @@
 					</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>
-- 
2.6.3


^ permalink raw reply	[flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-07-10 15:10 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-07-10 15:10 [PATCH 1/2] man: add color documentation Jonatan Schlag
2017-07-10 15:10 ` [PATCH 2/2] man: add documentation for the description command Jonatan Schlag

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox