.
will be generated. You may view the manual page with: nroff -man .
| less'. A typical entry in a Makefile or Makefile.am is: DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" manpage.1: manpage.xml $(XP) $(DB2MAN) $< The xsltproc binary is found in the xsltproc package. The XSL files are in docbook-xsl. A description of the parameters you can use can be found in the docbook-xsl-doc-* packages. Please remember that if you create the nroff version in one of the debian/rules file targets (such as build), you will need to include xsltproc and docbook-xsl in your Build-Depends control field. Alternatively use the xmlto command/package. That will also automatically pull in xsltproc and docbook-xsl. Notes for using docbook2x: docbook2x-man does not automatically create the AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as ... . To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be found in the docbook-xsl-doc-html package. Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` General documentation about man-pages and man-page-formatting: man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ --> ]> &dhtitle; bird &dhfirstname; &dhsurname; Wrote this manpage for the Debian system.
&dhemail;
Jakub Ružička Updated this manpage for birdcl.
jakub.ruzicka@nic.cz
2010 &dhusername; 2022 Jakub Ružička This manual page was written for the Debian system (and may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation. On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
bird &dhsection; bird BIRD Internet Routing Daemon birdc BIRD Internet Routing Daemon remote control birdcl BIRD Internet Routing Daemon remote control light bird birdc birdcl DESCRIPTION bird is an Internet Routing Daemon. That is, it sends and receives messages using different protocols in order to discover and exchange routing information with other routing daemons present on the same network. It is able to talk the most widely known routing protocols (such as BGPv4, RIPv2, OSPFv2 and OSPFv3), both on IPv4 and IPv6 and it features a very powerful language for route filtering. birdc is a remote control for bird. While bird is running, the system administrator can connect to it using birdc, to inspect its internal status and reconfigure it. The two processes use a Unix socket to communicate. Once started, bird will give access to an interactive shell: commands can be completed with TAB and help can be requested by pressing the key `?'. More documentation on the available commands can be found on the website, see below. birdcl is a light version of birdc remote control for bird without readline/ncurses support. TAB completion isn't available. OPTIONS The bird accepts these options: Use given configuration file instead of the default /etc/bird/bird.conf. Enable debug messages to stderr, and run bird in foreground. Enable debug messages to given file. Run bird in foreground. Run bird with given group ID. Display command-line options to bird. Look for a configuration file and a communication socket in the current working directory instead of in default system locations. However, paths specified by options , have higher priority. Just parse the config file and exit. Return value is zero if the config file is valid, nonzero if there are some errors. Create a PID file with given filename. Apply graceful restart recovery after start. Use given filename for a socket for communications with the client (remote control), default is /run/bird/bird.ctl. Drop privileges and run as given user instead of root. The bird would keep CAP_NET_ADMIN and other network-related capabilities necessary for its function. Display bird version. birdc and birdcl accept these options: Look for a communication socket in the current working directory. Run birdc in restricted mode: only the `show ...' commands are allowed. Use given filename for a socket for communications with the server, default is /run/bird/bird.ctl. Numeric return codes are dumped along with messages, making them easily parsable by a program. See the programmer's documentation for information about their meanings. FILES /etc/bird/bird.conf The system-wide configuration file to control the behaviour of bird. See the website for more documentation. SEE ALSO More documentation can be found on the website: https://bird.network.cz/.