[zebra] arrange structs in padding-efficient manner and remove unused field

[mirror_frr.git] / doc / zebra.8

.TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version 0.97.3"
.SH NAME
zebra \- a routing manager for use with associated Quagga components.
.SH SYNOPSIS
.B zebra
[
.B \-bdhklrv
] [
.B \-f
.I config-file
] [
.B \-i
.I pid-file
] [
.B \-P
.I port-number
] [
.B \-A
.I vty-address
] [
.B \-u
.I user
] [
.B \-g
.I group
]
.SH DESCRIPTION
.B zebra 
is a routing manager that implements the 
.B zebra
route engine.
.B zebra 
supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
.SH OPTIONS
Options available for the
.B zebra
command:
.TP
\fB\-b\fR, \fB\-\-batch\fR
Runs in batch mode, \fBzebra\fR parses its config and exits.
.TP
\fB\-d\fR, \fB\-\-daemon\fR
Runs in daemon mode, forking and exiting from tty.
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
.TP
\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
Specify the group to run as. Default is \fIquagga\fR.
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
When zebra starts its process identifier is written to
\fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
restart zebra.  The likely default is \fB\fI/var/run/zebra.pid\fR.
.TP
\fB\-k\fR, \fB\-\-keep_kernel\fR
On startup, don't delete self inserted routes.
.TP
\fB\-l\fR, \fB\-\-log_mode\fR
Turn verbose logging on.
.TP
\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
Specify the port that the zebra VTY will listen on. This defaults to
2602, as specified in \fB\fI/etc/services\fR.
.TP
\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
Specify the address that the zebra VTY will listen on. Default is all
interfaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR 
When the program terminates, retain routes added by \fBzebra\fR.
.TP
\fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
Set netlink receive buffer size. There are cases where zebra daemon can't
handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
messages in zebra log, you are in trouble.

Solution is to increase receive buffer of netlink socket. Note that kernel
doesn't allow to increase it over maximum value defined in
\fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase
maximum before starting zebra.

Note that this affects Linux only.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
.SH FILES
.TP
.BI /usr/local/sbin/zebra
The default location of the 
.B zebra
binary.
.TP
.BI /usr/local/etc/zebra.conf
The default location of the 
.B zebra
config file.
.TP
.BI $(PWD)/zebra.log 
If the 
.B zebra
process is config'd to output logs to a file, then you will find this
file in the directory where you started \fBzebra\fR.
.SH WARNING
This man page is intended to be a quick reference for command line
options. The definitive document is the Info file \fBQuagga\fR.
.SH DIAGNOSTICS
The zebra process may log to standard output, to a VTY, to a log
file, or through syslog to the system logs. \fBzebra\fR supports many
debugging options, see the Info file, or the source for details.
.SH "SEE ALSO"
.BR bgpd (8),
.BR ripd (8),
.BR ripngd (8),
.BR ospfd (8),
.BR ospf6d (8),
.BR isisd (8),
.BR vtysh (1)
.SH BUGS
.B zebra
eats bugs for breakfast. If you have food for the maintainers try
.BI http://bugzilla.quagga.net
.SH AUTHORS
See
.BI http://www.zebra.org
and
.BI http://www.quagga.org
or the Info file for an accurate list of authors.