From a2a6f75985e929b04fef16a77a6a83ec96df5d7a Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Wed, 13 Mar 2013 00:57:02 +0100 Subject: [PATCH] Convert man pages to docbook. --- .gitignore | 3 +- Makefile | 59 +++- man/Makefile | 54 ---- man/custom-html.xsl | 31 +++ man/network-config.8.in | 43 --- man/network-config.xml | 123 ++++++++ man/network-device.8.in | 46 --- man/network-device.xml | 119 ++++++++ man/network-dns-server.8.in | 74 ----- man/network-dns-server.xml | 190 +++++++++++++ man/network-port-batman-adv-port.8.in | 62 ----- man/network-port-batman-adv-port.xml | 151 ++++++++++ man/network-port-batman-adv.8.in | 50 ---- man/network-port-batman-adv.xml | 131 +++++++++ man/network-route.8.in | 92 ------ man/network-route.xml | 179 ++++++++++++ man/network-zone-bridge.8.in | 88 ------ man/network-zone-bridge.xml | 200 ++++++++++++++ man/network-zone-config-pppoe-server.8.in | 64 ----- man/network-zone-config-pppoe-server.xml | 143 ++++++++++ man/network-zone-pppoe.8.in | 79 ------ man/network-zone-pppoe.xml | 179 ++++++++++++ man/network-zone.8.in | 80 ------ man/network-zone.xml | 182 ++++++++++++ man/network.8.in | 136 --------- man/network.xml | 323 ++++++++++++++++++++++ 26 files changed, 2007 insertions(+), 874 deletions(-) delete mode 100644 man/Makefile create mode 100644 man/custom-html.xsl delete mode 100644 man/network-config.8.in create mode 100644 man/network-config.xml delete mode 100644 man/network-device.8.in create mode 100644 man/network-device.xml delete mode 100644 man/network-dns-server.8.in create mode 100644 man/network-dns-server.xml delete mode 100644 man/network-port-batman-adv-port.8.in create mode 100644 man/network-port-batman-adv-port.xml delete mode 100644 man/network-port-batman-adv.8.in create mode 100644 man/network-port-batman-adv.xml delete mode 100644 man/network-route.8.in create mode 100644 man/network-route.xml delete mode 100644 man/network-zone-bridge.8.in create mode 100644 man/network-zone-bridge.xml delete mode 100644 man/network-zone-config-pppoe-server.8.in create mode 100644 man/network-zone-config-pppoe-server.xml delete mode 100644 man/network-zone-pppoe.8.in create mode 100644 man/network-zone-pppoe.xml delete mode 100644 man/network-zone.8.in create mode 100644 man/network-zone.xml delete mode 100644 man/network.8.in create mode 100644 man/network.xml diff --git a/.gitignore b/.gitignore index 651ce32a..be8badaf 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -man/*.8 +man/*.[0-9] +man/*.html diff --git a/Makefile b/Makefile index f110cd44..d54d65f7 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,3 @@ - include Makeconfig DESTDIR= @@ -16,9 +15,55 @@ tmpfilesdir=$(prefix)/lib/tmpfiles.d # File to store the version number in. VERSION_FILE = $(DESTDIR)$(libdir)/network/version +# A list of files which should be removed on "make clean" +CLEANFILES = + +# man pages +MAN_PAGES = \ + man/network.8 \ + man/network-config.8 \ + man/network-device.8 \ + man/network-dns-server.8 \ + man/network-port-batman-adv.8 \ + man/network-port-batman-adv-port.8 \ + man/network-route.8 \ + man/network-zone.8 \ + man/network-zone-bridge.8 \ + man/network-zone-config-pppoe-server.8 \ + man/network-zone-pppoe.8 + +MAN_PAGES_HTML = $(patsubst %.xml,%.html,$(MAN_PAGES_XML)) +MAN_PAGES_XML = $(patsubst %.8,%.xml,$(MAN_PAGES)) + +CLEANFILES += \ + $(MAN_PAGES) \ + $(MAN_PAGES_HTML) + +XSLTPROC = xsltproc + +XSLTPROC_FLAGS = \ + --nonet \ + --stringparam man.output.quietly 1 \ + --stringparam funcsynopsis.style ansi \ + --stringparam man.th.extra1.suppress 1 \ + --stringparam man.authors.section.enabled 1 \ + --stringparam man.copyright.section.enabled 1 + +XSLTPROC_COMMAND_MAN = \ + $(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) \ + http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +XSLTPROC_COMMAND_HTML = \ + $(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) man/custom-html.xsl $< + +man/%.8: man/%.xml + $(XSLTPROC_COMMAND_MAN) + +man/%.html: man/%.xml man/custom-html.xsl + $(XSLTPROC_COMMAND_HTML) + .PHONY: all -all: - make -C man all +all: $(MAN_PAGES) .PHONY: install install: @@ -72,9 +117,13 @@ install: echo "# This file is automatically generated." >> $(VERSION_FILE) echo "NETWORK_VERSION=$(PACKAGE_VERSION)" >> $(VERSION_FILE) - # Descend into subdirectories. - make -C man install +.PHONY: clean +clean: + rm -f $(CLEANFILES) dist: git archive --format tar --prefix $(PACKAGE_NAME)-$(PACKAGE_VERSION)/ HEAD | gzip -9 > \ $(PACKAGE_NAME)-$(PACKAGE_VERSION).tar.gz + +.PHONY: export-html-docs +export-html-docs: $(MAN_PAGES_HTML) diff --git a/man/Makefile b/man/Makefile deleted file mode 100644 index 537c29b3..00000000 --- a/man/Makefile +++ /dev/null @@ -1,54 +0,0 @@ -############################################################################### -# # -# IPFire.org - A linux based firewall # -# Copyright (C) 2012 IPFire Network Development Team # -# # -# This program is free software: you can redistribute it and/or modify # -# it under the terms of the GNU General Public License as published by # -# the Free Software Foundation, either version 3 of the License, or # -# (at your option) any later version. # -# # -# This program is distributed in the hope that it will be useful, # -# but WITHOUT ANY WARRANTY; without even the implied warranty of # -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # -# GNU General Public License for more details. # -# # -# You should have received a copy of the GNU General Public License # -# along with this program. If not, see . # -# # -############################################################################### - -include ../Makeconfig - -mandir = /usr/share/man - -MANPAGES = $(MANPAGES8) -MANPAGES_IN = $(foreach file,$(MANPAGES),$(file).in) - -MANPAGES8 = \ - network.8 \ - network-config.8 \ - network-device.8 \ - network-dns-server.8 \ - network-port-batman-adv.8 \ - network-port-batman-adv-port.8 \ - network-route.8 \ - network-zone.8 \ - network-zone-bridge.8 \ - network-zone-config-pppoe-server.8 \ - network-zone-pppoe.8 - -.PHONY: all -all: $(MANPAGES) - @: # Do nothing. - -# Replace all placeholders. -$(MANPAGES): ../Makeconfig Makefile $(MANPAGES_IN) - sed \ - -e "s/@VERSION@/$(PACKAGE_VERSION)/g" \ - < $@.in > $@ - -.PHONY: install -install: $(MANPAGES) - -mkdir -pv $(DESTDIR)$(mandir)/man8 - cp -vf *.8 $(DESTDIR)$(mandir)/man8 diff --git a/man/custom-html.xsl b/man/custom-html.xsl new file mode 100644 index 00000000..fe2b54e1 --- /dev/null +++ b/man/custom-html.xsl @@ -0,0 +1,31 @@ + + + + + + + + + + + .html + + + + + + + + + + index.html + + Index + +
+ + + + + + diff --git a/man/network-config.8.in b/man/network-config.8.in deleted file mode 100644 index 235a573c..00000000 --- a/man/network-config.8.in +++ /dev/null @@ -1,43 +0,0 @@ -.TH network-config 8 "1 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-config \- A list of global configuration options. - -.SH SYNOPSIS -\fBnetwork [OPTIONS] config\fR \- Will return a list of all possible keys and their current values. -.P -\fBnetwork [OPTIONS] config [KEY=VALUE ...]\fR \- Will set the variable \fBKEY\fR to \fBVALUE\fR. - -.SH DESCRIPTION -The \fBnetwork config\fR command may be used to set global configuration options permanently. -.PP -Please also have look at the individual man pages for more options. - -.SH OPTIONS -This is a list of possible configuration values: - -\fBCOLORS\fR = [\fBauto\fR|on|off] -.RS 4 -This will control the output of the console tools. \fBon\fR will enable colorful output -all the time, \fBoff\fR will disable colors. -.PP -The default setting is \fBauto\fR which will automatically detect if the console supports -colors. -.PP -Colorful output is very helpful to spot important information faster. -.RE -.PP - -\fBDEBUG\fR = [\fB0\fR|1] -.RS 4 -The \fBDEBUG\fR will control weather debug logging is enabled or not. Additionally -to writing debug log messages to the log files, the messages will displayed on the -console. -.RE -.PP - -.SH SEE ALSO -network(8), network-dns-server(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-config.xml b/man/network-config.xml new file mode 100644 index 00000000..6a550a9b --- /dev/null +++ b/man/network-config.xml @@ -0,0 +1,123 @@ + + + + + + network-config + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-config + 8 + + + + network-config + Network Configuration Control Program + + + + + network config + + + + network config KEY=VALUE + + + + + Description + + + The network config command may be used to set + global configuration options. + + + Please have a look at the individual man pages for more options. + + + + + Commands + + + If no additional argument is given, running the command will + dump a list of all configuration variables and their current values. + + + + You may set a new value by adding the variable name and the new + value to the command line. + + + + + Variables + + + + + COLORS=[auto|on|off] + + + + + This will control the output of the console tools. + on will enable colorful output all + the time, off will disable colors. + + + The default setting is auto which will + automatically detect if the console supports colors. + + + Colorful output is very helpful to spot important information + more quickly. + + + + + + + DEBUG=[0|1] + + + + + The DEBUG will control whether debug + logging is enabled or not. Additionally to writing debug + log messages to the log files, the messages will be displayed + on the console as well. + + + + + + + + See Also + + + + network + 8 + , + + network-dns-server + 8 + + + + diff --git a/man/network-device.8.in b/man/network-device.8.in deleted file mode 100644 index 3e007562..00000000 --- a/man/network-device.8.in +++ /dev/null @@ -1,46 +0,0 @@ -.TH network-device 8 "6 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-device \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] device [status|discover|unlock] ...\fR - -.SH DESCRIPTION -By the device subcommands, it is very easy to get status information -about network devices and do some more things. - -.SH OPTIONS -The \fBnetwork device\fR command offers various commands: - -\fB status\fR -.RS 4 -This will show you very detailed information about the given device. -.PP -This is all about the ethernet parts of the device and does not contain -any IP information as this is defined as a zone (\fBnetwork-zone\fR(8)). -.RE -.PP - -\fB discover\fR -.RS 4 -Runs a discovery for many hooks on the given device. This will check -if the hook can find for example a DHCP server or DSLAM and thus predict -for what the device should be used. -.RE -.PP - -\fB unlock\fR -.RS 4 -This command will unlock the SIM card in a modem. Only serial devices -are supported which are the most UMTS or 3G modems. -.PP -For the PIN or PUK code, the user will be prompted. -.RE -.PP - -.SH SEE ALSO -network(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-device.xml b/man/network-device.xml new file mode 100644 index 00000000..f2e953d9 --- /dev/null +++ b/man/network-device.xml @@ -0,0 +1,119 @@ + + + + + + network-device + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-device + 8 + + + + network-device + Network Configuration Control Program + + + + + network device COMMAND + + + + + Description + + + With help of the device subcommands, it is very easy + to get status information about network devices and to do some more + things. + + + + + Commands + + + The following commands are understood: + + + + + + DEVICE status + + + + + This will show you very detailed information about the given + device. + + + This is all about the ethernet parts of the device and + does not contain any IP information as this is defined + as a zone ( + network-zone + 8 + ). + + + + + + + DEVICE discover + + + + + Runs a discovery for many hooks on the given device. + This will check if the hook can find for example a DHCP + server or DSLAM and thus predict for what the device + should be used. + + + + + + + DEVICE unlock + + + + + This command will unlock the SIM card in a modem. + Only serial devices are supported which are the most + UMTS or 3G modems. + + + For the PIN or PUK code, the user will be prompted. + + + + + + + + See Also + + + + network + 8 + + + + diff --git a/man/network-dns-server.8.in b/man/network-dns-server.8.in deleted file mode 100644 index 5b2066f7..00000000 --- a/man/network-dns-server.8.in +++ /dev/null @@ -1,74 +0,0 @@ -.TH network-dns-server 8 "22 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-dns-server \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] dns-server [add|remove] []\fR -.P -\fBnetwork [OPTIONS] dns-server list\fR -.P -\fBnetwork [OPTIONS] dns-server update\fR - -.SH DESCRIPTION -With help of the \fBdns-server\fR subcommand, you will be able to configure the -local DNS configuration. DNS is short for \fBDomain Name System\fR. -.PP -You may add and remove DNS servers as well as view the settings. - -.SH OPTIONS -The \fBnetwork dns-server\fR command offers various commands: - -\fBadd []\fR -.RS 4 -A new DNS server may be added to the list by the \fBadd\fR command. A priority that -will rank the server may optionally be given. -.PP -\fB\fR must be a valid IP address and \fB\fR must be an integer. -The smaller the number, the higher is the rank of the server. -.RE -.PP - -\fBremove \fR -.RS 4 -A server may be removed by this command where \fB\fR must an IP address. -.RE -.PP - -\fBlist\fR -.RS 4 -Outputs a list of all servers that are currently in use. -.RE -.PP - -\fBupdate\fR -.RS 4 -This command will recreate the system's configuration file. It should not be -required to use this command very often. -.RE -.PP - -.SH CONFIG OPTIONS -These options may be set with the \fBnetwork-config\fR(8) command: - -\fBDNS_USE_LOCAL_RESOLVER\fR = [\fBtrue\fR|false] -.RS 4 -This option defines whether the local DNS resolver should be used or not. -.PP -Basically, the option adds localhost to the list of nameservers in -\fBresolv.conf\fR(5). -.RE -.PP - -\fBDNS_RANDOMIZE\fR = [true|\fBfalse\fR] -.RS 4 -This option will break the DNS server ranks and will query them in a -random order which is useful to load-balance multiple DNS servers. -.RE -.PP - -.SH SEE ALSO -network(8), network-config(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-dns-server.xml b/man/network-dns-server.xml new file mode 100644 index 00000000..a8f8966d --- /dev/null +++ b/man/network-dns-server.xml @@ -0,0 +1,190 @@ + + + + + + network-dns-server + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-dns-server + 8 + + + + network-dns-server + Network Configuration Control Program + + + + + network dns-server [add|remove] SERVER [PRIORITY] + + + + network dns-server [list|update] + + + + + Description + + + With help of the dns-server subcommand, you will + be able to configure the local DNS configuration. + DNS is short for Domain Name System. + + + You may add and remove DNS servers as well as view the settings. + + + + + Commands + + + The following commands are understood: + + + + + + + add + SERVER + [PRIORITY] + + + + + + A new DNS server may be added to the list by the + add command. A priority that will + rank the server my optionally be given. + + + SERVER must be a valid IP address + and PRIORITY must be a positive + integer number. The smaller this number, the higher is + is the rank of the server. + + + + + + + + remove + SERVER + + + + + + The given server will be removed from the list of + DNS servers. + + + + + + + list + + + + + Shows a list of all servers that are currently in use. + + + + + + + update + + + + + This command will re-create the system's configuration + files. It should not be required to use this command + very often. + + + + + + + + Variables + + + These variables may be set by using the + network-config + 8 + command. + + + + + + DNS_USE_LOCAL_RESOLVER=[true|false] + + + + + This option defines whether the local DNS resolver should + be used or not. + + + Basically, the option adds localhost to the list of + nameservers in + resolv.conf + 5 + . + + + + + + + DNS_RANDOMIZE=[true|false] + + + + + This option will break the DNS server ranks and will query + them in a random order which is useful to load-balance + multiple DNS servers. + + + + + + + + See Also + + + + network + 8 + , + + network-config + 8 + + + + diff --git a/man/network-port-batman-adv-port.8.in b/man/network-port-batman-adv-port.8.in deleted file mode 100644 index 97b6c66b..00000000 --- a/man/network-port-batman-adv-port.8.in +++ /dev/null @@ -1,62 +0,0 @@ -.TH network-port-batman-adv-port 8 "11 Mar 2013" "@VERSION@" "network man page" - -.SH NAME -network-port-batman-adv-port \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] port create batman-adv-port ...\fR -.P -Parameters may be edited with the following command: -.P -\fBnetwork [OPTIONS] port edit ...\fR - -.SH DESCRIPTION -This hook configures a wireless device that is then used as a port -in the batman-adv hook. - -.SH OPTIONS -The \fBbatman-adv-port\fR hook offers various configuration options: - -\fB--address\fR = ... -.RS 4 -Define the MAC address of the interface. If no address is defined, -a random one will be generated. -.RE -.PP - -\fB--channel\fR = [0-9]+ -.RS 4 -Set the channel number of the channel that should be used for -the wireless network. -.RE -.PP - -\fB--country-code\fR = ... -.RS 4 -Set the country code for the wireless interface. -.RE -.PP - -\fB--phy\fR = ... -.RS 4 -Use this wireless phy to create the interface. -.RE -.PP - -\fB--ssid\fR = ... -.RS 4 -Define the ESSID of the wireless network. -.RE -.PP - -\fB--mesh-id\fR = ... -.RS 4 -Define the mesh id or BSSID of the wireless network. -.RE -.PP - -.SH SEE ALSO -network(8), network-port-batman-adv(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-port-batman-adv-port.xml b/man/network-port-batman-adv-port.xml new file mode 100644 index 00000000..2113a106 --- /dev/null +++ b/man/network-port-batman-adv-port.xml @@ -0,0 +1,151 @@ + + + + + + network-port-batman-adv-port + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-port-batman-adv-port + 8 + + + + network-port-batman-adv-port + Network Configuration Control Program + + + + + network port create batman-adv-port ... + + + + network PORT edit ... + + + + + Description + + + This hook configures a wireless device that is then used as a port + in the batman-adv hook. + + + + + Options + + + The following options are understood: + + + + + + + + + + + Define the MAC address of the interface. If no address + is defined, a random one will be generated. + + + + + + + + + + + + Set the channel number of the channel that should be used + for the wireless network. + + + + + + + + + + + + Sets the country code for the wireless interface. + + + + + + + + + + + + Use this wireless phy to create the interface. + + + + + + + + + + + + Define the ESSID of the wireless network. + + + + + + + + + + + + Define the mesh id or BSSID of the wireless network. + + + + + + + + See Also + + + + network + 8 + , + + network-port + 8 + , + + network-port-batman-adv + 8 + + + + diff --git a/man/network-port-batman-adv.8.in b/man/network-port-batman-adv.8.in deleted file mode 100644 index 8e2c88a6..00000000 --- a/man/network-port-batman-adv.8.in +++ /dev/null @@ -1,50 +0,0 @@ -.TH network-port-batman-adv 8 "11 Mar 2013" "@VERSION@" "network man page" - -.SH NAME -network-port-batman-adv \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] port create batman-adv ...\fR -.P -Parameters may be edited with the following command: -.P -\fBnetwork [OPTIONS] port edit ...\fR - -.SH DESCRIPTION -The batman-adv hook creates a batman-adv soft interface, which is -used to bridge several hard interfaces (wireless adapters, etc.). - -.SH OPTIONS -The \fBbatman-adv\fR hook offers various configuration options: - -\fB--address\fR = ... -.RS 4 -Define the MAC address of the interface. If no address is defined, -a random one will be generated. -.RE -.PP - -\fB--slaves\fR = ... (only on create) -.RS 4 -Define a list of ports, which should be used as slaves. -All slaves must be \fBbatman-adv-ports\fR ports. -.RE -.PP - -\fB--add-slave\fR = ... (only on edit) -.RS 4 -Adds an additional slave port. -.RE -.PP - -\fB--del-slave\fR = ... (only on edit) -.RS 4 -Removes a slave port. -.RE -.PP - -.SH SEE ALSO -network(8), network-port-batman-adv-port(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-port-batman-adv.xml b/man/network-port-batman-adv.xml new file mode 100644 index 00000000..580b13a4 --- /dev/null +++ b/man/network-port-batman-adv.xml @@ -0,0 +1,131 @@ + + + + + + network-port-batman-adv + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-port-batman-adv + 8 + + + + network-port-batman-adv + Network Configuration Control Program + + + + + network port create batman-adv ... + + + + network PORT edit ... + + + + + Description + + + The batman-adv hook creates a batman-adv soft interface, which is + used to bridge several hard interfaces (wireless adapters, etc.). + + + + + Options + + + The following options are understood: + + + + + + + + + + + Define the MAC address of the interface. If no address + is defined, a random one will be generated. + + + + + + + + (only on create) + + + + + Define a lits of port, which should be used as slaves. + All slaves must be batman-adv-port + ports. + + + + + + + + (only on edit) + + + + + Adds an additional slave port. + + + + + + + + (only on edit) + + + + + Removes a slave port. + + + + + + + + See Also + + + + network + 8 + , + + network-port + 8 + , + + network-port-batman-adv-port + 8 + + + + diff --git a/man/network-route.8.in b/man/network-route.8.in deleted file mode 100644 index de439399..00000000 --- a/man/network-route.8.in +++ /dev/null @@ -1,92 +0,0 @@ -.TH network-route 8 "11 Aug 2012" "@VERSION@" "network man page" - -.SH NAME -network-route \- Network Route Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] route add <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR -.P -\fBnetwork [OPTIONS] route remove \fR -.P -\fBnetwork [OPTIONS] route list\fR - -.SH DESCRIPTION -The route subcommands, help to configure static routes. -.PP -It is possible to create and remove static routes. - -.SH COMMANDS -The \fBnetwork route\fR command offers various sub commands: - -\fBadd <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR -.RS 4 -A new route may be added by the \fBadd\fR command. -It is always required to pass a valid network prefix (\fB\fR), which -can be either IPv6 or IPv4. -.PP -For unicast routes, the \fB--gateway=\fR option must be passed, where -\fB\fR is a valid IP address of the same protocol type as the network -prefix is. -.PP -Use \fB--unreachable\fR, \fB--prohibit\fR, \fB--blackhole\fR can be used to create -of that type. See \fBROUTE TYPES\fR below for more information about these options. -.PP -The optional \fB--mtu\fR parameter defines the MTU along the path to the -destination and must be an integer number. -.RE -.PP - -\fBremove \fR -.RS 4 -A route can be removed with this command. -.PP -\fB\fR is the network prefix of a existing route. -.RE -.PP - -\fBlist [--protocol=ipv6|ipv4]\fR -.RS 4 -Shows a list of all configured routes. -.PP -Pass the protocol option to filter the output only for the given -protocol. -.RE -.PP - -.SH ROUTE TYPES - -\fBunicast\fR -.RS 4 -A unicast route is the most common route in routing tables. It is a route to a destination -network address, which describes the path to the destination. -Use the \fB--gateway=...\fR option to create such a route. -.RE -.PP - -\fBunreachable\fR -.RS 4 -When a route is determined and the routing decision process returns a destination with -an unreachable route type, an ICMP unreachable message is generated and returned to -the source address. -.RE -.PP - -\fBprohibit\fR -.RS 4 -This works like an \fBunreachable\fR route, but the returned ICMP message is an -ICMP prohibited message. -.RE -.PP - -\fBblackhole\fR -.RS 4 -Packets matching this kind of route are silently discarded. There will be no ICMP message -sent to the source and no packet be forwarded. -.RE -.PP - -.SH SEE ALSO -network(8), ip-route(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-route.xml b/man/network-route.xml new file mode 100644 index 00000000..cd49de7f --- /dev/null +++ b/man/network-route.xml @@ -0,0 +1,179 @@ + + + + + + network-route + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-route + 8 + + + + network-route + Network Configuration Control Program + + + + + network route COMMAND + + + + + Description + + + The route helps to manage static routes. + + + + + Commands + + + The following commands are understood: + + + + + + add NETWORK [, , , ] [] + + + + + A new route may be added by the add command. + It is always required to pass a valid network prefix + NETWORK, which can be either + IPv6 or IPv4. + + + For unicast routes, the + option must be passed, where GATEWAY + is a valid IP address of the same protocol type as the + network prefix is. + + + Use , , + can be used to create of that + type. See ROUTE TYPES below for more + information about these options. + + + The optional parameter defines the + MTU along the path to the destination and must be an integer + number. This will show you very detailed information about + the given device. + + + + + + + remove NETWORK + + + + + A route can be removed with the command. + + + NETWORK is the network prefix + of an existing route. + + + + + + + list [] + + + + + Shows a list of all configured routes. + + + Pass the protocol option to filter the output only for the + given protocol. + + + + + + + + Route Types + + + unicast + + + A unicast route is the most common route in routing tables. + It is a route to a destination network address, which describes + the path to the destination. + Use the option to create such + a route. + + + + + unreachable + + + When a route is determined and the routing decision process + returns a destination with an unreachable route type, an ICMP + unreachable message is generated and returned to the source + address. + + + + + prohibit + + + This works like an unreachable route, but + the returned ICMP message is an ICMP prohibited message. + + + + + blackhole + + + Packets matching this kind of route are silently discarded. + There will be no ICMP message sent to the source and no packet + be forwarded. + + + + + + See Also + + + + network + 8 + , + + ip-route + 8 + + + + diff --git a/man/network-zone-bridge.8.in b/man/network-zone-bridge.8.in deleted file mode 100644 index eb2ab042..00000000 --- a/man/network-zone-bridge.8.in +++ /dev/null @@ -1,88 +0,0 @@ -.TH network-zone-bridge 8 "8 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-zone-bridge \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] zone create bridge ...\fR -.P -All options may be edited on zones which have already been set up with the \fBbridge\fR hook: -.P -\fBnetwork [OPTIONS] zone edit ...\fR - -.SH DESCRIPTION -The bridge hook creates an ethernet bridge which acts as an unmanaged network -switch. It contains one or multiple phyisical network interfaces or virtual -devices which will be connected to each other. -.PP -The bridge hook is the prefered hook for local area network zones which are -connected to an ethernet network. - -.SH OPTIONS -The \fBbridge\fR hook offers various configuration options: - -\fB--stp\fR = [\fBon\fR|off] -.RS 4 -This option enables or disable the use of the \fBSpanning Tree Protocol\fR (STP). -This protocol is used to avoid loops in networks by dynamically disabling packet -forwarding on links. -.PP -It is highly recommended to leave this option enabled when you add more than -one device to the zone. Read below how the behaviour of STP can be changed. -.RE -.PP - -\fB--mtu\fR = 1500 -.RS 4 -Sets the default MTU of the bridge. All ports in the bridge must support this -MTU. -.RE -.PP - -\fB--mac\fR = ... -.RS 4 -By this option, you may define the MAC address of the bridge. If this option -is missing, a random MAC address will be generated. -.RE -.PP - -Spanning Tree Protocol configuration options: - -\fB--stp-mode\fR = [\fBrstp\fR|stp] -.RS 4 -When STP is enabled, this option will set the operational mode which can either be: -.PP -* \fBSpanning Tree Protocol IEEE 802.1D\fR (stp) was introduced in 1998 by Radia -Perlman. -.P -* \fBRapid Spanning Tree Protocol IEEE 802.1W\fR (rstp) which has much faster convergence -times and was introduced in 2004. This is the default option. -.RE -.PP - -\fB--stp-forward-delay\fR = 0 -.RS 4 -This sets the default time the interfaces are hold off after they have been added -to a bridge. The default value is 0. -.RE -.PP - -\fB--stp-hello\fR = 2 -.RS 4 -This option defines how often a hello message should be sent. The value is given in seconds -and the default is 2. -.RE -.PP - -\fB--stp-priority\fR = 512 -.RS 4 -The STP priority sets the ranking of this network device within the network. The bridge -with the best rank (0 is best) will become the root bridge. -.RE -.PP - -.SH SEE ALSO -network(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-zone-bridge.xml b/man/network-zone-bridge.xml new file mode 100644 index 00000000..4a121fa3 --- /dev/null +++ b/man/network-zone-bridge.xml @@ -0,0 +1,200 @@ + + + + + + network-zone-bridge + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone-bridge + 8 + + + + network-zone-bridge + Network Configuration Control Program + + + + + network zone create ZONE bridge ... + + + + network zone ZONE edit ... + + + + + Description + + + The bridge hook creates an ethernet bridge which acts as an unmanaged network + switch. It contains one or multiple phyisical network interfaces or virtual + devices which will be connected to each other. + + + The bridge hook is the prefered hook for local area network zones which are + connected to an ethernet network. + + + + + Options + + + The following options are understood: + + + + + + + + + + + This option enables or disable the use of the + Spanning Tree Protocol (STP). + This protocol is used to avoid loops in networks by + dynamically disabling packet forwarding on links. + + + It is highly recommended to leave this option enabled + when you add more than one device to the zone. + Read below how the behaviour of STP can be changed. + + + + + + + + + + + + Sets the default MTU of the bridge. + All ports in the bridge must support this MTU value. + + + + + + + + + + + + By this option, you may define the MAC address of the + bridge. If this option is missing, a random MAC address + will be generated. + + + + + + + Spanning Tree Protocol configuration options: + + + + + + + + + + + When STP is enabled, this option will set the operational + mode which can either be: + + + + + Spanning Tree Protocol IEEE 802.1D + (stp) was introduced in 1998 by Radia Perlman. + + + + + Rapid Spanning Tree Protocol IEEE 802.1W + (rstp) which has much faster convergence times and was + introduced in 2004. This is the default option. + + + + + + + + + + + + + + This sets the default time the interfaces are hold off + after they have been added to a bridge. + The default value is 0. + + + + + + + + + + + + This option defines how often a hello message should be + sent. The value is given in seconds and the default is 2. + + + + + + + + + + + + The STP priority sets the ranking of this network device + within the network. The bridge with the best rank + (0 is best) will become the root bridge. + + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + + + + diff --git a/man/network-zone-config-pppoe-server.8.in b/man/network-zone-config-pppoe-server.8.in deleted file mode 100644 index a118c576..00000000 --- a/man/network-zone-config-pppoe-server.8.in +++ /dev/null @@ -1,64 +0,0 @@ -.TH network-zone-config-pppoe-server 8 "24 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-zone-config-pppoe-server \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] zone config create pppoe-server --subnet=...\fR -.P - -.SH DESCRIPTION -This configuration hook enables a \fBPPPoE server\fR functionality to -a zone which is of an ethernet-like type. -.PP -The PPPoE server is mostly for development purpose and performs pretty -well. However, it is not recommended to use it in production environments. -.PP - -.SH OPTIONS -The \fBpppoe-server\fR config hook offers various configuration options: - -\fB--subnet\fR = 10.0.0.0/24 -.RS 4 -The \fB--subnet=\fR option defines an IPv4 pool of which IP addresses -are assigned to the remote hosts. The first address of the subnet -will be used for the gateway which is the PPPoE server itself. -.PP -The subnet must at least have two IP addresses. Broadcast and network -addresses will be used as well. -.RE -.PP - -\fB--mtu\fR = 1492 -.RS 4 -Set the required MTU (Maximum Transmission Unit) for the PPP connection. -.PP -The default value is 1492 bytes which is a common MTU for DSL connections. -.RE -.PP - -\fB--service-name\fR = ... -.RS 4 -This options receives a string which will be used as the service name. -The service name is sent out to the clients and used for identification -but not authorization purposes. -.PP -The default is an empty. -.RE -.PP - -\fB--max-sessions\fR = 0 -.RS 4 -Limit the max. number of sessions that may be established by the same -MAC address. -.PP -This must be a positive number. 0 permits an unlimited number of sessions -per MAC address. -.RE -.PP - -.SH SEE ALSO -network(8), network-zone-config(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-zone-config-pppoe-server.xml b/man/network-zone-config-pppoe-server.xml new file mode 100644 index 00000000..e6d497ee --- /dev/null +++ b/man/network-zone-config-pppoe-server.xml @@ -0,0 +1,143 @@ + + + + + + network-zone-config-pppoe-server + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone-config-pppoe-server + 8 + + + + network-zone-config-pppoe-server + Network Configuration Control Program + + + + + network zone ZONE config create pppoe-server ... + + + + + Description + + + This configuration hook enables a PPPoE server + functionality to a zone which is of an ethernet-like type. + + + The PPPoE server is mostly for development purpose and performs pretty + well. However, it is not recommended to use it in production environments. + + + + + Options + + + The following options are understood: + + + + + + + + + + + The option defines an IPv4 pool + of which IP addresses are assigned to the remote hosts. + The first address of the subnet will be used for the + gateway which is the PPPoE server itself. + + + The subnet must at least have two IP addresses. + Broadcast and network addresses will be used as well. + + + + + + + + + + + + Set the required MTU (Maximum Transmission Unit) for + the PPP connection. + + + The default value is 1492 bytes which is a common MTU for + DSL connections. + + + + + + + + + + + + This options receives a string which will be used as the + service name. The service name is sent out to the clients + and used for identification but not authorization purposes. + + + The default is an empty value. + + + + + + + + + + + + Limit the max. number of sessions that may be established + by the same MAC address. + + + This must be a positive number. 0 permits an unlimited + number of sessions per MAC address. + + + + + + + + See Also + + + + network + 8 + , + + network-zone-config + 8 + + + + diff --git a/man/network-zone-pppoe.8.in b/man/network-zone-pppoe.8.in deleted file mode 100644 index 470420d8..00000000 --- a/man/network-zone-pppoe.8.in +++ /dev/null @@ -1,79 +0,0 @@ -.TH network-zone-pppoe 8 "21 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-zone-pppoe \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] zone create pppoe ...\fR -.P -All options may be edited on zones which have already been set up with the \fBpppoe\fR hook: -.P -\fBnetwork [OPTIONS] zone edit ...\fR - -.SH DESCRIPTION -The pppoe hook creates a PPPoE connection to your ISP. -.PP - -.SH OPTIONS -The \fBpppoe\fR hook offers various configuration options: - -\fB--port\fR = ... -.RS 4 -This options sets the port, pppd is using to connect to the modem. -.PP -This may be a normal ethernet or vlan interface. -.RE -.PP - -\fB--username\fR = ... -.RS 4 -Sets the username for authentication. -.RE -.PP - -\fB--password\fR = ... -.RS 4 -Sets the password for authentication. -.PP -Use the \fB--auth=\fR option to transmit it in a secure manner to the provider. -.RE -.PP - -\fB--mtu\fR = 1492 -.RS 4 -Sets the default MTU of the PPP connection. The default value is 1492 which is -a common MTU used for DSL. -.RE -.PP - -\fB--auth\fR = [chap|pap] -.RS 4 -Define the authentication method that is used to authenticate -against your provider. The default is to use the provider's preference. -.PP -* \fBChallange-Handshake Authentication Protocol\fR (chap) is the preferred -secure method. -.PP -* \fBPassword Authentication Protocol\fR (pap) sends the plaintext password -to the authentication server which is the reason why it should be avoided -to use PAP. -.RE -.PP - -\fB--access-concentrator\fR = ... -.RS 4 -By this option, you may define the name of the access concentrator. -.RE -.PP - -\fB--service-name\fR = ... -.RS 4 -By this option, you may define the service name. -.RE -.PP - -.SH SEE ALSO -network(8), network-zone(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-zone-pppoe.xml b/man/network-zone-pppoe.xml new file mode 100644 index 00000000..ede9375c --- /dev/null +++ b/man/network-zone-pppoe.xml @@ -0,0 +1,179 @@ + + + + + + network-zone-pppoe + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone-pppoe + 8 + + + + network-zone-pppoe + Network Configuration Control Program + + + + + network zone create ZONE pppoe ... + + + + + Description + + + The pppoe hook creates a PPPoE connection to your ISP. + + + + + Options + + + The following options are understood: + + + + + + + + + + + This options sets the port, pppd is using to connect to + the modem. + + + This may be a normal ethernet or vlan interface. + + + + + + + + + + + + Sets the username for authentication. + + + + + + + + + + + + Sets the password for authentication. + + + Use the option to transmit it + in a secure manner to the provider. + + + + + + + + + + + + Sets the default MTU of the PPP connection. + The default value is 1492 which is a common MTU used + for DSL. + + + + + + + + + + + + Define the authentication method that is used to + authenticate against your provider. + The default is to use the provider's preference. + + + + + Challange-Handshake Authentication Protocol + (chap) is the preferred secure method. + + + + + Password Authentication Protocol + (pap) sends the plaintext password to the authentication + server which is the reason why it should be avoided to use PAP. + + + + + + + + + + + + + + By this option, you may define the name of the access concentrator. + + + + + + + + + + + + By this option, you may define the service name. + + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + + + + diff --git a/man/network-zone.8.in b/man/network-zone.8.in deleted file mode 100644 index 75633c55..00000000 --- a/man/network-zone.8.in +++ /dev/null @@ -1,80 +0,0 @@ -.TH network-zone 8 "1 Jun 2012" "@VERSION@" "network man page" - -.SH NAME -network-zone \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [OPTIONS] zone [create|remove] ...\fR -.P -\fBnetwork [OPTIONS] zone list-hooks\fR -.P -\fBnetwork [OPTIONS] zone command ...\fR - -.SH DESCRIPTION -By the zone subcommands, it is very easy to configure network zones. -.PP -It is possible to create zones and remove them. Zones may also -be brought up and down and reconfigured. Their status may be viewed -as well. - -.SH OPTIONS -The \fBnetwork zone\fR command offers various commands: - -\fBcreate [options]\fR -.RS 4 -A new zone may be created by the \fBcreate\fR command. There are at least two arguments -required. -.PP -\fB\fR must be valid name for a zone which does not already exist. -\fB\fR is a valid zone hook which may require additional options. -.RE -.PP - -\fBremove \fR -.RS 4 -A zone can be simple removed with this command. -.PP -There are two possible ways to remove a zone. The case is when the zone is not up. Then, -it will be removed immediately. When the zone is current up and used, it will tagged -to be remove later, after it has been brought down. -.RE -.PP - -\fBlist-hooks\fR -.RS 4 -Outputs a list of all possible hooks for the zones. -.RE -.PP - -For all other commands, the name of the zone needs to be passed first: -\fBnetwork zone command\fR. - -\fB edit [OPTIONS]\fR -.RS 4 -The settings of a zone may be edited after it has been created. The options that can -be passed depend on the hook that is used for the zone. Run \fBnetwork zone edit --help\fR -to learn more about that. -.PP -It normally is required to restart/reload the zone until the new settings are taken into account. -.RE -.PP - -\fB [up|down]\fR -.RS 4 -These commands will bring the zone up/down. This is done without control of systemd, therefore -not intended to be done in a productive environment. However, these commands may be used for -debugging. -.RE -.PP - -\fB status\fR -.RS 4 -This will show some detailed information about the state if the specified zone. -.RE -.PP - -.SH SEE ALSO -network(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network-zone.xml b/man/network-zone.xml new file mode 100644 index 00000000..15908dba --- /dev/null +++ b/man/network-zone.xml @@ -0,0 +1,182 @@ + + + + + + network-zone + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone + 8 + + + + network-zone + Network Configuration Control Program + + + + + network zone [create|remove] ZONE ... + + + + network zone list-hooks + + + + network zone ZONE command ... + + + + + Description + + + With help of the zone command, it is very easy to + configure network zones. + + + It is possible to create zones and remove them. Zones may also + be brought up and down and reconfigured. Their status may be viewed + as well. + + + + + Commands + + + The following commands are understood: + + + + + + create ZONE HOOK OPTIONS + + + + + A new zone may be created by the create + command. There are at least two arguments required. + + + ZONE must be valid name for a + zone which does not already exist. + HOOK is a valid zone hook which + may require additional options. + + + + + + + remove ZONE + + + + + A zone can be simple removed with this command. + + + There are two possible ways to remove a zone. The case + is when the zone is not up. Then, it will be removed + immediately. When the zone is current up and used, it + will tagged to be remove later, after it has been brought + down. + + + + + + + list-hooks + + + + + Outputs a list of all eligible hooks for the zones. + + + + + + + For all other commands, the name of the zone needs to be passed first: + + + + + + ZONE edit OPTIONS + + + + + The settings of a zone may be edited after it has been created. + The options that can be passed depend on the hook that is used + for the zone. + Run network zone ZONE edit --help + to learn more about that. + + + It usually is required to restart/reload the zone until + the new settings are taken into account. + + + + + + + ZONE [up|down] + + + + + These commands will bring the zone up/down. This is done + without control of systemd, therefore not intended to be + done in a productive environment. + However, these commands may be used for debugging. + + + + + + + ZONE status + + + + + This will show some detailed information about the state + if the specified zone. + + + + + + + + See Also + + + + network + 8 + + + + diff --git a/man/network.8.in b/man/network.8.in deleted file mode 100644 index dd91b7a2..00000000 --- a/man/network.8.in +++ /dev/null @@ -1,136 +0,0 @@ -.TH network 8 "31 May 2012" "@VERSION@" "network man page" - -.SH NAME -network \- Network Configuration Control Program - -.SH SYNOPSIS -\fBnetwork [--debug|-d] command\fR - -.SH DESCRIPTION -The network command is a tool which configures the network on every IPFire -system. It is a fast and versatile way to create, edit and remove -configurations, review the status of the network and it is working in the -background of the system making sure that things are running smoothly. -.PP - -.SH OPTIONS -\fB\-\-debug\fR -(short \fB\-d\fR) -.RS 4 -The \fB\-\-debug\fR switch enabled the debugging mode. In this mode, there -will be debug output in the console and written to the log files. -.PP -The debugging mode can be permanently enabled by running -\fBnetwork config DEBUG=1\fR. -.RE -.PP - -The \fBnetwork\fR command offers various commands: - -\fBstart [zone-name ...]\fR -.RS 4 -The \fBstart\fR command starts a zone. That means the network zone will be created -and brought up. -If one or more names of zones are passed to the command, only those will be started. -.PP -The startup of the zones itself is dispatches to \fBsystemd\fR(8). -.RE -.PP - -\fBstop [zone-name ...]\fR -.RS 4 -The \fBstop\fR command stops a zone. This is the inverse of the \fBstart\fR command. -.RE -.PP - -\fBrestart [zone-name ...]\fR -.RS 4 -The \fBrestart\fR command will stop and start all given zones or all. -.RE -.PP - -\fBstatus [zone-name ...]\fR -.RS 4 -The \fBstatus\fR command will show a human-readable overview of the status of the -network zones. -.RE -.PP - -\fBzone ...\fR -.RS 4 -The \fBzone\fR command is the most used command. It can configure zones. -Read more about that in \fBnetwork-zone\fR(8). -.RE -.PP - -\fBport ...\fR -.RS 4 -The \fBport\fR command is used to create, remove and configure ports. -Read more about that in \fBnetwork-port\fR(8). -.RE -.PP - -\fBdevice ...\fR -.RS 4 -The \fBdevice\fR command is used to read status information about -devices. Detailed information is to be found in \fBnetwork-device\fR(8). -.RE -.PP - -\fBconfig [KEY=VALUE ...]\fR -.RS 4 -The \fBconfig\fR command will return you are list of the global configuration -parameters of the network command. -.PP -You may set them by appending a new setting to the command line. -.RE -.PP - -\fBhelp [ ]\fR -.RS 4 -Running "network help" without any arguments will show you this man page. -.PP -You may optionally give two arguments, to view the help of a certain hook. -The type of the hook (\fB\fR) needs to be passed as well as the -name of the hook (\fB\fR). -.RE -.PP - -\fBhostname [new-hostname]\fR -.RS 4 -The \fBhostname\fR command will return the currently configured hostname of the system. -.PP -If a new hostname is added to the command line, it will be configured, but will be set -after the next reboot. -.RE -.PP - -\fBdns-server ...\fR -.RS 4 -The \fBdns-server\fR command will help you configuring the local DNS servers. -.RE -.PP - -\fBreset\fR -.RS 4 -The \fBreset\fR command will reset all network configuration. That means all zone configurations -will be removed and there will be no networking at the next reboot. -.RE -.PP - -.SH EXIT CODES -The \fBnetwork\fR command will normally exit with code 0. If there has been a problem -and the requested action could not be done, the exit code is unequal to zero. - -.SH BUGS -Please report all bugs to the official bugtracker at http://bugs.ipfire.org/. - -.SH SEE ALSO -network-config(8), -network-device(8), -network-dns-server(8), -network-port(8), -network-zone(8) - -.SH AUTHOR -Michael Tremer (michael.tremer@ipfire.org) diff --git a/man/network.xml b/man/network.xml new file mode 100644 index 00000000..bc72114d --- /dev/null +++ b/man/network.xml @@ -0,0 +1,323 @@ + + + + + + network + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network + 8 + + + + network + Network Configuration Control Program + + + + + network + OPTIONS + COMMAND + + + + + Description + + + The network command is a tool which configures + the network on every IPFire system. It is a fast and versatile + way to create, edit and remove configurations, review the status + of the network and it is working in the background of the system + making sure that things are running smoothly. + + + + + Options + + + The following options are understood: + + + + + + + + + + + + + + Enables the debugging mode. + In this mode, there will be debug output on + the console and written to the log. + + + The debugging mode can be permanently enabled by setting + DEBUG=1 + + + + + + + + Commands + + + The following commands are understood: + + + + + + start ZONE-NAME... + + + + + Starts a zone. That means the network zone will be created + and brought up. + If one or more zone names are passed to the command, only + these will be started. + + + + + + + stop ZONE-NAME... + + + + + Stops a zone. This is the inverse of the start + command. + + + + + + + restart ZONE-NAME... + + + + + Restarts a zone. + + + + + + + status ZONE-NAME... + + + + + Shows a human-readable overview of the status + of the network zone. + + + + + + + zone ... + + + + + Configure a zone or show status information. + See + network-zone + 8 + for details. + + + + + + + port ... + + + + + Configure a port or show status information. + See + network-port + 8 + for details. + + + + + + + device ... + + + + + Show status information about network devices. + See + network-device + 8 + for details. + + + + + + + config KEY=VALUE + + + + + Shows and alters global configuration parameters. + See + network-config + 8 + for details. + + + + + + + help [TYPE HOOK] + + + + + Calling network help without any + arguments will show you this man page. + + + You may optionally pass two arguments, to view the help + of a certain hook. + The type of the hook TYPE + needs to be passed as well as the name of the hook + HOOK. + + + + + + + hostname HOSTNAME + + + + + The hostname command will return the + currently configured hostname of the system. + + + If a new hostname is added to the command line, + it will be configured, but will be set after the next + reboot. + + + + + + + dns-server ... + + + + + The dns-server command will help you + configuring the local DNS servers. + See + network-dns-server + 8 + for details. + + + + + + + reset + + + + + The reset command will reset all + network configuration. That means all zone configurations + will be removed and there will be no networking after the + next reboot. + + + + + + + + Exit Codes + + + The network command will normally exit with code 0. + If there has been a problem and the requested action could not be done, + the exit code is unequal to zero. + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugs.ipfire.org/. + + + + + See Also + + + + network-config + 8 + , + + network-device + 8 + , + + network-dns-server + 8 + , + + network-port + 8 + , + + network-zone + 8 + + + + -- 2.39.2