diff options
author | Donald Sharp <sharpd@cumulusnetworks.com> | 2018-06-20 15:14:48 +0200 |
---|---|---|
committer | Donald Sharp <sharpd@cumulusnetworks.com> | 2018-07-29 18:43:21 +0200 |
commit | 614aa5c166aa05f5840d447e7d7d424d89afa91c (patch) | |
tree | 0db4352e2a612b689b8f03af7de49ae5d603e27f /doc/manpages | |
parent | staticd: Fix recursive routes for certain types of nexthops (diff) | |
download | frr-614aa5c166aa05f5840d447e7d7d424d89afa91c.tar.xz frr-614aa5c166aa05f5840d447e7d7d424d89afa91c.zip |
doc: Add some documentation for staticd
Remove the ip route specific sections from zebra documenation and
create a specific one for the new staticd.
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
Diffstat (limited to 'doc/manpages')
-rw-r--r-- | doc/manpages/common-options.rst | 1 | ||||
-rw-r--r-- | doc/manpages/conf.py | 1 | ||||
-rw-r--r-- | doc/manpages/defines.rst | 2 | ||||
-rw-r--r-- | doc/manpages/index.rst | 1 | ||||
-rw-r--r-- | doc/manpages/staticd.rst | 38 |
5 files changed, 42 insertions, 1 deletions
diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst index e9241b743..1b2eb18de 100644 --- a/doc/manpages/common-options.rst +++ b/doc/manpages/common-options.rst @@ -123,6 +123,7 @@ These following options control the daemon's VTY (interactive command line) inte ldpd 2612 eigrpd 2613 pbrd 2615 + staticd 2616 Port 2607 is used for ospfd's Opaque LSA API, while port 2600 is used for the (insecure) TCP-ZEBRA interface. diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 2b0f7e389..4d5797f61 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -324,6 +324,7 @@ man_pages = [ ('pimd', 'pimd', fwfrr.format("a PIM "), [], 8), ('pbrd', 'pbrd', fwfrr.format("a PBR "), [], 8), ('sharpd', 'sharpd', fwfrr.format("a SHARP "), [], 8), + ('staticd', 'staticd', fwfrr.format("a static route manager "), [], 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/defines.rst b/doc/manpages/defines.rst index 21c3790af..e1f7ec4ce 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), pbrd(8), ldpd(8), eigrpd(8), mtracebis(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), pbrd(8), ldpd(8), eigrpd(8), staticd(8), mtracebis(8) diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst index 6d3f3aae5..e95dd26e8 100644 --- a/doc/manpages/index.rst +++ b/doc/manpages/index.rst @@ -20,6 +20,7 @@ ripd ripngd sharpd + staticd watchfrr zebra vtysh diff --git a/doc/manpages/staticd.rst b/doc/manpages/staticd.rst new file mode 100644 index 000000000..ccbcf32e3 --- /dev/null +++ b/doc/manpages/staticd.rst @@ -0,0 +1,38 @@ +******* +STATICD +******* + +.. include:: defines.rst +.. |DAEMON| replace:: staticd + +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 + + |