From 357723e90cb0f700c4315b6016543db4230df5fb Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 31 Mar 2019 16:46:07 +0200 Subject: [PATCH] man: Convert network-zone(8) to asciidoc Signed-off-by: Michael Tremer --- man/include-color.txt | 2 +- man/include-description.txt | 2 +- man/network-zone.txt | 73 +++++++++++ man/network-zone.xml | 247 ------------------------------------ 4 files changed, 75 insertions(+), 249 deletions(-) create mode 100644 man/network-zone.txt delete mode 100644 man/network-zone.xml diff --git a/man/include-color.txt b/man/include-color.txt index 073c01b7..4b417a52 100644 --- a/man/include-color.txt +++ b/man/include-color.txt @@ -1,7 +1,7 @@ 'color set ':: The color is set with this command and required to be passed in RGB hex formatting - + + NOTE: The color is being used to make identification of network devices easier on the command line and web user interface. diff --git a/man/include-description.txt b/man/include-description.txt index a39ba55c..49bac64d 100644 --- a/man/include-description.txt +++ b/man/include-description.txt @@ -1,6 +1,6 @@ 'description edit':: This command opens an editor and allows you to edit title and description. - + + NOTE: The formation of the description is similar to a git commit. Every description has a title, the first line of the description. The title is shown on the status page and in the web user interface. diff --git a/man/network-zone.txt b/man/network-zone.txt new file mode 100644 index 00000000..88a19889 --- /dev/null +++ b/man/network-zone.txt @@ -0,0 +1,73 @@ += network-zone(8) +Michael Tremer + +== NAME +network-zone - Manage network zones + +== SYNOPSIS +[verse] +'network zone [new|destroy]' ZONE +'network zone' ZONE ... + +== DESCRIPTION +With help of the 'zone' command, it is very easy to configure network zones. + +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. + +== COMMANDS +The following commands are understood: + +'new ZONE HOOK OPTIONS':: + A new zone may be created by the 'create' command. + There are at least two arguments required. + + + ZONE must be valid name for a zone which does not already exist. + HOOK is a valid zone hook which may require additional options. + +'destroy ZONE':: + A zone can be destroyed with this command. + + + 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. + +For all other commands, the name of the zone needs to be passed first: + +'edit OPTIONS':: + 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 'network zone ZONE edit --help' to learn more about that. + + + It usually is required to restart/reload the zone until the new settings + are taken into account. + +'[up|down]':: + 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. + +'[enable|disable]':: + These commands will enable or disable the zone. An enabled zone will + automatically be started either during the boot process or a hotplug event + of an associated port or other device. + +'status':: + This will show some detailed information about the state if the specified zone. + +include::include-color.txt[] + +include::include-description.txt[] + +'identify':: + This command will make all ports of the zone flash for a few seconds so + that you can identify the correct network adapters in the system. + +'rename' NAME:: + Renames the zone to NAME. + + + The command will shut down the zone if it is up and start it again with + the new name. If the zone is not up it won't be started. + +== SEE ALSO +link:network[8] diff --git a/man/network-zone.xml b/man/network-zone.xml deleted file mode 100644 index 99fa8b83..00000000 --- a/man/network-zone.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - network-zone - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network-zone - 8 - - - - network-zone - Network Configuration Control Program - - - - - network zone [new|destroy] ZONE ... - - - - network zone ZONE command ... - - - - - Description - - - With help of the zone command, it is very easy to - configure network zones. - - - 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. - - - - - Commands - - - The following commands are understood: - - - - - - new ZONE HOOK OPTIONS - - - - - A new zone may be created by the create - command. There are at least two arguments required. - - - ZONE must be valid name for a - zone which does not already exist. - HOOK is a valid zone hook which - may require additional options. - - - - - - - destroy ZONE - - - - - A zone can be destroyed with this command. - - - 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. - - - - - - - For all other commands, the name of the zone needs to be passed first: - - - - - - ZONE edit OPTIONS - - - - - 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 network zone ZONE edit --help - to learn more about that. - - - It usually is required to restart/reload the zone until - the new settings are taken into account. - - - - - - - ZONE [up|down] - - - - - 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. - - - - - - - ZONE [enable|disable] - - - - - These commands will enable or disable the zone. An enabled - zone will automatically be started either during the boot process - or a hotplug event of an associated port or other device. - - - - - - - ZONE status - - - - - This will show some detailed information about the state - if the specified zone. - - - - - - ZONE color - - - - - This command allows settings a color for a zone. - See - - network-color - 8 - - for more information. - - - - - - ZONEdescription - - - - - This command make is possible to add a description to a zone. - See - - network-description - 8, - - for more information. - - - - - - ZONE identify - - - - - This command will make all ports of the zone flash for - a few seconds so that you can identify the correct network - adapters in the system. - - - - - - - ZONE rename NAME - - - - - Renames the zone to NAME. - - - The command will shut down the zone if it is up and - start it again with the new name. If the zone is not - up it won't be started. - - - Zones that are marked to be destroyed cannot be renamed. - - - - - - - - See Also - - - - network - 8 - - - - -- 2.39.2