From: Michael Tremer Date: Mon, 1 Apr 2019 17:49:01 +0000 (+0200) Subject: man: Make syntax format more similar across files X-Git-Url: http://git.ipfire.org/?p=people%2Fms%2Fnetwork.git;a=commitdiff_plain;h=39cfece88a2978f946e1713fbf1e2be3faf124d6 man: Make syntax format more similar across files Signed-off-by: Michael Tremer --- diff --git a/man/firewall-settings.txt b/man/firewall-settings.txt index 20038e39..81c9bd95 100644 --- a/man/firewall-settings.txt +++ b/man/firewall-settings.txt @@ -1,30 +1,25 @@ -firewall-settings(8) -==================== += firewall-settings(8) -NAME ----- +== NAME firewall-settings - Global firewall settings -SYNOPSIS --------- +== SYNOPSIS [verse] -'firewall settings' -'firewall settings' KEY=VALUE ... +`firewall settings` +`firewall settings` KEY=VALUE ... -DESCRIPTION ------------ +== DESCRIPTION This command is used to set global firewall settings. Please have a look at the individual man pages for more options. -COMMANDS --------- +== COMMANDS If no argument is given, the configuration will be dumped to the console. You may set a new value by adding the variable name and the new value to the command line. -SETTINGS --------- +== SETTINGS + === CONNTRACK_MAX_CONNECTIONS = 16384 Limits the max. number of simultaneous connections. @@ -88,10 +83,8 @@ Some routers on the Internet still do not support ECN properly. When this setting is disabled, ECN is only advertised when asked for. -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:firewall[8] diff --git a/man/network-device.txt b/man/network-device.txt index 4f1c1b00..d70536ea 100644 --- a/man/network-device.txt +++ b/man/network-device.txt @@ -1,61 +1,54 @@ -network-device(8) -================= += network-device(8) -NAME ----- +== NAME network-device - Controls network devices -SYNOPSIS --------- +== SYNOPSIS [verse] -'network device' [] ... +`network device` COMMAND ... -DESCRIPTION ------------ -The 'network device' command shows low-level status information +== DESCRIPTION +The `network device` command shows low-level status information of network devices and other things. -COMMANDS --------- +== COMMANDS The following commands are understood: -'list':: +`list`:: This command shows a list of all device that are currently present on this system. This includes PHYs and serial devices as well. -'DEVICE discover':: +`DEVICE discover`:: Runs a discovery for many hooks on the given device. This will check if the hook can find for example a DHCP server or DSLAM and thus predict for what the device should be used. -'DEVICE identify':: +`DEVICE identify`:: This command only works for Ethernet adapters and will make those that support this feature flash for a few seconds. It is handy to find the right device to put the cable in. -'DEVICE monitor':: +`DEVICE monitor`:: This command creates a monitor interface for wireless modules. An instance of link:tcpdump[8] will be started and show all frames that are sent or received on the 802.11 layer (layer 2). -'DEVICE status':: +`DEVICE status`:: This will show you very detailed information about the given device. -'DEVICE unlock':: +`DEVICE unlock`:: This command will unlock the SIM card in a modem. Only serial devices are supported which are the most 4G or 3G modems. For the PIN or PUK code, the user will be prompted. -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8] link:network-port[8] link:network-zone[8] diff --git a/man/network-dhcp.txt b/man/network-dhcp.txt index bcb768ed..11e5fb4a 100644 --- a/man/network-dhcp.txt +++ b/man/network-dhcp.txt @@ -1,44 +1,37 @@ -network-dhcp(8) -=============== += network-dhcp(8) -NAME ----- +== NAME network-dhcp - Controls the DHCP Server -SYNOPSIS --------- +== SYNOPSIS [verse] -'network dhcpv6' ... -'network dhcpv4' ... +`network dhcpv6` COMMAND ... +`network dhcpv4` COMMAND ... -DESCRIPTION ------------ +== DESCRIPTION With help of the DHCP commands it is possible to configure DHCP servers for IPv6 and IPv4. -COMMANDS --------- +== COMMANDS The following commands are understood: -'start':: +`start`:: Starts the DHCP server. -'stop':: +`stop`:: Stops the DHCP server. -'restart':: +`restart`:: Restarts the DHCP server. -'reload':: +`reload`:: Reload the DHCP server configuration. -'subnet ...':: +`subnet ...`:: TODO -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8] diff --git a/man/network-dns-server.txt b/man/network-dns-server.txt index bd01ca71..f5019cec 100644 --- a/man/network-dns-server.txt +++ b/man/network-dns-server.txt @@ -1,75 +1,67 @@ -network-dns-server(8) -===================== += network-dns-server(8) -NAME ----- +== NAME network-dns-server - Controls the DNS settings -SYNOPSIS --------- +== SYNOPSIS [verse] -'network dns-server' add SERVER [PRIORITY] -'network dns-server' remove SERVER -'network dns-server' list -'network dns-server' update +`network dns-server add` SERVER [PRIORITY] +`network dns-server remove` SERVER +`network dns-server list` +`network dns-server update` -DESCRIPTION ------------ +== DESCRIPTION With this command, you will be able to configure the local DNS configuration. You may add and remove DNS servers as well as view the settings. -COMMANDS --------- +== COMMANDS The following commands are understood: -'add' SERVER [PRIORITY]:: +`add SERVER [PRIORITY]`:: A new DNS server may be added to the list by the 'add' command. A priority that will rank the server my optionally be given. - + + NOTE: SERVER must be a valid IP address and PRIORITY must be a positive number. The smaller this number, the higher is is the rank of the server. -'remove' SERVER:: +`remove SERVER`:: The given server will be removed from the list of DNS servers. -'list':: +`list`:: Shows a list of all servers that are currently in use. -'update':: +`update`:: This command will re-create the system's configuration files. It should not be required to use this command very often. -SETTINGS --------- +== SETTINGS The following settings may be set using link:network-settings[8]: -'DNS_USE_LOCAL_RESOLVER = [true|false]':: +`DNS_USE_LOCAL_RESOLVER = [true|false]`:: This option defines whether the local DNS resolver should be used or not. - + + Basically, the option adds localhost to the list of nameservers in link:resolv.conf[5]. -'DNS_SEARCH_DOMAINS =':: +`DNS_SEARCH_DOMAINS =`:: This setting configures the search domains for DNS queries made by the local system. -'DNS_RANDOMIZE = [true|false]':: +`DNS_RANDOMIZE = [true|false]`:: This option will break the DNS server ranks and will query them in a random order which is useful to load-balance multiple DNS servers. -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8], link:network-settings[8] diff --git a/man/network-performance-tuning.txt b/man/network-performance-tuning.txt index 763ee21c..4672bbca 100644 --- a/man/network-performance-tuning.txt +++ b/man/network-performance-tuning.txt @@ -1,12 +1,9 @@ -network-performance-tuning(8) -============================= += network-performance-tuning(8) -NAME ----- +== NAME network-performance-tuning - Performance Tuning for Networking -DESCRIPTION ------------ +== DESCRIPTION This page contains a summary of some performance tuning techniques that this system is using. @@ -22,12 +19,10 @@ reducing network latency and quite possibly increasing throughput. The algorithm is trying to balance all network controllers across all processors. -See /proc/interrups for the distribution of interrupts. +See /proc/interrupts for the distribution of interrupts. -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8] diff --git a/man/network-port.txt b/man/network-port.txt index 0c26f334..54cd58c3 100644 --- a/man/network-port.txt +++ b/man/network-port.txt @@ -1,29 +1,25 @@ -network-port(8) -=============== += network-port(8) -NAME ----- +== NAME network-port - Controls Network Ports -SYNOPSIS --------- +== SYNOPSIS [verse] -'network port' new HOOK ... -'network port' destroy PORT -'network port' PORT color set -'network port' PORT color reset -'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 ------------ +`network port new HOOK ...` +`network port destroy PORT` +`network port PORT color set COLOR` +`network port PORT color reset` +`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. @@ -32,15 +28,14 @@ to an other network. It connects those and zones together. The 'network device' command shows status information of network devices and other things. -COMMANDS --------- +== COMMANDS The following commands are understood: -'new' HOOK ...:: +`new HOOK ...`:: A new port may be created with this command. HOOK must be a valid hook which may require more options. -'destroy' PORT:: +`destroy PORT`:: Destroys the port PORT. The port is removed from any zones it is attached to and shut down. @@ -48,49 +43,47 @@ For all other commands, the name of the port needs to be passed first: include::include-color.txt[] -'create':: +`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. + + + The interface is not brought up. Use the `up` command to do that. include::include-description.txt[] -'down':: +`down`:: Shuts down the port. -'edit':: +`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':: +`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':: +`remove`:: This will remove an existing PORT. - + + This does not destroy the port. It inverses the operation performed by the 'create' command. -'status':: +`status`:: This will show some detailed information about the status of the specified port. -'up':: +`up`:: Brings up the port. It has to be created first. -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8], link:network-zone[8] diff --git a/man/network-quick-start.txt b/man/network-quick-start.txt index 02ebfe04..1ab58665 100644 --- a/man/network-quick-start.txt +++ b/man/network-quick-start.txt @@ -1,12 +1,9 @@ -network-quick-start(8) -====================== += network-quick-start(8) -NAME ----- +== NAME network-quick-start - Quick Start Guide for Networking -DESCRIPTION ------------ +== DESCRIPTION The link:network[8] is a very powerful command that allows you to configure the entire networking stack. Unfortunately that makes it quite complicated to use as well. @@ -80,12 +77,10 @@ The entire network can be restarted by running: # network restart ------------ -AUTHORS -------- +== AUTHORS Michael Tremer -SEE ALSO --------- +== SEE ALSO link:network[8], link:network-device[8], link:network-port[8], diff --git a/man/network-route-static.txt b/man/network-route-static.txt index 4ba97eb7..43a12779 100644 --- a/man/network-route-static.txt +++ b/man/network-route-static.txt @@ -5,10 +5,10 @@ network-route-static - Manage Static Routing == SYNOPSIS [verse] -'network route static' COMMAND ... -'network route static add' NETWORK [--gateway=GATEWAY,--unreachable,--prohibit,--blackhole] [--mtu=MTU] -'network route static remove' NETWORK -'network route static list' [--protocol=ipv6|ipv4] +`network route static COMMAND ...` +`network route static add NETWORK [--gateway=GATEWAY,--unreachable,--prohibit,--blackhole] [--mtu=MTU]` +`network route static remove NETWORK` +`network route static list` [--protocol=ipv6|ipv4]` == DESCRIPTION This command helps to manage routes. @@ -20,14 +20,14 @@ The following commands are understood: A new route may be added by the 'add' command. It is required to pass a valid network prefix NETWORK, which can be either IPv6 or IPv4. + - For unicast routes, the '--gateway=GATEWAY' option must be passed, where + For unicast routes, the `--gateway=GATEWAY` option must be passed, where GATEWAY is a valid IP address of the same protocol type as the network prefix is. + - Use '--unreachable', '--prohibit', '--blackhole' can be used to create of + Use `--unreachable`, `--prohibit`, `--blackhole` can be used to create of that type. See ROUTE TYPES below for more information about these options. + - The optional '--mtu=MTU' parameter defines the MTU along the path to the + The optional `--mtu=MTU` parameter defines the MTU along the path to the destination and must be an integer number. This will show you very detailed information about the given device. @@ -39,7 +39,7 @@ The following commands are understood: 'list':: Shows a list of all configured routes. + - Output can be filtered by passing --protocol=[ipv6|ipv4]. + Output can be filtered by passing `--protocol=[ipv6|ipv4]`. == ROUTE TYPES @@ -47,7 +47,7 @@ The following commands are understood: 'unicast':: A unicast route is the most common route in routing tables. It is a route to a destination network address, which describes the path to the destination. - Use the '--gateway=GATEWAY' option to create such a route. + Use the `--gateway=GATEWAY` option to create such a route. 'unreachable':: When a route is determined and the routing decision process returns a