From 44d5ffe94daa496c95bf91860a5211272d8f3ff1 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Thu, 27 Sep 2018 00:25:12 +0200 Subject: [PATCH] man: Convert network(8) from docbook to asciidoc Signed-off-by: Michael Tremer --- man/network.txt | 107 ++++++++++++++ man/network.xml | 368 ------------------------------------------------ 2 files changed, 107 insertions(+), 368 deletions(-) create mode 100644 man/network.txt delete mode 100644 man/network.xml diff --git a/man/network.txt b/man/network.txt new file mode 100644 index 00000000..569449eb --- /dev/null +++ b/man/network.txt @@ -0,0 +1,107 @@ +network(8) +========== + +NAME +---- +network - IPFire Network Configuration Program + +SYNOPSIS +-------- +[verse] +'network' [] ... + +DESCRIPTION +----------- +The 'network' command is a tool which configures the network on every IPFire +system. It is a fast and versatile way to create, edit and remove configurations, +review the status of the network and it is working in the background of the +system make sure that things are running smoothly. + +OPTIONS +------- +-d:: +--debug:: + Enabled debugging mode. + In this mode, there wll be debug output on the console and written to + the log. + The debugging mode can be permanently enabled by setting 'DEBUG=1'. + +COMMANDS +-------- +The following commands are understood: + +'start' [ZONE]:: + Starts a zone. That means the zone is being created and brought up. + If one or more zones are passed to the command, only these will be + started. + +'stop' [ZONE]:: + Stops a zone. This is the inverse of the 'start' command. + +'restart' [ZONE]:: + Restarts a zone. + +'status' [ZONE]:: + Shows an overview of the status of the zone. + +'zone' ...:: + Commands to configure zones. See link:network-zone[8] for details. + +'port' ...:: + Commands to configure ports. See link:network-port[8] for details. + +'device' ...:: + See the status or execute commands to network devices. + See link:network-device[8] for details. + +'hostname' [HOSTNAME]:: + Without the optional 'HOSTNAME' argument, this command will print + the configured hostname. + Passing 'HOSTNAME' will set it as the new hostname. + +'settings' ...:: + Shows and alters global configuration parameters. + See link:network-settings[8] for details. + +'dns-server' ...:: + This command allows to configure DNS servers. + See link::network-dns-server[8] for details. + +'route' ...:: + This command allows managing static routes. + See link:network-route[8] for details. + +'vpn' ...:: + The command allows managing VPN connections. + See link:network-vpn[8] for details. + +'reset':: + This command will reset all network configuration. + All zones, ports and other settings will be removed. + +'help' ...:: + Shows this man page. + +EXIT CODES +---------- +The 'network' command will normally exit with code zero. +If there has been aproblem and the requested action could not be performed, +the exit code is unequal to zero. + +BUGS +---- +Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/. + +AUTHORS +------- +Michael Tremer + +SEE ALSO +-------- +link:network-settings[8] +link:network-device[8] +link:network-dns-server[8] +link:network-performance-tuning[8] +link:network-port[8] +link:network-quick-start[8] +link:network-zone[8] diff --git a/man/network.xml b/man/network.xml deleted file mode 100644 index 0a97453c..00000000 --- a/man/network.xml +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - network - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network - 8 - - - - network - Network Configuration Control Program - - - - - network - OPTIONS - COMMAND - - - - - Description - - - The network command is a tool which configures - the network on every IPFire system. It is a fast and versatile - way to create, edit and remove configurations, review the status - of the network and it is working in the background of the system - making sure that things are running smoothly. - - - - - Options - - - The following options are understood: - - - - - - - - - - - - - - Enables the debugging mode. - In this mode, there will be debug output on - the console and written to the log. - - - The debugging mode can be permanently enabled by setting - DEBUG=1 - - - - - - - - Commands - - - The following commands are understood: - - - - - - start ZONE-NAME... - - - - - Starts a zone. That means the network zone will be created - and brought up. - If one or more zone names are passed to the command, only - these will be started. - - - - - - - stop ZONE-NAME... - - - - - Stops a zone. This is the inverse of the start - command. - - - - - - - restart ZONE-NAME... - - - - - Restarts a zone. - - - - - - - status ZONE-NAME... - - - - - Shows a human-readable overview of the status - of the network zone. - - - - - - - zone ... - - - - - Configure a zone or show status information. - See - network-zone - 8 - for details. - - - - - - - port ... - - - - - Configure a port or show status information. - See - network-port - 8 - for details. - - - - - - - device ... - - - - - Show status information about network devices. - See - network-device - 8 - for details. - - - - - - - config KEY=VALUE - - - - - Shows and alters global configuration parameters. - See - network-settings - 8 - for details. - - - - - - - help [TYPE - HOOK|TYPE list-hooks] - - - - - Calling network help without any - arguments will show you this man page. - - - network help TYPE list-hooks - will print a list of all hooks of TYPE. - - - You may optionally pass two arguments, to view the help - of a certain hook. - The type of the hook TYPE - needs to be passed as well as the name of the hook - HOOK. - - - - - - - hostname HOSTNAME - - - - - The hostname command will return the - currently configured hostname of the system. - - - If a new hostname is added to the command line, - it will be configured, but will be set after the next - reboot. - - - - - - - dns-server ... - - - - - The dns-server command will help you - configuring the local DNS servers. - See - network-dns-server - 8 - for details. - - - - - - - route ... - - - - - The route command allows managing static routes. - See - network-route - 8 - for details. - - - - - - - vpn ... - - - - - The vpn allows managing VPN connections. - See - network-vpn - 8 - for details. - - - - - - - reset - - - - - The reset command will reset all - network configuration. That means all zone configurations - will be removed and there will be no networking after the - next reboot. - - - - - - - - Exit Codes - - - The network command will normally exit with code 0. - If there has been a problem and the requested action could not be done, - the exit code is unequal to zero. - - - - - Bugs - - - Please report all bugs to the official bugtracker at - http://bugs.ipfire.org/. - - - - - See Also - - - - network-settings - 8 - , - - network-device - 8 - , - - network-dns-server - 8 - , - - network-performance-tuning - 8 - , - - network-port - 8 - , - - network-quick-start - 8 - , - - network-zone - 8 - - - - -- 2.39.2