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>

5 files changed, 15 insertions, 31 deletions

diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index 29d05abba..a0c53aaf0 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -358,13 +358,11 @@ Common Invocation Options
 These options apply to all |PACKAGE_NAME| daemons.
 
 
-.. option:: -d
-.. option:: --daemon
+.. option:: -d, --daemon
 
    Run in daemon mode.
 
-.. option:: -f <file>
-.. option:: --config-file <file>
+.. option:: -f, --config_file <file>
 
    Set configuration file name.
 
@@ -372,8 +370,7 @@ These options apply to all |PACKAGE_NAME| daemons.
 
    Display this help and exit.
 
-.. option:: -i <file>
-.. option:: --pid-file <file>
+.. option:: -i, --pid_file <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
@@ -386,25 +383,21 @@ These options apply to all |PACKAGE_NAME| daemons.
    machine can be used to collect differing routing views from differing
    points in the network.
 
-.. option:: -A <address>
-.. option:: --vty-addr <address>
+.. option:: -A, --vty_addr <address>
 
    Set the VTY local address to bind to. If set, the VTY socket will only
    be bound to this address.
 
-.. option:: -P <port>
-.. option:: --vty-port <port>
+.. option:: -P, --vty_port <port>
 
    Set the VTY TCP port number. If set to 0 then the TCP VTY sockets will not
    be opened.
 
 .. option:: -u <user>
-.. option:: --vty_addr <user>
 
    Set the user and group to run as.
 
-.. option:: -v
-.. option:: --version
+.. option:: -v, --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:
 
 
-.. option:: -M <module:options>
-.. option:: --module <module:options>
+.. option:: -M, --module <module:options>
 
    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
diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index 7a508b0df..241405950 100644
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -26,19 +26,16 @@ be specified (:ref:`common-invocation-options`).
 
 .. program:: bgpd
 
-.. option:: -p <port>
-.. option:: --bgp_port <port>
+.. option:: -p, --bgp_port <port>
 
    Set the bgp protocol's port number. When port number is 0, that means do not
    listen bgp port.
 
-.. option:: -r
-.. option:: --retain
+.. option:: -r, --retain
 
    When program terminates, retain BGP routes added by zebra.
 
-.. option:: -l
-.. option:: --listenon
+.. option:: -l, --listenon
 
    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
diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst
index 309ee27cc..95c3a17ae 100644
--- a/doc/user/eigrpd.rst
+++ b/doc/user/eigrpd.rst
@@ -60,8 +60,7 @@ Certain signals have special meanings to *eigrpd*.
 
 .. program:: eigrpd
 
-.. option:: -r
-.. option:: --retain
+.. option:: -r, --retain
 
    When the program terminates, retain routes added by *eigrpd*.
 
diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst
index b8cbd161c..0609c8d61 100644
--- a/doc/user/ripd.rst
+++ b/doc/user/ripd.rst
@@ -60,8 +60,7 @@ Certain signals have special meaningss to *ripd*.
 *ripd* invocation options. Common options that can be specified
 (:ref:`common-invocation-options`).
 
-.. option:: -r
-.. option:: --retain
+.. option:: -r, --retain
 
    When the program terminates, retain routes added by *ripd*.
 
diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index 70a69cf0d..9928ab012 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -18,19 +18,16 @@ Besides the common invocation options (:ref:`common-invocation-options`), the
 
 .. program:: zebra
 
-.. option:: -b
-.. option:: --batch
+.. option:: -b, --batch
 
    Runs in batch mode. *zebra* parses configuration file and terminates
    immediately.
 
-.. option:: -k
-.. option:: --keep_kernel
+.. option:: -k, --keep_kernel
 
    When zebra starts up, don't delete old self inserted routes.
 
-.. option:: -r
-.. option:: --retain
+.. option:: -r, --retain
 
    When program terminates, retain routes added by zebra.