-man/*.8
+man/*.[0-9]
+man/*.html
-
include Makeconfig
DESTDIR=
# 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:
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)
+++ /dev/null
-###############################################################################
-# #
-# 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 <http://www.gnu.org/licenses/>. #
-# #
-###############################################################################
-
-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
--- /dev/null
+<?xml version='1.0'?>
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/>
+
+<!-- translate man page references to links to html pages -->
+<xsl:template match="citerefentry">
+ <a>
+ <xsl:attribute name="href">
+ <xsl:value-of select="refentrytitle"/><xsl:text>.html</xsl:text>
+ </xsl:attribute>
+ <xsl:call-template name="inline.charseq"/>
+ </a>
+</xsl:template>
+
+<!-- add Index link at top of page -->
+<xsl:template name="user.header.content">
+ <a>
+ <xsl:attribute name="href">
+ <xsl:text>index.html</xsl:text>
+ </xsl:attribute>
+ <xsl:text>Index</xsl:text>
+ </a>
+ <hr/>
+</xsl:template>
+
+<!-- Switch things to UTF-8, ISO-8859-1 is soo yesteryear -->
+<xsl:output method="html" encoding="UTF-8" indent="no"/>
+
+</xsl:stylesheet>
+++ /dev/null
-.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)
--- /dev/null
+<?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-config">
+ <refentryinfo>
+ <title>network-config</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-config</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network config</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network config <replaceable>KEY=VALUE</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <command>network config</command> command may be used to set
+ global configuration options.
+ </para>
+ <para>
+ Please have a look at the individual man pages for more options.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ If no additional argument is given, running the command will
+ dump a list of all configuration variables and their current values.
+ </para>
+
+ <para>
+ You may set a new value by adding the variable name and the new
+ value to the command line.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Variables</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <varname>COLORS</varname>=[<emphasis>auto</emphasis>|on|off]
+ </term>
+
+ <listitem>
+ <para>
+ This will control the output of the console tools.
+ <varname>on</varname> will enable colorful output all
+ the time, <varname>off</varname> will disable colors.
+ </para>
+ <para>
+ The default setting is <varname>auto</varname> which will
+ automatically detect if the console supports colors.
+ </para>
+ <para>
+ Colorful output is very helpful to spot important information
+ more quickly.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <varname>DEBUG</varname>=[<emphasis>0</emphasis>|1]
+ </term>
+
+ <listitem>
+ <para>
+ The <varname>DEBUG</varname> 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-dns-server</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.TH network-device 8 "6 Jun 2012" "@VERSION@" "network man page"
-
-.SH NAME
-network-device \- Network Configuration Control Program
-
-.SH SYNOPSIS
-\fBnetwork [OPTIONS] device <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<device> 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<device> 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<device> 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)
--- /dev/null
+<?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-device">
+ <refentryinfo>
+ <title>network-device</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-device</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-device</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network device <arg choice="plain">COMMAND</arg></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ With help of the <command>device</command> subcommands, it is very easy
+ to get status information about network devices and to do some more
+ things.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ The following commands are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command><replaceable>DEVICE</replaceable> status</command>
+ </term>
+
+ <listitem>
+ <para>
+ This will show you very detailed information about the given
+ device.
+ </para>
+ <para>
+ This is all about the ethernet parts of the device and
+ does not contain any IP information as this is defined
+ as a zone (<citerefentry>
+ <refentrytitle>network-zone</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command><replaceable>DEVICE</replaceable> discover</command>
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command><replaceable>DEVICE</replaceable> unlock</command>
+ </term>
+
+ <listitem>
+ <para>
+ This command will unlock the SIM card in a modem.
+ Only serial devices are supported which are the most
+ UMTS or 3G modems.
+ </para>
+ <para>
+ For the PIN or PUK code, the user will be prompted.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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] <server> [<priority>]\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 <server> [<priority>]\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<server>\fR must be a valid IP address and \fB<priority>\fR must be an integer.
-The smaller the number, the higher is the rank of the server.
-.RE
-.PP
-
-\fBremove <server>\fR
-.RS 4
-A server may be removed by this command where \fB<server>\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)
--- /dev/null
+<?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-dns-server">
+ <refentryinfo>
+ <title>network-dns-server</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-dns-server</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-dns-server</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network dns-server <arg choice="plain">[add|remove]</arg> <arg choice="plain">SERVER</arg> [<arg choice="plain">PRIORITY</arg>]</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network dns-server <arg choice="plain">[list|update]</arg></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ With help of the <command>dns-server</command> subcommand, you will
+ be able to configure the local DNS configuration.
+ DNS is short for Domain Name System.
+ </para>
+ <para>
+ You may add and remove DNS servers as well as view the settings.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ The following commands are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command>
+ add
+ <replaceable>SERVER</replaceable>
+ [<replaceable>PRIORITY</replaceable>]
+ </command>
+ </term>
+
+ <listitem>
+ <para>
+ A new DNS server may be added to the list by the
+ <command>add</command> command. A priority that will
+ rank the server my optionally be given.
+ </para>
+ <para>
+ <replaceable>SERVER</replaceable> must be a valid IP address
+ and <replaceable>PRIORITY</replaceable> must be a positive
+ integer number. The smaller this number, the higher is
+ is the rank of the server.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>
+ remove
+ <replaceable>SERVER</replaceable>
+ </command>
+ </term>
+
+ <listitem>
+ <para>
+ The given server will be removed from the list of
+ DNS servers.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>list</command>
+ </term>
+
+ <listitem>
+ <para>
+ Shows a list of all servers that are currently in use.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>update</command>
+ </term>
+
+ <listitem>
+ <para>
+ This command will re-create the system's configuration
+ files. It should not be required to use this command
+ very often.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Variables</title>
+
+ <para>
+ These variables may be set by using the <citerefentry>
+ <refentrytitle>network-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> command.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <varname>DNS_USE_LOCAL_RESOLVER</varname>=[<emphasis>true</emphasis>|false]
+ </term>
+
+ <listitem>
+ <para>
+ This option defines whether the local DNS resolver should
+ be used or not.
+ </para>
+ <para>
+ Basically, the option adds localhost to the list of
+ nameservers in <citerefentry>
+ <refentrytitle>resolv.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </citerefentry>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <varname>DNS_RANDOMIZE</varname>=[true|<emphasis>false</emphasis>]
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <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)
--- /dev/null
+<?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-port-batman-adv-port">
+ <refentryinfo>
+ <title>network-port-batman-adv-port</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-port-batman-adv-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-port-batman-adv-port</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network port create batman-adv-port ...</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network <arg choice="plain">PORT</arg> edit ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ This hook configures a wireless device that is then used as a port
+ in the <emphasis>batman-adv</emphasis> hook.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--address=<replaceable>ADDRESS</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Define the MAC address of the interface. If no address
+ is defined, a random one will be generated.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--channel=<replaceable>NUMBER</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Set the channel number of the channel that should be used
+ for the wireless network.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--country-code=<replaceable>CODE</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Sets the country code for the wireless interface.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--phy=<replaceable>PHY</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Use this wireless phy to create the interface.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--ssid=<replaceable>SSID</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Define the ESSID of the wireless network.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--mesh-id=<replaceable>MESH-ID</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Define the mesh id or BSSID of the wireless network.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-port-batman-adv</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <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)
--- /dev/null
+<?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-port-batman-adv">
+ <refentryinfo>
+ <title>network-port-batman-adv</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-port-batman-adv</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-port-batman-adv</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network port create batman-adv ...</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network <arg choice="plain">PORT</arg> edit ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The batman-adv hook creates a batman-adv soft interface, which is
+ used to bridge several hard interfaces (wireless adapters, etc.).
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--address=<replaceable>ADDRESS</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Define the MAC address of the interface. If no address
+ is defined, a random one will be generated.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--slaves=<replaceable>SLAVES</replaceable></option>
+ (only on create)
+ </term>
+
+ <listitem>
+ <para>
+ Define a lits of port, which should be used as slaves.
+ All slaves must be <emphasis>batman-adv-port</emphasis>
+ ports.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--add-slave=<replaceable>SLAVE</replaceable></option>
+ (only on edit)
+ </term>
+
+ <listitem>
+ <para>
+ Adds an additional slave port.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--del-slave=<replaceable>SLAVE</replaceable></option>
+ (only on edit)
+ </term>
+
+ <listitem>
+ <para>
+ Removes a slave port.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-port-batman-adv-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
-.P
-\fBnetwork [OPTIONS] route remove <network>\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 <network> <--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<network>\fR), which
-can be either IPv6 or IPv4.
-.PP
-For unicast routes, the \fB--gateway=<gateway>\fR option must be passed, where
-\fB<gateway>\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 <network>\fR
-.RS 4
-A route can be removed with this command.
-.PP
-\fB<network>\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)
--- /dev/null
+<?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-route">
+ <refentryinfo>
+ <title>network-route</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-route</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-route</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network route <arg choice="plain">COMMAND</arg></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <command>route</command> helps to manage static routes.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ The following commands are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command>add <replaceable>NETWORK</replaceable> [<option>--gateway=GATEWAY</option>, <option>--unreachable</option>, <option>--prohibit</option>, <option>--blackhole</option>] [<option>--mtu=MTU</option>]</command>
+ </term>
+
+ <listitem>
+ <para>
+ A new route may be added by the <command>add</command> command.
+ It is always required to pass a valid network prefix
+ <replaceable>NETWORK</replaceable>, which can be either
+ IPv6 or IPv4.
+ </para>
+ <para>
+ For unicast routes, the <option>--gateway=GATEWAY</option>
+ option must be passed, where <varname>GATEWAY</varname>
+ is a valid IP address of the same protocol type as the
+ network prefix is.
+ </para>
+ <para>
+ Use <option>--unreachable</option>, <option>--prohibit</option>,
+ <option>--blackhole</option> can be used to create of that
+ type. See <emphasis>ROUTE TYPES</emphasis> below for more
+ information about these options.
+ </para>
+ <para>
+ The optional <option>--mtu=MTU</option> 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>remove <replaceable>NETWORK</replaceable></command>
+ </term>
+
+ <listitem>
+ <para>
+ A route can be removed with the command.
+ </para>
+ <para>
+ <replaceable>NETWORK</replaceable> is the network prefix
+ of an existing route.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>list [<option>--protocol=ipv6|ipv4</option>]</command>
+ </term>
+
+ <listitem>
+ <para>
+ Shows a list of all configured routes.
+ </para>
+ <para>
+ Pass the protocol option to filter the output only for the
+ given protocol.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Route Types</title>
+
+ <refsect2>
+ <title>unicast</title>
+
+ <para>
+ 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>--gateway=GATEWAY</option> option to create such
+ a route.
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>unreachable</title>
+
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>prohibit</title>
+
+ <para>
+ This works like an <emphasis>unreachable</emphasis> route, but
+ the returned ICMP message is an ICMP prohibited message.
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>blackhole</title>
+
+ <para>
+ Packets matching this kind of route are silently discarded.
+ There will be no ICMP message sent to the source and no packet
+ be forwarded.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>ip-route</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <zone> 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 <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)
--- /dev/null
+<?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-zone-bridge">
+ <refentryinfo>
+ <title>network-zone-bridge</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-zone-bridge</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-zone-bridge</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network zone create <replaceable>ZONE</replaceable> bridge ...</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network zone <replaceable>ZONE</replaceable> edit ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ 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.
+ </para>
+ <para>
+ The bridge hook is the prefered hook for local area network zones which are
+ connected to an ethernet network.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--stp=[<emphasis>on</emphasis>|off]</option>
+ </term>
+
+ <listitem>
+ <para>
+ This option enables or disable the use of the
+ <emphasis>Spanning Tree Protocol</emphasis> (STP).
+ This protocol is used to avoid loops in networks by
+ dynamically disabling packet forwarding on links.
+ </para>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--mtu=<replaceable>MTU</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Sets the default MTU of the bridge.
+ All ports in the bridge must support this MTU value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--address=<replaceable>ADDRESS</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ By this option, you may define the MAC address of the
+ bridge. If this option is missing, a random MAC address
+ will be generated.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Spanning Tree Protocol configuration options:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--stp-mode=[<emphasis>rstp</emphasis>|stp]</option>
+ </term>
+
+ <listitem>
+ <para>
+ When STP is enabled, this option will set the operational
+ mode which can either be:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Spanning Tree Protocol IEEE 802.1D</emphasis>
+ (stp) was introduced in 1998 by Radia Perlman.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Rapid Spanning Tree Protocol IEEE 802.1W</emphasis>
+ (rstp) which has much faster convergence times and was
+ introduced in 2004. This is the default option.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--stp-forward-delay=<replaceable>0</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ This sets the default time the interfaces are hold off
+ after they have been added to a bridge.
+ The default value is 0.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--stp-hello=<replaceable>2</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ This option defines how often a hello message should be
+ sent. The value is given in seconds and the default is 2.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--stp-priority=<replaceable>512</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </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>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <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)
--- /dev/null
+<?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-zone-config-pppoe-server">
+ <refentryinfo>
+ <title>network-zone-config-pppoe-server</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-zone-config-pppoe-server</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-zone-config-pppoe-server</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network zone <replaceable>ZONE</replaceable> config create pppoe-server ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ This configuration hook enables a <emphasis>PPPoE server</emphasis>
+ functionality to a zone which is of an ethernet-like type.
+ </para>
+ <para>
+ The PPPoE server is mostly for development purpose and performs pretty
+ well. However, it is not recommended to use it in production environments.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--subnet=<replaceable>SUBNET</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ The <option>--subnet</option> 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.
+ </para>
+ <para>
+ The subnet must at least have two IP addresses.
+ Broadcast and network addresses will be used as well.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--mtu=<replaceable>MTU</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Set the required MTU (Maximum Transmission Unit) for
+ the PPP connection.
+ </para>
+ <para>
+ The default value is 1492 bytes which is a common MTU for
+ DSL connections.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--service-name=<replaceable>STRING</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ The default is an empty value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--max-sessions=<emphasis>0</emphasis></option>
+ </term>
+
+ <listitem>
+ <para>
+ Limit the max. number of sessions that may be established
+ by the same MAC address.
+ </para>
+ <para>
+ This must be a positive number. 0 permits an unlimited
+ number of sessions per MAC address.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-zone-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 <zone> 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 <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)
--- /dev/null
+<?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-zone-pppoe">
+ <refentryinfo>
+ <title>network-zone-pppoe</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-zone-pppoe</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-zone-pppoe</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network zone create <replaceable>ZONE</replaceable> pppoe ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The pppoe hook creates a PPPoE connection to your ISP.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--port=<replaceable>PORT</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ This options sets the port, pppd is using to connect to
+ the modem.
+ </para>
+ <para>
+ This may be a normal ethernet or vlan interface.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--username=<replaceable>USERNAME</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Sets the username for authentication.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--password=<replaceable>PASSWORD</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ Sets the password for authentication.
+ </para>
+ <para>
+ Use the <option>--auth=</option> option to transmit it
+ in a secure manner to the provider.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--mtu=<emphasis>1492</emphasis></option>
+ </term>
+
+ <listitem>
+ <para>
+ Sets the default MTU of the PPP connection.
+ The default value is 1492 which is a common MTU used
+ for DSL.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--auth=[chap|pap]</option>
+ </term>
+
+ <listitem>
+ <para>
+ Define the authentication method that is used to
+ authenticate against your provider.
+ The default is to use the provider's preference.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>Challange-Handshake Authentication Protocol</emphasis>
+ (chap) is the preferred secure method.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Password Authentication Protocol</emphasis>
+ (pap) sends the plaintext password to the authentication
+ server which is the reason why it should be avoided to use PAP.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--access-concentrator=<replaceable>STRING</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ By this option, you may define the name of the access concentrator.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--service-name=<replaceable>STRING</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>
+ By this option, you may define the service name.
+ </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>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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] <zone> ...\fR
-.P
-\fBnetwork [OPTIONS] zone list-hooks\fR
-.P
-\fBnetwork [OPTIONS] zone <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 <zone> <hook> [options]\fR
-.RS 4
-A new zone may be created by the \fBcreate\fR command. There are at least two arguments
-required.
-.PP
-\fB<zone>\fR must be valid name for a zone which does not already exist.
-\fB<hook>\fR is a valid zone hook which may require additional options.
-.RE
-.PP
-
-\fBremove <zone>\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 <zone> command\fR.
-
-\fB<zone> 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 <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<zone> [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<zone> 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)
--- /dev/null
+<?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-zone">
+ <refentryinfo>
+ <title>network-zone</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network-zone</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network-zone</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network zone <arg choice="plain">[create|remove]</arg> <replaceable>ZONE</replaceable> ...</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network zone <arg choice="plain">list-hooks</arg></command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>network zone <replaceable>ZONE</replaceable> <arg choice="plain">command</arg> ...</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ With help of the <command>zone</command> command, it is very easy to
+ configure network zones.
+ </para>
+ <para>
+ 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.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ The following commands are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command>create <replaceable>ZONE</replaceable> <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
+ </term>
+
+ <listitem>
+ <para>
+ A new zone may be created by the <command>create</command>
+ command. There are at least two arguments required.
+ </para>
+ <para>
+ <replaceable>ZONE</replaceable> must be valid name for a
+ zone which does not already exist.
+ <replaceable>HOOK</replaceable> is a valid zone hook which
+ may require additional options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>remove <replaceable>ZONE</replaceable></command>
+ </term>
+
+ <listitem>
+ <para>
+ A zone can be simple removed with this command.
+ </para>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>list-hooks</command>
+ </term>
+
+ <listitem>
+ <para>
+ Outputs a list of all eligible hooks for the zones.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ For all other commands, the name of the zone needs to be passed first:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command><replaceable>ZONE</replaceable> edit <arg choice="opt" rep="repeat">OPTIONS</arg></command>
+ </term>
+
+ <listitem>
+ <para>
+ 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 <command>network zone <replaceable>ZONE</replaceable> edit --help</command>
+ to learn more about that.
+ </para>
+ <para>
+ It usually is required to restart/reload the zone until
+ the new settings are taken into account.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command><replaceable>ZONE</replaceable> [up|down]</command>
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command><replaceable>ZONE</replaceable> status</command>
+ </term>
+
+ <listitem>
+ <para>
+ This will show some detailed information about the state
+ if the specified zone.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+++ /dev/null
-.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 [<type> <hook>]\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<type>\fR) needs to be passed as well as the
-name of the hook (\fB<hook>\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)
--- /dev/null
+<?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">
+ <refentryinfo>
+ <title>network</title>
+ <productname>network</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Michael</firstname>
+ <surname>Tremer</surname>
+ <email>michael.tremer@ipfire.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>network</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>network</refname>
+ <refpurpose>Network Configuration Control Program</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>network</command>
+ <arg choice="opt" rep="repeat">OPTIONS</arg>
+ <arg choice="plain">COMMAND</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <command>network</command> 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.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>
+ The following options are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>-d</option>
+ </term>
+ <term>
+ <option>--debug</option>
+ </term>
+
+ <listitem>
+ <para>
+ Enables the debugging mode.
+ In this mode, there will be debug output on
+ the console and written to the log.
+ </para>
+ <para>
+ The debugging mode can be permanently enabled by setting
+ <varname>DEBUG=1</varname>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
+
+ <para>
+ The following commands are understood:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <command>start <replaceable>ZONE-NAME</replaceable>...</command>
+ </term>
+
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>stop <replaceable>ZONE-NAME</replaceable>...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Stops a zone. This is the inverse of the <command>start</command>
+ command.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>restart <replaceable>ZONE-NAME</replaceable>...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Restarts a zone.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>status <replaceable>ZONE-NAME</replaceable>...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Shows a human-readable overview of the status
+ of the network zone.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>zone ...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Configure a zone or show status information.
+ See <citerefentry>
+ <refentrytitle>network-zone</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> for details.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>port ...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Configure a port or show status information.
+ See <citerefentry>
+ <refentrytitle>network-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> for details.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>device ...</command>
+ </term>
+
+ <listitem>
+ <para>
+ Show status information about network devices.
+ See <citerefentry>
+ <refentrytitle>network-device</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> for details.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>config <replaceable><varname>KEY=VALUE</varname></replaceable></command>
+ </term>
+
+ <listitem>
+ <para>
+ Shows and alters global configuration parameters.
+ See <citerefentry>
+ <refentrytitle>network-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> for details.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>help [<replaceable>TYPE</replaceable> <replaceable>HOOK</replaceable>]</command>
+ </term>
+
+ <listitem>
+ <para>
+ Calling <command>network help</command> without any
+ arguments will show you this man page.
+ </para>
+ <para>
+ You may optionally pass two arguments, to view the help
+ of a certain hook.
+ The type of the hook <replaceable>TYPE</replaceable>
+ needs to be passed as well as the name of the hook
+ <replaceable>HOOK</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>hostname <replaceable>HOSTNAME</replaceable></command>
+ </term>
+
+ <listitem>
+ <para>
+ The <command>hostname</command> command will return the
+ currently configured hostname of the system.
+ </para>
+ <para>
+ If a new hostname is added to the command line,
+ it will be configured, but will be set after the next
+ reboot.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>dns-server ...</command>
+ </term>
+
+ <listitem>
+ <para>
+ The <command>dns-server</command> command will help you
+ configuring the local DNS servers.
+ See <citerefentry>
+ <refentrytitle>network-dns-server</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> for details.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>reset</command>
+ </term>
+
+ <listitem>
+ <para>
+ The <command>reset</command> command will reset all
+ network configuration. That means all zone configurations
+ will be removed and there will be no networking after the
+ next reboot.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Exit Codes</title>
+
+ <para>
+ The <command>network</command> 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.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+
+ <para>
+ Please report all bugs to the official bugtracker at
+ http://bugs.ipfire.org/.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry>
+ <refentrytitle>network-config</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-device</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-dns-server</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-port</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>network-zone</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
projects / people / stevee / network.git / commitdiff
