doc: fixup eigrpd.rst

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst
index d4f7e301b3dedebac9ce85457fbf4ec802b2493a..44af4a263dd7af1b410ec687495a86eb94320c39 100644 (file)
--- a/doc/user/eigrpd.rst
+++ b/doc/user/eigrpd.rst
@@ -5,7 +5,7 @@ EIGRP
 *****
 
 EIGRP -- Routing Information Protocol is widely deployed interior gateway
-routing protocol.  EIGRP was developed in the 1990's.  EIGRP is a
+routing protocol. EIGRP was developed in the 1990's. EIGRP is a
 @dfn{distance-vector} protocol and is based on the @dfn{dual} algorithms.
 As a distance-vector protocol, the EIGRP router send updates to its
 neighbors as networks change, thus allowing the convergence to a
@@ -19,14 +19,14 @@ Starting and Stopping eigrpd
 ============================
 
 The default configuration file name of *eigrpd*'s is
-:file:`eigrpd.conf`.  When invocation *eigrpd* searches directory
-|INSTALL_PREFIX_ETC|.  If :file:`eigrpd.conf` is not there next
-search current directory.  If an integrated config is specified
+:file:`eigrpd.conf`. When invocation *eigrpd* searches directory
+|INSTALL_PREFIX_ETC|. If :file:`eigrpd.conf` is not there next
+search current directory. If an integrated config is specified
 configuration is written into frr.conf
 
 The EIGRP protocol requires interface information
-maintained by *zebra* daemon.  So running *zebra*
-is mandatory to run *eigrpd*.  Thus minimum sequence for running
+maintained by *zebra* daemon. So running *zebra*
+is mandatory to run *eigrpd*. Thus minimum sequence for running
 EIGRP is like below:
 
 ::
@@ -37,63 +37,62 @@ EIGRP is like below:
 
 Please note that *zebra* must be invoked before *eigrpd*.
 
-To stop *eigrpd*.  Please use @command{kill `cat
-/var/run/eigrpd.pid`}.  Certain signals have special meanings to *eigrpd*.
+To stop *eigrpd*. Please use @command{kill `cat
+/var/run/eigrpd.pid`}. Certain signals have special meanings to *eigrpd*.
 
++------------------+-----------------------------------------------------------+
+| Signal           | Meaning                                                   |
++==================+===========================================================+
+| SIGHUP & SIGUSR1 | Rotate the log file                                       |
++------------------+-----------------------------------------------------------+
+| SIGINT & SIGTERM | Sweep all installed EIGRP routes and gracefully terminate |
++------------------+-----------------------------------------------------------+
 
 
-*SIGHUP*
-
-*SIGUSR1*
-  Rotate *eigrpd* Rotate the logfile.
-
-*SIGINT*
-
-*SIGTERM*
-  *eigrpd* sweeps all installed EIGRP routes then terminates properly.
-
-*eigrpd* invocation options.  Common options that can be specified
+*eigrpd* invocation options. Common options that can be specified
 (:ref:`Common_Invocation_Options`).
 
+.. program:: eigrpd
 
+.. option:: -r
+.. option:: --retain
 
-*-r*
-
-*--retain*
-  When the program terminates, retain routes added by *eigrpd*.
+   When the program terminates, retain routes added by *eigrpd*.
 
 .. _EIGRP_Configuration:
 
 EIGRP Configuration
 ===================
 
-.. index:: Command {router eigrp (1-65535)} {}
+.. index:: router eigrp (1-65535)
 
-Command {router eigrp (1-65535)} {}
-  The `router eigrp` command is necessary to enable EIGRP.  To disable
-  EIGRP, use the `no router eigrp (1-65535)` command.  EIGRP must be enabled before carrying out any of the EIGRP commands.
+``router eigrp (1-65535)``
+   The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP,
+   use the `no router eigrp (1-65535)` command. EIGRP must be enabled before
+   carrying out any of the EIGRP commands.
 
-.. index:: Command {no router eigrp (1-65535)} {}
+.. index:: no router eigrp (1-65535)
 
-Command {no router eigrp (1-65535)} {}
-  Disable EIGRP.
+``no router eigrp (1-65535)``
+   Disable EIGRP.
 
-.. index:: {EIGRP Command} {network `network`} {}
+.. index:: network NETWORK
 
-{EIGRP Command} {network `network`} {}
-.. index:: {EIGRP Command} {no network `network`} {}
+``network NETWORK``
+.. index:: no network NETWORK
 
-{EIGRP Command} {no network `network`} {}
-    Set the EIGRP enable interface by `network`.  The interfaces which
-    have addresses matching with `network` are enabled.
+``no network NETWORK``
+   Set the EIGRP enable interface by `network`. The interfaces which
+   have addresses matching with `network` are enabled.
 
-    This group of commands either enables or disables EIGRP interfaces between
-    certain numbers of a specified network address.  For example, if the
-    network for 10.0.0.0/24 is EIGRP enabled, this would result in all the
-    addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP.  The `no network` command will disable EIGRP for the specified network.
+   This group of commands either enables or disables EIGRP interfaces between
+   certain numbers of a specified network address. For example, if the
+   network for 10.0.0.0/24 is EIGRP enabled, this would result in all the
+   addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no
+   network` command will disable EIGRP for the specified network.
 
-  Below is very simple EIGRP configuration.  Interface `eth0` and
-  interface which address match to `10.0.0.0/8` are EIGRP enabled.
+   Below is very simple EIGRP configuration. Interface `eth0` and
+   interface which address match to `10.0.0.0/8` are EIGRP enabled.
 
 ::
 
@@ -105,89 +104,90 @@ Command {no router eigrp (1-65535)} {}
 
   Passive interface
 
-.. index:: {EIGRP command} {passive-interface (`IFNAME`|default)} {}
+.. index:: passive-interface (IFNAME|default)
 
-{EIGRP command} {passive-interface (`IFNAME`|default)} {}
-.. index:: {EIGRP command} {no passive-interface `IFNAME`} {}
+``passive-interface (IFNAME|default)``
+.. index:: no passive-interface IFNAME
 
-{EIGRP command} {no passive-interface `IFNAME`} {}
-      This command sets the specified interface to passive mode.  On passive mode
-      interface, all receiving packets are ignored and eigrpd does
-      not send either multicast or unicast EIGRP packets except to EIGRP neighbors
-      specified with `neighbor` command. The interface may be specified
-      as `default` to make eigrpd default to passive on all interfaces. 
+``no passive-interface IFNAME``
+   This command sets the specified interface to passive mode. On passive mode
+   interface, all receiving packets are ignored and eigrpd does
+   not send either multicast or unicast EIGRP packets except to EIGRP neighbors
+   specified with `neighbor` command. The interface may be specified
+   as `default` to make eigrpd default to passive on all interfaces. 
 
-      The default is to be passive on all interfaces.
+   The default is to be passive on all interfaces.
 
 .. _How_to_Announce_EIGRP_route:
 
 How to Announce EIGRP route
 ===========================
 
-.. index:: {EIGRP command} {redistribute kernel} {}
+.. index:: redistribute kernel
 
-{EIGRP command} {redistribute kernel} {}
-.. index:: {EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
+``redistribute kernel``
+.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 
-{EIGRP command} {redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
-.. index:: {EIGRP command} {no redistribute kernel} {}
+``redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)``
+.. index:: no redistribute kernel
 
-{EIGRP command} {no redistribute kernel} {}
-      `redistribute kernel` redistributes routing information from
-      kernel route entries into the EIGRP tables. `no redistribute kernel`
-      disables the routes.
+``no redistribute kernel``
+  `redistribute kernel` redistributes routing information from
+  kernel route entries into the EIGRP tables. `no redistribute kernel`
+  disables the routes.
 
-.. index:: {EIGRP command} {redistribute static} {}
+.. index:: redistribute static
 
-{EIGRP command} {redistribute static} {}
-.. index:: {EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
+``redistribute static``
+.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 
-{EIGRP command} {redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
-.. index:: {EIGRP command} {no redistribute static} {}
+``redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)``
+.. index:: no redistribute static
 
-{EIGRP command} {no redistribute static} {}
-          `redistribute static` redistributes routing information from
-          static route entries into the EIGRP tables. `no redistribute static`
-          disables the routes.
+``no redistribute static``
+    `redistribute static` redistributes routing information from
+    static route entries into the EIGRP tables. `no redistribute static`
+    disables the routes.
 
-.. index:: {EIGRP command} {redistribute connected} {}
+.. index:: redistribute connected
 
-{EIGRP command} {redistribute connected} {}
-.. index:: {EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
+``redistribute connected``
+.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 
-{EIGRP command} {redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
-.. index:: {EIGRP command} {no redistribute connected} {}
+``redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)``
+.. index:: no redistribute connected
 
-{EIGRP command} {no redistribute connected} {}
-              Redistribute connected routes into the EIGRP tables.  `no redistribute connected` disables the connected routes in the EIGRP tables.
-              This command redistribute connected of the interface which EIGRP disabled.
-              The connected route on EIGRP enabled interface is announced by default.
+``no redistribute connected``
+  Redistribute connected routes into the EIGRP tables. `no redistribute
+  connected` disables the connected routes in the EIGRP tables. This command
+  redistribute connected of the interface which EIGRP disabled. The connected
+  route on EIGRP enabled interface is announced by default.
 
-.. index:: {EIGRP command} {redistribute ospf} {}
+.. index:: redistribute ospf
 
-{EIGRP command} {redistribute ospf} {}
-.. index:: {EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
+``redistribute ospf``
+.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 
-{EIGRP command} {redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
-.. index:: {EIGRP command} {no redistribute ospf} {}
+``redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)``
+.. index:: no redistribute ospf
 
-{EIGRP command} {no redistribute ospf} {}
-                  `redistribute ospf` redistributes routing information from
-                  ospf route entries into the EIGRP tables. `no redistribute ospf`
-                  disables the routes.
+``no redistribute ospf``
+  `redistribute ospf` redistributes routing information from ospf route
+  entries into the EIGRP tables. `no redistribute ospf` disables the
+  routes.
 
-.. index:: {EIGRP command} {redistribute bgp} {}
+.. index:: redistribute bgp
 
-{EIGRP command} {redistribute bgp} {}
-.. index:: {EIGRP command} {redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
+``redistribute bgp``
+.. index:: redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 
-{EIGRP command} {redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)} {}
-.. index:: {EIGRP command} {no redistribute bgp} {}
+``redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)``
+.. index:: no redistribute bgp
 
-{EIGRP command} {no redistribute bgp} {}
-                      `redistribute bgp` redistributes routing information from
-                      bgp route entries into the EIGRP tables. `no redistribute bgp`
-                      disables the routes.
+``no redistribute bgp``
+  `redistribute bgp` redistributes routing information from
+  bgp route entries into the EIGRP tables. `no redistribute bgp`
+  disables the routes.
 
 .. _Show_EIGRP_Information:
 
@@ -196,16 +196,16 @@ Show EIGRP Information
 
 To display EIGRP routes.
 
-.. index:: Command {show ip eigrp topology} {}
+.. index:: show ip eigrp topology
 
-Command {show ip eigrp topology} {}
+``show ip eigrp topology``
   Show EIGRP routes.
 
 The command displays all EIGRP routes.
 
-.. index:: Command {show ip eigrp topology} {}
+.. index:: show ip eigrp topology
 
-Command {show ip eigrp topology} {}
+``show ip eigrp topology``
   The command displays current EIGRP status
 
 ::
@@ -227,23 +227,23 @@ EIGRP Debug Commands
 
 Debug for EIGRP protocol.
 
-.. index:: Command {debug eigrp packets} {}
+.. index:: debug eigrp packets
 
-Command {debug eigrp packets} {}
+``debug eigrp packets``
   Debug eigrp packets
 
 `debug eigrp` will show EIGRP packets that are sent and recevied.
 
-.. index:: Command {debug eigrp transmit} {}
+.. index:: debug eigrp transmit
 
-Command {debug eigrp transmit} {}
+``debug eigrp transmit``
   Debug eigrp transmit events
 
 `debug eigrp transmit` will display detailed information about the EIGRP transmit events.
 
-.. index:: Command {show debugging eigrp} {}
+.. index:: show debugging eigrp
 
-Command {show debugging eigrp} {}
+``show debugging eigrp``
   Display *eigrpd*'s debugging option.
 
 `show debugging eigrp` will show all information currently set for eigrpd