From d715390e9b1c4cc72bd22b915a842acc96912108 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 31 Mar 2019 15:34:19 +0200 Subject: [PATCH] man: Convert network-route-static(8) to asciidoc Signed-off-by: Michael Tremer --- man/network-route-static.txt | 69 +++++++++++++ man/network-route-static.xml | 183 ----------------------------------- 2 files changed, 69 insertions(+), 183 deletions(-) create mode 100644 man/network-route-static.txt delete mode 100644 man/network-route-static.xml diff --git a/man/network-route-static.txt b/man/network-route-static.txt new file mode 100644 index 00000000..d4774b2a --- /dev/null +++ b/man/network-route-static.txt @@ -0,0 +1,69 @@ += network-route-static(8) +Michael Tremer + +== 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] diff --git a/man/network-route-static.xml b/man/network-route-static.xml deleted file mode 100644 index d43eb628..00000000 --- a/man/network-route-static.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - network-route-static - network - - - - Developer - Michael - Tremer - michael.tremer@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 - - - - -- 2.39.2