projects / people / ms / network.git / blame
| Commit | Line | Data |
|---|---|---|
| 6135a5b3 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-description</refentrytitle> | |
| 22 | <manvolnum>8</manvolnum> | |
| 23 | </refmeta> | |
| 24 | ||
| 25 | <refnamediv> | |
| 26 | <refname>network-description</refname> | |
| 27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
| 28 | </refnamediv> | |
| 29 | ||
| 30 | <refsect1> | |
| 31 | <title>Description</title> | |
| 32 | ||
| 33 | <para> | |
| 34 | The <command>description</command> command make it possible to add descriptions to zone and ports. | |
| 35 | A description is similar to a git commit. Every description has a title, the first line of the describtion file. | |
| 36 | The title is shown on the status page and in the webinterface. It should be something short like Office Lan or DMZ. | |
| 37 | After the title can follow a longer description. You can write whatever you want. | |
| 38 | This longer description is shown via the <command>show</command> command | |
| 39 | </para> | |
| 40 | </refsect1> | |
| 41 | ||
| 42 | <refsect1> | |
| 43 | <title>Commands</title> | |
| 44 | ||
| 45 | <para> | |
| 46 | The following commands are understood: | |
| 47 | </para> | |
| 48 | ||
| 49 | <variablelist> | |
| 50 | <varlistentry> | |
| 51 | <term> | |
| 52 | <command>edit</command> | |
| 53 | </term> | |
| 54 | ||
| 55 | <listitem> | |
| 56 | <para> | |
| 57 | This command opens an editor and allows you to edit title and description. | |
| 58 | </para> | |
| 59 | </listitem> | |
| 60 | </varlistentry> | |
| 61 | <varlistentry> | |
| 62 | <term> | |
| 63 | <command>show</command> | |
| 64 | </term> | |
| 65 | ||
| 66 | <listitem> | |
| 67 | <para> | |
| 68 | This command prints title and the longer description in a nice way. | |
| 69 | </para> | |
| 70 | </listitem> | |
| 71 | </varlistentry> | |
| 72 | </variablelist> | |
| 73 | </refsect1> | |
| 74 | <refsect1> | |
| 75 | <title>See Also</title> | |
| 76 | ||
| 77 | <para> | |
| 78 | <citerefentry> | |
| 79 | <refentrytitle>network</refentrytitle> | |
| 80 | <manvolnum>8</manvolnum> | |
| 81 | </citerefentry>, | |
| 82 | <citerefentry> | |
| 83 | <refentrytitle>network-zone</refentrytitle> | |
| 84 | <manvolnum>8</manvolnum> | |
| 85 | </citerefentry>, | |
| 86 | <citerefentry> | |
| 87 | <refentrytitle>network-port</refentrytitle> | |
| 88 | <manvolnum>8</manvolnum> | |
| 89 | </citerefentry> | |
| 90 | </para> | |
| 91 | </refsect1> | |
| 92 | </refentry> |