From 065346332054e3b2be85bee3f6d71a3dc34d6275 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 30 Sep 2018 22:27:40 +0200 Subject: [PATCH] man: Convert network-port(8) to asciidoc Signed-off-by: Michael Tremer --- man/network-port.txt | 97 +++++++++++++++++ man/network-port.xml | 245 ------------------------------------------- 2 files changed, 97 insertions(+), 245 deletions(-) create mode 100644 man/network-port.txt delete mode 100644 man/network-port.xml diff --git a/man/network-port.txt b/man/network-port.txt new file mode 100644 index 00000000..08b9e90e --- /dev/null +++ b/man/network-port.txt @@ -0,0 +1,97 @@ +network-port(8) +=============== + +NAME +---- +network-port - Controls Network Ports + +SYNOPSIS +-------- +[verse] +'network port' new HOOK ... +'network port' destroy PORT +'network port' PORT color +'network port' PORT create +'network port' PORT description edit +'network port' PORT description show +'network port' PORT down +'network port' PORT edit ... +'network port' PORT identify +'network port' PORT remove +'network port' PORT status +'network port' PORT up + +DESCRIPTION +----------- +This command creates, deletes, changes and views the configuration +and status of ports. + +NOTE: A port is a physical or virtual device that is directly connected +to an other network. It connects those and zones together. +The 'network device' command shows status information of network devices +and other things. + +COMMANDS +-------- +The following commands are understood: + +'new' HOOK ...:: + A new port may be created with this command. + HOOK must be a valid hook which may require more options. + +'destroy' PORT:: + Destroys the port PORT. + The port is removed from any zones it is attached to and shut down. + +For all other commands, the name of the port needs to be passed first: + +'color':: + This command allows settings a color for a port. + See link:network-color[8] for more information. + +'create':: + This will create devices for the existing port PORT. + + This does not create a new port. It will just create the (possibly + virtual) interface this port (i.e. create an interface for a WiFi + module or a VLAN device). + + The interface is not brought up. Use the 'up' command to do that. + +include::include-description.txt[] + +'down':: + Shuts down the port. + +'edit':: + This command can be used to alter the configuration of a port. + Consult the documentation of the port hook to find out what is supported. + +'identify':: + This command will make the port flash for a few seconds + so that you can identify the correct network adapters + in the system. + + This is not supported by all network adapters. + +'remove':: + This will remove an existing PORT. + + This does not destroy the port. It inverses the operation performed + by the 'create' command. + +'status':: + This will show some detailed information about the status + of the specified port. + +'up':: + Brings up the port. It has to be created first. + +AUTHORS +------- +Michael Tremer + +SEE ALSO +-------- +link:network[8], +link:network-zone[8] diff --git a/man/network-port.xml b/man/network-port.xml deleted file mode 100644 index 5c0a8ae3..00000000 --- a/man/network-port.xml +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - network-port - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network-port - 8 - - - - network-port - Network Configuration Control Program - - - - - network port [new|destroy] PORT ... - - - - network port PORT command ... - - - - - Description - - - With help of the port command, you can create, delete, - change and view the configuration and status of ports. - - - - A port is a physical or virtual device that is directly connected - to an other network. If connects those and zones together. - - - - - Commands - - - The following commands are understood: - - - - - - new HOOK ARGUMENTS - - - - - A new port may be created by the new - command. - - - HOOK must be a valid - hook which may require more ARGUMENTS. - - - - - - - destroy PORT - - - - - A port can be destroyed with this command. - - - The port is removed from any zones it is attached - to and shut down. - - - - - - - For all other commands, the name of the port needs to be passed first: - - - - - - PORT create - - - - - This will create an existing PORT. - - - This does not create a new port. It will just create the (possibly - virtual) interface this port (i.e. create an interface for a WiFi - module or a VLAN device). - - - The interface is not brought up. Use the up command - to do that. - - - - - - - PORT remove - - - - - This will remove an existing PORT. - - - This does not destroy the port. It inverses the operation performed - by the create command. - - - - - - - PORT [up|down] - - - - - These commands will bring the port up or down. It has to be - created first. - - - - - - PORT color - - - - - This command allows settings a color for a port. - See - - network-color - 8 - - for more information. - - - - - - PORTdescription - - - - - This command allows you to add a description to a port. - See - - network-description - 8, - - for more information. - - - - - - PORT edit ARGUMENTS - - - - - The edit command can be used to alter - the configuration of a port. Consult the documentation of the - port hook to find out which ARGUMENTS - are supported. - - - - - - - PORT status - - - - - This will show some detailed information about the state - if the specified port. - - - - - - - PORT identify - - - - - This command will make the port flash for a few seconds - so that you can identify the correct network adapters - in the system. - - - This is not supported by all network adapters. - - - - - - - - See Also - - - - network - 8, - - - network-zone - 8 - - - - -- 2.39.2