summaryrefslogtreecommitdiff
path: root/doc/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manpages')
-rw-r--r--doc/manpages/mtracebis.rst19
1 files changed, 12 insertions, 7 deletions
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...