From 7068f09f1795d85456e3683f6fb76c69fc548d81 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Wed, 16 Mar 2016 22:25:21 +0000 Subject: [PATCH] docs: Add network-port man page Signed-off-by: Michael Tremer --- man/network-port.xml | 212 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 man/network-port.xml diff --git a/man/network-port.xml b/man/network-port.xml new file mode 100644 index 00000000..181bd8c6 --- /dev/null +++ b/man/network-port.xml @@ -0,0 +1,212 @@ + + + + + + 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 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