summaryrefslogtreecommitdiff
path: root/doc/manpages/mtracebis.rst
diff options
context:
space:
mode:
authorpaulzlabn <paulz@labn.net>2018-03-14 13:31:58 -0700
committerGitHub <noreply@github.com>2018-03-14 13:31:58 -0700
commit3f1224cd1a9408bdad6aca8c0c205211cb548d5c (patch)
tree87e6a52a3e7ad7b09caa3207f081fd92bc8fd018 /doc/manpages/mtracebis.rst
parentfd9b55a2b77c187730600d429b3f290ab58fa035 (diff)
parent6ca96cc6ada990d052fcfc48cffeef454ae64a10 (diff)
Merge branch 'master' into working/master/bgp-vpn-vrf-leaking
Diffstat (limited to 'doc/manpages/mtracebis.rst')
-rw-r--r--doc/manpages/mtracebis.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/manpages/mtracebis.rst b/doc/manpages/mtracebis.rst
new file mode 100644
index 0000000000..b4d57c1b97
--- /dev/null
+++ b/doc/manpages/mtracebis.rst
@@ -0,0 +1,39 @@
+*********
+MTRACEBIS
+*********
+
+.. include:: defines.rst
+.. |PROGRAM| replace:: mtracebis
+
+SYNOPSIS
+========
+|PROGRAM| |synopsis-options-hv|
+
+|PROGRAM| <multicast source>
+
+DESCRIPTION
+===========
+|PROGRAM| is a program to initiate 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.
+
+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...
+until a set of routers is tested for connectivity.
+
+FILES
+=====
+
+|INSTALL_PREFIX_SBIN|/|PROGRAM|
+ The default location of the |PROGRAM| binary.
+
+.. include:: epilogue.rst
+
+AUTHORS
+=======
+
+Mladen Sablic