diff options
author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-03-01 17:10:01 +0100 |
---|---|---|
committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-03-01 17:10:01 +0100 |
commit | a975744835bb87e3cf62701e13248d66f1dac1df (patch) | |
tree | bca5ab1f29594688c43e0c36c9eb2f0c5c8e66c6 /doc/manpages | |
parent | debianpkg: disable pdf build by default (diff) | |
parent | Merge pull request #1784 from donaldsharp/documentation (diff) | |
download | frr-a975744835bb87e3cf62701e13248d66f1dac1df.tar.xz frr-a975744835bb87e3cf62701e13248d66f1dac1df.zip |
Merge branch 'master' into docuser
* New manpage: mtracebis.rst
* Makefile.am includes mtracebis.rst
* configure.ac lines removed
* Debian packaging files updated
* Fixed up manpage |seealso-programs| in the process
* Centos7 build package list updated to include systemd-devel
* New paragraph on netns vrf support in zebra manpage
Conflicts:
configure.ac
debianpkg/backports/ubuntu14.04/debian/frr.install
debianpkg/frr.install
doc/Makefile.am
doc/developer/Building_FRR_on_CentOS7.rst
doc/zebra.8.in
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/manpages')
-rw-r--r-- | doc/manpages/conf.py | 1 | ||||
-rw-r--r-- | doc/manpages/defines.rst | 2 | ||||
-rw-r--r-- | doc/manpages/epilogue.rst | 2 | ||||
-rw-r--r-- | doc/manpages/frr.rst | 2 | ||||
-rw-r--r-- | doc/manpages/index.rst | 1 | ||||
-rw-r--r-- | doc/manpages/mtracebis.rst | 39 | ||||
-rw-r--r-- | doc/manpages/ospfclient.rst | 2 | ||||
-rw-r--r-- | doc/manpages/zebra.rst | 5 |
8 files changed, 52 insertions, 2 deletions
diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 6da6ebff0..2d6fbe850 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -318,6 +318,7 @@ man_pages = [ ('ldpd', 'ldpd', fwfrr.format("an LDP "), [], 8), ('nhrpd', 'nhrpd', fwfrr.format("a Next Hop Routing Protocol "), [], 8), ('pimd', 'pimd', fwfrr.format("a PIM "), [], 8), + ('mtracebis', 'mtracebis', "a multicast trace client", [], 8), ('ripd', 'ripd', fwfrr.format("a RIP "), [], 8), ('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8), ('zebra', 'zebra', 'a routing manager for use with associated FRRouting components.', [], 8), diff --git a/doc/manpages/defines.rst b/doc/manpages/defines.rst index 4b66d71b4..841abe300 100644 --- a/doc/manpages/defines.rst +++ b/doc/manpages/defines.rst @@ -1,3 +1,3 @@ .. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path] .. |synopsis-options-hv| replace:: [-h] [-v] -.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) +.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8), mtracebis(8) diff --git a/doc/manpages/epilogue.rst b/doc/manpages/epilogue.rst index a4c1b897e..77fed8199 100644 --- a/doc/manpages/epilogue.rst +++ b/doc/manpages/epilogue.rst @@ -8,7 +8,7 @@ The daemon may log to standard output, to a VTY, to a log file, or through syslo SEE ALSO ======== -zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) +|seealso-programs| |PACKAGE_URL| BUGS diff --git a/doc/manpages/frr.rst b/doc/manpages/frr.rst index 37b90ac93..3d3479afa 100644 --- a/doc/manpages/frr.rst +++ b/doc/manpages/frr.rst @@ -2,6 +2,8 @@ FRR *** +.. include:: defines.rst + SYNOPSIS ======== frr [ start ] diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst index a909e094d..ae5c4ca3b 100644 --- a/doc/manpages/index.rst +++ b/doc/manpages/index.rst @@ -18,6 +18,7 @@ Welcome to FRR's documentation! ospfclient ospfd pimd + mtracebis ripd ripngd watchfrr diff --git a/doc/manpages/mtracebis.rst b/doc/manpages/mtracebis.rst new file mode 100644 index 000000000..b4d57c1b9 --- /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 diff --git a/doc/manpages/ospfclient.rst b/doc/manpages/ospfclient.rst index 573a75f6a..c52b10876 100644 --- a/doc/manpages/ospfclient.rst +++ b/doc/manpages/ospfclient.rst @@ -2,6 +2,8 @@ OSPFCLIENT ********** +.. include:: defines.rst + SYNOPSIS ======== ospfclient <ospfd> <lsatype> <opaquetype> <opaqueid> <ifaddr> <areaid> diff --git a/doc/manpages/zebra.rst b/doc/manpages/zebra.rst index 268b1d864..4ddf98995 100644 --- a/doc/manpages/zebra.rst +++ b/doc/manpages/zebra.rst @@ -37,6 +37,11 @@ OPTIONS available for the |DAEMON| command: Note that this affects Linux only. + +.. option:: -n, --vrfwnetns + + Enable namespace VRF backend. By default, the VRF backend relies on VRF-lite support from the Linux kernel. This option permits discovering Linux named network namespaces and mapping it to FRR VRF contexts. + FILES ===== |