doc: cleanup daemon option flags

Short and long form options can be written on the same line, Sphinx
understands how to cross-reference using either one of them. Also
replace some - with _ where appropriate.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2018-04-06 18:17:31 -04:00
parent 8227cf9333
commit c936589468
No known key found for this signature in database
GPG Key ID: DAF48E0F57E0834F
5 changed files with 15 additions and 31 deletions

View File

@ -358,13 +358,11 @@ Common Invocation Options
These options apply to all |PACKAGE_NAME| daemons. These options apply to all |PACKAGE_NAME| daemons.
.. option:: -d .. option:: -d, --daemon
.. option:: --daemon
Run in daemon mode. Run in daemon mode.
.. option:: -f <file> .. option:: -f, --config_file <file>
.. option:: --config-file <file>
Set configuration file name. Set configuration file name.
@ -372,8 +370,7 @@ These options apply to all |PACKAGE_NAME| daemons.
Display this help and exit. Display this help and exit.
.. option:: -i <file> .. option:: -i, --pid_file <file>
.. option:: --pid-file <file>
Upon startup the process identifier of the daemon is written to a file, Upon startup the process identifier of the daemon is written to a file,
typically in :file:`/var/run`. This file can be used by the init system typically in :file:`/var/run`. This file can be used by the init system
@ -386,25 +383,21 @@ These options apply to all |PACKAGE_NAME| daemons.
machine can be used to collect differing routing views from differing machine can be used to collect differing routing views from differing
points in the network. points in the network.
.. option:: -A <address> .. option:: -A, --vty_addr <address>
.. option:: --vty-addr <address>
Set the VTY local address to bind to. If set, the VTY socket will only Set the VTY local address to bind to. If set, the VTY socket will only
be bound to this address. be bound to this address.
.. option:: -P <port> .. option:: -P, --vty_port <port>
.. option:: --vty-port <port>
Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not
be opened. be opened.
.. option:: -u <user> .. option:: -u <user>
.. option:: --vty_addr <user>
Set the user and group to run as. Set the user and group to run as.
.. option:: -v .. option:: -v, --version
.. option:: --version
Print program version. Print program version.
@ -418,8 +411,7 @@ unloading modules at runtime is not supported (yet). To load a module, use
the following command line option at daemon startup: the following command line option at daemon startup:
.. option:: -M <module:options> .. option:: -M, --module <module:options>
.. option:: --module <module:options>
Load the specified module, optionally passing options to it. If the module Load the specified module, optionally passing options to it. If the module
name contains a slash (/), it is assumed to be a full pathname to a file to name contains a slash (/), it is assumed to be a full pathname to a file to

View File

@ -26,19 +26,16 @@ be specified (:ref:`common-invocation-options`).
.. program:: bgpd .. program:: bgpd
.. option:: -p <port> .. option:: -p, --bgp_port <port>
.. option:: --bgp_port <port>
Set the bgp protocol's port number. When port number is 0, that means do not Set the bgp protocol's port number. When port number is 0, that means do not
listen bgp port. listen bgp port.
.. option:: -r .. option:: -r, --retain
.. option:: --retain
When program terminates, retain BGP routes added by zebra. When program terminates, retain BGP routes added by zebra.
.. option:: -l .. option:: -l, --listenon
.. option:: --listenon
Specify a specific IP address for bgpd to listen on, rather than its Specify a specific IP address for bgpd to listen on, rather than its
default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd default of INADDR_ANY / IN6ADDR_ANY. This can be useful to constrain bgpd

View File

@ -60,8 +60,7 @@ Certain signals have special meanings to *eigrpd*.
.. program:: eigrpd .. program:: eigrpd
.. option:: -r .. option:: -r, --retain
.. option:: --retain
When the program terminates, retain routes added by *eigrpd*. When the program terminates, retain routes added by *eigrpd*.

View File

@ -60,8 +60,7 @@ Certain signals have special meaningss to *ripd*.
*ripd* invocation options. Common options that can be specified *ripd* invocation options. Common options that can be specified
(:ref:`common-invocation-options`). (:ref:`common-invocation-options`).
.. option:: -r .. option:: -r, --retain
.. option:: --retain
When the program terminates, retain routes added by *ripd*. When the program terminates, retain routes added by *ripd*.

View File

@ -18,19 +18,16 @@ Besides the common invocation options (:ref:`common-invocation-options`), the
.. program:: zebra .. program:: zebra
.. option:: -b .. option:: -b, --batch
.. option:: --batch
Runs in batch mode. *zebra* parses configuration file and terminates Runs in batch mode. *zebra* parses configuration file and terminates
immediately. immediately.
.. option:: -k .. option:: -k, --keep_kernel
.. option:: --keep_kernel
When zebra starts up, don't delete old self inserted routes. When zebra starts up, don't delete old self inserted routes.
.. option:: -r .. option:: -r, --retain
.. option:: --retain
When program terminates, retain routes added by zebra. When program terminates, retain routes added by zebra.