Signed-off-by: Jonatan Schlag --- 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 @@ + + + + + + networ-color + network + + + + Developer + Jonatan + Schlag + jonatan.schlag(a)ipfire.org + + + + + + network-description + 8 + + + + network-description + Network Configuration Control Program + + + + Description + + + The description 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 show command + + + + + Commands + + + The following commands are understood: + + + + + + edit + + + + + This command opens an editor and allows you to edit title and description. + + + + + + show + + + + + This command prints title and the longer description in a nice way. + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + , + + network-port + 8 + + + + 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 @@ + + + PORTdescription + + + + This command allows you to add a description to a port. + See + + network-description + 8, + + for more information. + + + PORT edit ARGUMENTS 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 @@ + ZONEdescription + + + + + This command make is possible to add a description to a zone. + See + + network-description + 8, + + for more information. + + + + + ZONE identify -- 2.6.3