]> git.ipfire.org Git - people/ms/network.git/blame - man/network-color.xml
settings: Some code refactoring
[people/ms/network.git] / man / network-color.xml
CommitLineData
89c81bcf
JS
1<?xml version="1.0"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5<refentry id="network-color">
6 <refentryinfo>
7 <title>networ-color</title>
8 <productname>network</productname>
9
10 <authorgroup>
11 <author>
12 <contrib>Developer</contrib>
13 <firstname>Jonatan</firstname>
14 <surname>Schlag</surname>
15 <email>jonatan.schlag@ipfire.org</email>
16 </author>
17 </authorgroup>
18 </refentryinfo>
19
20 <refmeta>
21 <refentrytitle>network-color</refentrytitle>
22 <manvolnum>8</manvolnum>
23 </refmeta>
24
25 <refnamediv>
26 <refname>network-color</refname>
27 <refpurpose>Network Configuration Control Program</refpurpose>
28 </refnamediv>
29
30 <refsect1>
31 <title>Description</title>
32
33 <para>
34 The <command>color</command> helps to manage colors for zone and ports.
c4c9a7c1
MT
35 The color is used to make identification of a zone or port easier on the
36 command line or web user interface.
89c81bcf
JS
37 </para>
38 </refsect1>
39
40 <refsect1>
41 <title>Commands</title>
42
43 <para>
44 The following commands are understood:
45 </para>
46
47 <variablelist>
48 <varlistentry>
49 <term>
c4c9a7c1 50 <command>set <replaceable>00AABB</replaceable></command>
89c81bcf
JS
51 </term>
52
53 <listitem>
54 <para>
c4c9a7c1
MT
55 The color of a zone or port is set with the <command>set</command> command.
56 It is always required to pass a valid color hex value (e.g. 880400).
89c81bcf
JS
57 </para>
58 </listitem>
59 </varlistentry>
60 <varlistentry>
61 <term>
62 <command>reset</command>
63 </term>
64
65 <listitem>
66 <para>
c4c9a7c1 67 This command resets the color of a zone or port to blank.
89c81bcf
JS
68 </para>
69 </listitem>
70 </varlistentry>
71 </variablelist>
72 </refsect1>
73 <refsect1>
74 <title>See Also</title>
75
76 <para>
77 <citerefentry>
78 <refentrytitle>network</refentrytitle>
79 <manvolnum>8</manvolnum>
80 </citerefentry>,
81 <citerefentry>
82 <refentrytitle>network-zone</refentrytitle>
83 <manvolnum>8</manvolnum>
84 </citerefentry>,
85 <citerefentry>
86 <refentrytitle>network-port</refentrytitle>
87 <manvolnum>8</manvolnum>
88 </citerefentry>
89 </para>
90 </refsect1>
91</refentry>