summaryrefslogtreecommitdiff
path: root/doc/manpages
AgeCommit message (Collapse)Author
2022-02-14doc: Fix spelling mistakesDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2021-04-12doc: Add an option for vtysh to override history file pathDonatas Abraitis
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-10-13doc, zebra: remove keep_kernel option everywhereEmanuele Bovisio
remove all remaining parts related to keep_kernel option Signed-off-by: Emanuele Bovisio <emanuele.bovisio@eolo.it>
2020-10-07*: reformat python fileswhitespace
We are now using black. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-07-22doc: update watchfrr manpageDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-03-10docs: fix a warning while building manpagesRuben Kerkhof
$ make doc SPHINX doc/manpages/_build/.doctrees/environment.pickle WARNING: html_static_path entry '_static' does not exist Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2020-01-15doc: rename man pages to frr-*David Lamparter
The vrrpd one conflicts with the standalone vrrpd package; also we're installing daemons to /usr/lib/frr on some systems so they're not on PATH. Signed-off-by: David Lamparter <equinox@diac24.net>
2019-12-18doc: fix duplicate -S option in bgpd manpageQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-10-16doc: Add cli options for bgp to documentationDonald Sharp
Document the bgp cli options. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-17doc: remove trailing whitespace in vrrp manpageQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-05-17doc: add vrrpd(8)Quentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-22doc: add --apiserver to ospfd manpageQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26doc: exclude bfd-options.rst from toctreeQuentin Young
This is an include file, needs to be explicitly excluded to suppress Sphinx warnings. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-12doc: include fabricd in see-also programsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-19doc: update for new daemons settingsDavid Lamparter
watchfrr_enable is ignored, watchfrr_options is unneeded and the valgrind options have been replaced with daemon_wrap/all_wrap. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-27Merge pull request #3235 from opensourcerouting/buildfoo-20181024Lou Berger
build: potpourri
2018-10-25*: spelchekDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-24build: make clean and dist consistentDavid Lamparter
We weren't cleaning up some files (a whole lot of python foobar) and had some files in the dist tarball that don't quite belong there. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-18bgpd, doc, ldpd, lib, tests, zebra: LM fixespaco
Corrections so that the BGP daemon can work with the label manager properly through a label-manager proxy. Details: - Correction so the BGP daemon behind a proxy label manager gets the range correctly (-I added to the BGP daemon, to set the daemon instance id) - For the BGP case, added an asynchronous label manager connect command so the labels get recycled in case of a BGP daemon reconnection. With this, BGPd and LDPd would behave similarly. Signed-off-by: F. Aragon <paco@voltanet.io>
2018-09-09build: fix not building docs w/o sphinxDavid Lamparter
Can't build manpages without sphinx-build, oops... Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-08build: move vtysh & manpage listings to subdir.amDavid Lamparter
Since we're now building through one large Makefile, we can easily put things with their daemons and crossreference nicely. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-09-05doc: add documentation for fabricdChristian Franke
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-09-05fabricd: add new daemon as build of isisdChristian Franke
fabricd is built using the sources of isisd. To allow differentiation in the code, -DFABRICD=1 is added to its preprocessor flags. Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-30build: non-recursive doc + parallel sphinxDavid Lamparter
Sphinx actually does work with a parallel build, if the doctree creation is a separate step (which the other builds will then just read unmodified.) This can be done with the "dummy" target. This also adds "-j6" to sphinx-build and adds a "--disable-doc-html" switch on ./configure to turn on/off building HTML docs separately. Also, HTML docs are now installed by "make install" to /usr/share/doc/frr/html. Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-20Merge pull request #2874 from opensourcerouting/fix-doc-bfdd-indexDonald Sharp
doc: address multiple warnings related to bfdd's docs
2018-08-20doc: bfdd manpage should be included in the manpage indexChristian Franke
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-20doc, debianpkg: Cleanup tcp-zebra configure optionsDonald Sharp
Since we removed --enable-tcp-zebra cleanup the last remaining vestiges of that code from the system. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-08bfdd: add documentationRafael Zalamena
Add BFD daemon documentation: * commands; * man page; * manual / description; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-07-29doc: Add some documentation for staticdDonald Sharp
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>
2018-05-22doc: move -r option docs to zebra onlyQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-18doc: fix distcleanQuentin Young
Apparently Automake has some undocumented logic somewhere that makes it so any Makefile generated from an Automake Makefile.am is removed from its secret list of things to delete that it deletes when performing a recursive distclean before actually performing the recursive distclean and since the secret list is automatically generated from the list of things that Autoconf should generate in configure.ac we can't remove the Makefile from that list or it will break Automake's list of things to automatically generate that it generates from Autoconf's list of things to automatically generate. Thus, to prevent Automake from deleting Makefiles and then immediately trying to use the Makefiles it just deleted to delete said Makefiles, we must remove ourselves from the secret list, which is accomplished by changing the file extension to '.am' instead of '.in'. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-12Merge pull request #2162 from qlyoung/fix-vpath-buildRuss White
doc: support VPATH builds
2018-05-10Merge pull request #2195 from qlyoung/docuserJafar Al-Gharaibeh
doc: update doc titles
2018-05-09doc: update doc titlesQuentin Young
Should be a bit easier to Google this way. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-02doc: support VPATH buildsQuentin Young
Documentation was not fully using Automake / Autoconf and therefore needs modifications to support black magic VPATH builds. * Convert Makefile's to Autoconf-controlled Makefile.in's * Tweak loading of pygments lexer to handle runtime paths * Update .gitignore's as necessary Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-30doc: Add some documentation for the sharp daemonDonald Sharp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-24pimd: adding querying of state to mtraceMladen Sablic
Adding to mtracebis querying with group address. Same change to vtysh mtrace command. Support for querying (S,G) and (*,G) state in mtrace router code. Further improvments to mtrace router code with closer complience to IETF draft. More references in comments to the draft. Man page has been updated accordingly. Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-04-12Merge pull request #2039 from qlyoung/docuserRafael Zalamena
doc: more cleanup, config syntax highlighting
2018-04-10doc: gracefully handle missing config.statusQuentin Young
The docs extract various configuration values from config.status and substitute them into placeholders throughout the docs. Add the ability to build the docs with some reasonable defaults set instead of failing when config.status doesn't exist. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-06doc: bit of cleanup for pbr docsQuentin Young
* Indent is 3 spaces * Use CLI cross-references * Wrap to 80 columns * Adjust section capitalization Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-06doc: Add documentation for PBRDDonald Sharp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-03doc: warn users about vtysh / telnet securityQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-28manpages: vtysh.rst add description of -u/--user flagsLou Berger
Signed-off-by: Lou Berger <lberger@labn.net>
2018-03-15doc: Clean up vtysh man pageDonald Sharp
The vtysh man page was referencing eigrp. Looked like a cut-n-paste error? Added some missing cli for the vtysh program, that users might want to see. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-07doc: change html theme to 'default'Quentin Young
Looks like older versions of Sphinx switched around naming for the default themes. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-07doc: fix make setupQuentin Young
Iron out all of the glitches with recursive Automake, 3rd-party autogenerated Sphinx makefiles, building and installing 3 different document formats under different targets, and handling clean. * Implement all Automake-required targets for 3rd-party Makefiles * Setup subdirectories for 3rd-party Makefiles * Override implicit Automake document targets * Clean up explicit targets for developer docs * Move Sphinx-generated Makefile to an include file * Update targets for debian packaging Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-06doc: prevent `clean` target from building manpagesQuentin Young
Unconditional automake subdirectory flag = 'man' causes manpages to always be built regardless of target, which is undesirable for `clean`. Remove unconditional flag and override automake targets that need to build manpages instead. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-01Merge branch 'master' into docuserQuentin Young
* 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>
2018-02-07doc: use python 2.6 format stringsQuentin Young
Centos 6 only has python 2.6 which requires numerical identifiers for format strings Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07doc: fix makefiles againQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>