--- /dev/null
+= network-route-static(8)
+Michael Tremer <michael.tremer@ipfire.org>
+
+== NAME
+network-route - Manage Static Routing
+
+== SYNOPSIS
+[verse]
+'network route static' COMMAND ...
+'network route static add' NETWORK [--gateway=GATEWAY,--unreachable,--prohibit,--blackhole] [--mtu=MTU]
+'network route static remove' NETWORK
+'network route static list' [--protocol=ipv6|ipv4]
+
+== DESCRIPTION
+This command helps to manage routes.
+
+== COMMANDS
+The following commands are understood:
+
+'add' NETWORK ...::
+ A new route may be added by the 'add' command. It is required to pass a
+ valid network prefix NETWORK, which can be either IPv6 or IPv4.
+ +
+ For unicast routes, the '--gateway=GATEWAY' option must be passed, where
+ GATEWAY is a valid IP address of the same protocol type as the network
+ prefix is.
+ +
+ Use '--unreachable', '--prohibit', '--blackhole' can be used to create of
+ that type. See ROUTE TYPES below for more information about these options.
+ +
+ The optional '--mtu=MTU' 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 this command.
+ +
+ NETWORK is the network prefix of an existing route.
+
+'list'::
+ Shows a list of all configured routes.
+ +
+ Output can be filtered by passing --protocol=[ipv6|ipv4].
+
+== ROUTE TYPES
+
+[horizontal]
+'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 '--gateway=GATEWAY' 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
+link:network[8],
+link:network-route[8],
+link:ip-route[8]
+++ /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-static">
- <refentryinfo>
- <title>network-route-static</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-static</refentrytitle>
- <manvolnum>8</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>network-route-static</refname>
- <refpurpose>Network Configuration Control Program</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>network route static <arg choice="plain">COMMAND</arg></command>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
-
- <para>
- The <command>route static</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>network-route</refentrytitle>
- <manvolnum>8</manvolnum>
- </citerefentry>,
- <citerefentry>
- <refentrytitle>ip-route</refentrytitle>
- <manvolnum>8</manvolnum>
- </citerefentry>
- </para>
- </refsect1>
-</refentry>