This patch updates the documentation to follow the change from route to route static. The network-route manpage is now a generical one wich just list which types of routes we support like static or later dynamic. In the network-route-static are the explanation for static routes. This documents represents the previous network-route manpage . Signed-off-by: Jonatan Schlag --- Makefile.am | 1 + man/network-route-static.xml | 183 +++++++++++++++++++++++++++++++++++++++++++ man/network-route.xml | 108 +++---------------------- 3 files changed, 197 insertions(+), 95 deletions(-) create mode 100644 man/network-route-static.xml diff --git a/Makefile.am b/Makefile.am index acf5a71..15a98e6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -340,6 +340,7 @@ MANPAGES = \ man/network-port-batman-adv-port.8 \ man/network-quick-start.8 \ man/network-route.8 \ + man/network-route-static.8 man/network-settings.8 \ man/network-zone.8 \ man/network-zone-6to4-tunnel.8 \ diff --git a/man/network-route-static.xml b/man/network-route-static.xml new file mode 100644 index 0000000..d43eb62 --- /dev/null +++ b/man/network-route-static.xml @@ -0,0 +1,183 @@ + + + + + + network-route-static + network + + + + Developer + Michael + Tremer + michael.tremer(a)ipfire.org + + + + + + network-route-static + 8 + + + + network-route-static + Network Configuration Control Program + + + + + network route static COMMAND + + + + + Description + + + The route static 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 + , + + network-route + 8 + , + + ip-route + 8 + + + + diff --git a/man/network-route.xml b/man/network-route.xml index cd49de7..207a5ce 100644 --- a/man/network-route.xml +++ b/man/network-route.xml @@ -37,7 +37,7 @@ Description - The route helps to manage static routes. + The route helps to manage routes. @@ -51,116 +51,34 @@ - add NETWORK [, , , ] [] + static - 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. + Static routes are managed by the static command + followed by the options for static routes which are described in: + + network-route-static + 8 + - - - - 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 + static - Packets matching this kind of route are silently discarded. - There will be no ICMP message sent to the source and no packet - be forwarded. + A static route is a route which does not change when the network changes. - + See Also @@ -171,7 +89,7 @@ 8 , - ip-route + network-route-static 8 -- 2.6.3