'\" t
.\"     Title: bird
.\"    Author: Giovanni Mascellani <mascellani@poisson.phc.unipi.it>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/02/2021
.\"    Manual: BIRD User Manual
.\"    Source: bird
.\"  Language: English
.\"
.TH "BIRD" "8" "01/02/2021" "bird" "BIRD User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bird \- BIRD Internet Routing Daemon
.br
birdc \- BIRD Internet Routing Daemon remote control
.SH "SYNOPSIS"
.HP \w'\fBbird\fR\ 'u
\fBbird\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\fR] [\fB\-D\ \fR\fB\fIdebug\-file\fR\fR] [\fB\-f\fR] [\fB\-g\ \fR\fB\fIgroup\fR\fR] [\fB\-l\fR] [\fB\-p\fR] [\fB\-P\ \fR\fB\fIpid\-file\fR\fR] [\fB\-R\fR] [\fB\-s\ \fR\fB\fIcontrol\-socket\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR]
.HP \w'\fBbirdc\fR\ 'u
\fBbirdc\fR [\fB\-l\fR] [\fB\-r\fR] [\fB\-s\ \fR\fB\fIcontrol\-socket\fR\fR] [\fB\-v\fR]
.SH "DESCRIPTION"
.PP
\fBbird\fR
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\&.
.PP
\fBbirdc\fR
is a remote control for
\fBbird\fR\&. While
\fBbird\fR
is running, the system administrator can connect to it using
\fBbirdc\fR, to inspect its internal status and reconfigure it\&. The two processes use a Unix socket to communicate\&. Once started,
\fBbird\fR
will give access to an interactive shell: commands can be completed with TAB and help can be requested by pressing the key `?\*(Aq\&. More documentation on the available commands can be foung on the website, see below\&.
.SH "OPTIONS"
.PP
The
\fBbird\fR
accepts these options:
.PP
\fB\-c \fR\fB\fIconfig\-file\fR\fR
.RS 4
Use given configuration file instead of the default /etc/bird/bird\&.conf\&.
.RE
.PP
\fB\-d\fR
.RS 4
Enable debug messages to stderr, and run bird in foreground\&.
.RE
.PP
\fB\-D \fR\fB\fIdebug\-file\fR\fR
.RS 4
Enable debug messages to given file\&.
.RE
.PP
\fB\-f\fR
.RS 4
Run bird in foreground\&.
.RE
.PP
\fB\-g \fR\fB\fIgroup\fR\fR
.RS 4
Run bird with given group ID\&.
.RE
.PP
\fB\-\-help\fR
.RS 4
Display command\-line options to bird\&.
.RE
.PP
\fB\-l\fR
.RS 4
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
\fB\-c\fR,
\fB\-s\fR
have higher priority\&.
.RE
.PP
\fB\-p\fR
.RS 4
Just parse the config file and exit\&. Return value is zero if the config file is valid, nonzero if there are some errors\&.
.RE
.PP
\fB\-P \fR\fB\fIpid\-file\fR\fR
.RS 4
Create a PID file with given filename\&.
.RE
.PP
\fB\-R\fR
.RS 4
Apply graceful restart recovery after start\&.
.RE
.PP
\fB\-s \fR\fB\fIcontrol\-socket\fR\fR
.RS 4
Use given filename for a socket for communications with the client (remote control), default is /run/bird/bird\&.ctl\&.
.RE
.PP
\fB\-u \fR\fB\fIuser\fR\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Display bird version\&.
.RE
.PP
The
\fBbirdc\fR
accepts these options:
.PP
\fB\-l\fR
.RS 4
Look for a communication socket in the current working directory\&.
.RE
.PP
\fB\-r\fR
.RS 4
Run
\fBbirdc\fR
in restricted mode: only the `show \&.\&.\&.\*(Aq commands are allowed\&.
.RE
.PP
\fB\-s \fR\fB\fIcontrol\-socket\fR\fR
.RS 4
Use given filename for a socket for communications with the server, default is /run/bird/bird\&.ctl\&.
.RE
.PP
\fB\-v\fR
.RS 4
Numeric return codes are dumped along with messages, making them easily parsable by a program\&. See the programmer\*(Aqs documentation for information about their meanings\&.
.RE
.SH "FILES"
.PP
/etc/bird/bird\&.conf
.RS 4
The system\-wide configuration file to control the behaviour of
bird\&. See the website for more documentation\&.
.RE
.SH "SEE ALSO"
.PP
More documentation con be found on the website: https://bird\&.network\&.cz/\&.
.SH "AUTHOR"
.PP
\fBGiovanni Mascellani\fR <\&mascellani@poisson\&.phc\&.unipi\&.it\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Giovanni Mascellani
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
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\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp