From 010f24cfc6e363815ae6a408a16e8b07c069c1a7 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 31 Mar 2019 16:59:10 +0200 Subject: [PATCH] man: Convert network-zone-bridge(8) to asciidoc Signed-off-by: Michael Tremer --- man/network-zone-bridge.txt | 55 ++++++++++++ man/network-zone-bridge.xml | 172 ------------------------------------ 2 files changed, 55 insertions(+), 172 deletions(-) create mode 100644 man/network-zone-bridge.txt delete mode 100644 man/network-zone-bridge.xml diff --git a/man/network-zone-bridge.txt b/man/network-zone-bridge.txt new file mode 100644 index 00000000..2e4f839b --- /dev/null +++ b/man/network-zone-bridge.txt @@ -0,0 +1,55 @@ += network-zone-bridge(8) +Michael Tremer + +== NAME +network-zone-bridge - Manage network zones + +== SYNOPSIS +[verse] +'network zone new 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 physical network interfaces or virtual +devices which will be connected to each other. + +The bridge hook is the preferred hook for local area network zones which are +connected to an ethernet network. + +== OPTIONS +The following options are understood: + +'--address=ADDRESS':: + By this option, you may define the MAC address of the bridge. If this option + is missing, a random MAC address will be generated. + +'--mtu=MTU':: + Sets the default MTU of the bridge. + All ports in the bridge must support this MTU value. + +'--stp=[_on_|off]':: + This option enables or disables 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. + +Spanning Tree Protocol (802.1D) configuration options: + +'--stp-forward-delay=_0_':: + This sets the default time the interfaces are hold off after they have been + added to a bridge. The default value is 0. + +'--stp-hello=_2_':: + This option defines how often a hello message should be sent. The value is + given in seconds and the default is 2. + +'--stp-priority=512':: + 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 +link:network[8], +link:network-zone[8] diff --git a/man/network-zone-bridge.xml b/man/network-zone-bridge.xml deleted file mode 100644 index a77118bc..00000000 --- a/man/network-zone-bridge.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - network-zone-bridge - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network-zone-bridge - 8 - - - - network-zone-bridge - Network Configuration Control Program - - - - - network zone new 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 (802.1D) configuration options: - - - - - - - - - - - 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 - - - - -- 2.39.2