summaryrefslogtreecommitdiff
path: root/distro/pkg/deb/bird.xml
diff options
context:
space:
mode:
authorJakub Ružička <jakub.ruzicka@nic.cz>2021-04-06 18:13:16 +0200
committerOndrej Zajicek (work) <santiago@crfreenet.org>2021-05-19 17:22:11 +0200
commit329d6e3fbc5a09a9bc8800bd8a5d239dec1a3d24 (patch)
tree29bf25fc20a609c0d81469fc2e4e528b99d4f5bb /distro/pkg/deb/bird.xml
parentc3c691e95cd40d8654b720be8d9a8ae9fb050951 (diff)
add apkg-powered upstream packaging for deb, rpm
Files in a single new distro/ dir allow apkg to build BIRD packages for various distros directly from upstream sources as well as from upstream archives. Please see distro/README.md for more detail as well as apkg docs: https://apkg.rtfd.io I've used these files to build bird-2.0.8 on all currently supported releases of following distros: * Debian * Ubuntu * Fedora * CentOS * openSUSE Please note that latest apkg with accumulated fixes for bird is needed: https://gitlab.nic.cz/packaging/apkg/-/merge_requests/35
Diffstat (limited to 'distro/pkg/deb/bird.xml')
-rw-r--r--distro/pkg/deb/bird.xml286
1 files changed, 286 insertions, 0 deletions
diff --git a/distro/pkg/deb/bird.xml b/distro/pkg/deb/bird.xml
new file mode 100644
index 00000000..4ba3868f
--- /dev/null
+++ b/distro/pkg/deb/bird.xml
@@ -0,0 +1,286 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+
+<!--
+
+`xsltproc -''-nonet \
+ -''-param man.charmap.use.subset "0" \
+ -''-param make.year.ranges "1" \
+ -''-param make.single.year.ranges "1" \
+ /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
+ manpage.xml'
+
+A manual page <package>.<section> will be generated. You may view the
+manual page with: nroff -man <package>.<section> | 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
+<refsect1> ... </refsect1>.
+
+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/
+
+-->
+
+ <!ENTITY dhfirstname "Giovanni">
+ <!ENTITY dhsurname "Mascellani">
+ <!ENTITY dhusername "&dhfirstname; &dhsurname;">
+ <!ENTITY dhemail "mascellani@poisson.phc.unipi.it">
+ <!ENTITY dhsection "8">
+ <!ENTITY dhtitle "BIRD User Manual">
+]>
+
+<refentry>
+ <refentryinfo>
+ <title>&dhtitle;</title>
+ <productname>bird</productname>
+ <authorgroup>
+ <author>
+ <firstname>&dhfirstname;</firstname>
+ <surname>&dhsurname;</surname>
+ <contrib>Wrote this manpage for the Debian system.</contrib>
+ <address>
+ <email>&dhemail;</email>
+ </address>
+ </author>
+ </authorgroup>
+ <copyright>
+ <year>2010</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ <legalnotice>
+ <para>This manual page was written for the Debian system
+ (and may be used by others).</para>
+ <para>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.</para>
+ <para>On Debian systems, the complete text of the GNU General Public
+ License can be found in
+ <filename>/usr/share/common-licenses/GPL</filename>.</para>
+ </legalnotice>
+
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>bird</refentrytitle>
+ <manvolnum>&dhsection;</manvolnum>
+ </refmeta>
+ <refnamediv>
+ <refname>bird</refname>
+ <refpurpose>BIRD Internet Routing Daemon</refpurpose>
+ </refnamediv>
+ <refnamediv>
+ <refname>birdc</refname>
+ <refpurpose>BIRD Internet Routing Daemon remote control</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>bird</command>
+ <arg choice="opt"><option>-c <replaceable>config-file</replaceable></option></arg>
+ <arg choice="opt"><option>-d</option></arg>
+ <arg choice="opt"><option>-D <replaceable>debug-file</replaceable></option></arg>
+ <arg choice="opt"><option>-f</option></arg>
+ <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
+ <arg choice="opt"><option>-l</option></arg>
+ <arg choice="opt"><option>-p</option></arg>
+ <arg choice="opt"><option>-P <replaceable>pid-file</replaceable></option></arg>
+ <arg choice="opt"><option>-R</option></arg>
+ <arg choice="opt"><option>-s <replaceable>control-socket</replaceable></option></arg>
+ <arg choice="opt"><option>-u <replaceable>user</replaceable></option></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>birdc</command>
+ <arg choice="opt"><option>-l</option></arg>
+ <arg choice="opt"><option>-r</option></arg>
+ <arg choice="opt"><option>-s <replaceable>control-socket</replaceable></option></arg>
+ <arg choice="opt"><option>-v</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="description">
+ <title>DESCRIPTION</title>
+ <para><command>bird</command> 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.</para>
+ <para><command>birdc</command> is a remote control for <command>bird</command>.
+ While <command>bird</command> is running, the system administrator can
+ connect to it using <command>birdc</command>, to inspect its internal
+ status and reconfigure it. The two processes use a Unix socket to
+ communicate. Once started, <command>bird</command> 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 foung on the website, see below.</para>
+ </refsect1>
+
+ <refsect1 id="options">
+ <title>OPTIONS</title>
+ <para>The <command>bird</command> accepts these options:</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-c <replaceable>config-file</replaceable></option></term>
+ <listitem>
+ <para>Use given configuration file instead of the default /etc/bird/bird.conf.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-d</option></term>
+ <listitem>
+ <para>Enable debug messages to stderr, and run bird in foreground.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-D <replaceable>debug-file</replaceable></option></term>
+ <listitem>
+ <para>Enable debug messages to given file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-f</option></term>
+ <listitem>
+ <para>Run bird in foreground.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-g <replaceable>group</replaceable></option></term>
+ <listitem>
+ <para>Run bird with given group ID.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>Display command-line options to bird.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-l</option></term>
+ <listitem>
+ <para>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 <option>-c</option>,
+ <option>-s</option> have higher priority.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-p</option></term>
+ <listitem>
+ <para>Just parse the config file and exit. Return value is zero if the
+ config file is valid, nonzero if there are some errors.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-P <replaceable>pid-file</replaceable></option></term>
+ <listitem>
+ <para>Create a PID file with given filename.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-R</option></term>
+ <listitem>
+ <para>Apply graceful restart recovery after start.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s <replaceable>control-socket</replaceable></option></term>
+ <listitem>
+ <para>Use given filename for a socket for communications with the
+ client (remote control), default is /run/bird/bird.ctl.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-u <replaceable>user</replaceable></option></term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--version</option></term>
+ <listitem>
+ <para>Display bird version.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>The <command>birdc</command> accepts these options:</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-l</option></term>
+ <listitem>
+ <para>Look for a communication socket in the current working directory.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-r</option></term>
+ <listitem>
+ <para>Run <command>birdc</command> in restricted mode: only the
+ `show ...' commands are allowed.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s <replaceable>control-socket</replaceable></option></term>
+ <listitem>
+ <para>Use given filename for a socket for communications with the
+ server, default is /run/bird/bird.ctl.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-v</option></term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 id="files">
+ <title>FILES</title>
+ <variablelist>
+ <varlistentry>
+ <term><filename>/etc/bird/bird.conf</filename></term>
+ <listitem>
+ <para>The system-wide configuration file to control the
+ behaviour of <application>bird</application>. See
+ the website for more documentation.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 id="see_also">
+ <title>SEE ALSO</title>
+ <para>More documentation con be found on the website:
+ https://bird.network.cz/.</para>
+ </refsect1>
+</refentry>
+