diff options
| author | Christian Franke <chris@opensourcerouting.org> | 2018-08-20 22:29:29 +0200 |
|---|---|---|
| committer | Christian Franke <chris@opensourcerouting.org> | 2018-09-05 11:41:47 +0200 |
| commit | f3c7b99d05647fa5cda851917c12f3350a326e3c (patch) | |
| tree | effea7df133d6b0a305d763052f65c8361e9380d /doc/manpages | |
| parent | f6ae63ca955e77aaf40ee1add30506a7a1bbcffa (diff) | |
doc: add documentation for fabricd
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
Diffstat (limited to 'doc/manpages')
| -rw-r--r-- | doc/manpages/conf.py | 1 | ||||
| -rw-r--r-- | doc/manpages/fabricd.rst | 38 | ||||
| -rw-r--r-- | doc/manpages/index.rst | 1 | ||||
| -rw-r--r-- | doc/manpages/subdir.am | 1 |
4 files changed, 41 insertions, 0 deletions
diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index e540d236ea..f57bc1d278 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -333,6 +333,7 @@ man_pages = [ ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1), ('frr', 'frr', 'a systemd interaction script', [], 1), ('bfdd', 'bfdd', fwfrr.format("a bfd"), [], 8), + ('fabricd', 'fabricd', fwfrr.format("an OpenFabric "), [], 8), ] # -- Options for Texinfo output ------------------------------------------- diff --git a/doc/manpages/fabricd.rst b/doc/manpages/fabricd.rst new file mode 100644 index 0000000000..c14c07661e --- /dev/null +++ b/doc/manpages/fabricd.rst @@ -0,0 +1,38 @@ +******* +FABRICD +******* + +.. include:: defines.rst +.. |DAEMON| replace:: fabricd + +SYNOPSIS +======== +|DAEMON| |synopsis-options-hv| + +|DAEMON| |synopsis-options| + +DESCRIPTION +=========== +|DAEMON| is a routing component that works with the FRRouting routing 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 + diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst index c62835c770..053555c4e4 100644 --- a/doc/manpages/index.rst +++ b/doc/manpages/index.rst @@ -10,6 +10,7 @@ bgpd eigrpd isisd + fabricd ldpd nhrpd ospf6d diff --git a/doc/manpages/subdir.am b/doc/manpages/subdir.am index 24f47fc7a5..20efd523fc 100644 --- a/doc/manpages/subdir.am +++ b/doc/manpages/subdir.am @@ -9,6 +9,7 @@ man_RSTFILES = \ doc/manpages/defines.rst \ doc/manpages/eigrpd.rst \ doc/manpages/epilogue.rst \ + doc/manpages/fabricd.rst \ doc/manpages/frr.rst \ doc/manpages/index.rst \ doc/manpages/isisd.rst \ |