diff options
Diffstat (limited to 'doc/manpages')
| -rw-r--r-- | doc/manpages/conf.py | 1 | ||||
| -rw-r--r-- | doc/manpages/index.rst | 1 | ||||
| -rw-r--r-- | doc/manpages/mtracebis.rst | 19 | ||||
| -rw-r--r-- | doc/manpages/sharpd.rst | 38 |
4 files changed, 52 insertions, 7 deletions
diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 41683ed678..2b0f7e3893 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -323,6 +323,7 @@ man_pages = [ ('nhrpd', 'nhrpd', fwfrr.format("a Next Hop Routing Protocol "), [], 8), ('pimd', 'pimd', fwfrr.format("a PIM "), [], 8), ('pbrd', 'pbrd', fwfrr.format("a PBR "), [], 8), + ('sharpd', 'sharpd', fwfrr.format("a SHARP "), [], 8), ('mtracebis', 'mtracebis', "a multicast trace client", [], 8), ('ripd', 'ripd', fwfrr.format("a RIP "), [], 8), ('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8), diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst index e05890f8d1..6d3f3aae55 100644 --- a/doc/manpages/index.rst +++ b/doc/manpages/index.rst @@ -19,6 +19,7 @@ mtracebis ripd ripngd + sharpd watchfrr zebra vtysh diff --git a/doc/manpages/mtracebis.rst b/doc/manpages/mtracebis.rst index b4d57c1b97..d3ba8036d8 100644 --- a/doc/manpages/mtracebis.rst +++ b/doc/manpages/mtracebis.rst @@ -9,17 +9,22 @@ SYNOPSIS ======== |PROGRAM| |synopsis-options-hv| -|PROGRAM| <multicast source> +|PROGRAM| <multicast source> [<multicast group>] DESCRIPTION =========== -|PROGRAM| is a program to initiate multicast traceroute, or "mtrace", queries. +|PROGRAM| is a program for initiating multicast traceroute, or "mtrace", queries. -The initial version of the program requires multicast source IP address and -initiates a weak traceroute across the network. This tests whether the -interfaces towards the source are multicast enabled. The first query sent is a -full query, capable of crossing the network all the way to the source. If this -fails, hop-by-hop queries are initiated. +It can initiate two types of mtrace queries: weak and group. + +Weak tests whether the interfaces towards the source are multicast enabled and is +initiated by supplying only the multicast source address. + +Group tests whether there is multicast routing protocol state for particular +multicast group and is initiated by supplying mutlicast source and group. + +The first query sent is a full query, capable of crossing the network all the way +to the source. If this fails, hop-by-hop queries are initiated. Hop-by-hop queries start by requesting only a response from the nearest router. Following that, next query is extended to the next two routers, and so on... diff --git a/doc/manpages/sharpd.rst b/doc/manpages/sharpd.rst new file mode 100644 index 0000000000..016f3f9254 --- /dev/null +++ b/doc/manpages/sharpd.rst @@ -0,0 +1,38 @@ +****** +SHARPD +****** + +.. include:: defines.rst +.. |DAEMON| replace:: sharpd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting engine. + +OPTIONS +======= +OPTIONS available for the |DAEMON| command: + +.. include:: common-options.rst + +FILES +===== + +|INSTALL_PREFIX_SBIN|/|DAEMON| + The default location of the |DAEMON| binary. + +|INSTALL_PREFIX_ETC|/|DAEMON|.conf + The default location of the |DAEMON| config file. + +$(PWD)/|DAEMON|.log + If the |DAEMON| process is configured to output logs to a file, then you will find this file in the directory where you started |DAEMON|. + +.. include:: epilogue.rst + + |
