Return to zebra.8 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / quagga / doc

Annotation of embedaddon/quagga/doc/zebra.8, revision 1.1.1.2

1.1       misho       1: .TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version 0.97.3"
                      2: .SH NAME
                      3: zebra \- a routing manager for use with associated Quagga components.
                      4: .SH SYNOPSIS
                      5: .B zebra
                      6: [
                      7: .B \-bdhklrv
                      8: ] [
                      9: .B \-f
                     10: .I config-file
                     11: ] [
                     12: .B \-i
                     13: .I pid-file
                     14: ] [
                     15: .B \-P
                     16: .I port-number
                     17: ] [
                     18: .B \-A
                     19: .I vty-address
                     20: ] [
                     21: .B \-u
                     22: .I user
                     23: ] [
                     24: .B \-g
                     25: .I group
                     26: ]
                     27: .SH DESCRIPTION
                     28: .B zebra 
                     29: is a routing manager that implements the 
                     30: .B zebra
                     31: route engine.
                     32: .B zebra 
                     33: supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
                     34: .SH OPTIONS
                     35: Options available for the
                     36: .B zebra
                     37: command:
                     38: .TP
                     39: \fB\-b\fR, \fB\-\-batch\fR
                     40: Runs in batch mode, \fBzebra\fR parses its config and exits.
                     41: .TP
                     42: \fB\-d\fR, \fB\-\-daemon\fR
                     43: Runs in daemon mode, forking and exiting from tty.
                     44: .TP
                     45: \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
                     46: Specifies the config file to use for startup. If not specified this
                     47: option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
                     48: .TP
                     49: \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
                     50: Specify the group to run as. Default is \fIquagga\fR.
                     51: .TP
                     52: \fB\-h\fR, \fB\-\-help\fR
                     53: A brief message.
                     54: .TP
                     55: \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
                     56: When zebra starts its process identifier is written to
                     57: \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
                     58: restart zebra.  The likely default is \fB\fI/var/run/zebra.pid\fR.
                     59: .TP
                     60: \fB\-k\fR, \fB\-\-keep_kernel\fR
                     61: On startup, don't delete self inserted routes.
                     62: .TP
                     63: \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
                     64: Specify the port that the zebra VTY will listen on. This defaults to
                     65: 2601, as specified in \fB\fI/etc/services\fR.
                     66: .TP
                     67: \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
                     68: Specify the address that the zebra VTY will listen on. Default is all
                     69: interfaces.
                     70: .TP
                     71: \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
                     72: Specify the user to run as. Default is \fIquagga\fR.
                     73: .TP
                     74: \fB\-r\fR, \fB\-\-retain\fR 
                     75: When the program terminates, retain routes added by \fBzebra\fR.
                     76: .TP
                     77: \fB\-s\fR, \fB\-\-nl-bufsize \fR\fInetlink-buffer-size\fR
                     78: Set netlink receive buffer size. There are cases where zebra daemon can't
                     79: handle flood of netlink messages from kernel. If you ever see "recvmsg overrun"
                     80: messages in zebra log, you are in trouble.
                     81: 
                     82: Solution is to increase receive buffer of netlink socket. Note that kernel
1.1.1.2 ! misho      83: < 2.6.14 doesn't allow to increase it over maximum value defined in
1.1       misho      84: \fI/proc/sys/net/core/rmem_max\fR. If you want to do it, you have to increase
                     85: maximum before starting zebra.
                     86: 
                     87: Note that this affects Linux only.
                     88: .TP
                     89: \fB\-v\fR, \fB\-\-version\fR
                     90: Print the version and exit.
                     91: .SH FILES
                     92: .TP
                     93: .BI /usr/local/sbin/zebra
                     94: The default location of the 
                     95: .B zebra
                     96: binary.
                     97: .TP
                     98: .BI /usr/local/etc/zebra.conf
                     99: The default location of the 
                    100: .B zebra
                    101: config file.
                    102: .TP
                    103: .BI $(PWD)/zebra.log 
                    104: If the 
                    105: .B zebra
                    106: process is config'd to output logs to a file, then you will find this
                    107: file in the directory where you started \fBzebra\fR.
                    108: .SH WARNING
                    109: This man page is intended to be a quick reference for command line
                    110: options. The definitive document is the Info file \fBQuagga\fR.
                    111: .SH DIAGNOSTICS
                    112: The zebra process may log to standard output, to a VTY, to a log
                    113: file, or through syslog to the system logs. \fBzebra\fR supports many
                    114: debugging options, see the Info file, or the source for details.
                    115: .SH "SEE ALSO"
                    116: .BR bgpd (8),
                    117: .BR ripd (8),
                    118: .BR ripngd (8),
                    119: .BR ospfd (8),
                    120: .BR ospf6d (8),
                    121: .BR isisd (8),
                    122: .BR vtysh (1)
                    123: .SH BUGS
                    124: .B zebra
                    125: eats bugs for breakfast. If you have food for the maintainers try
                    126: .BI http://bugzilla.quagga.net
                    127: .SH AUTHORS
                    128: See
                    129: .BI http://www.zebra.org
                    130: and
                    131: .BI http://www.quagga.net
                    132: or the Info file for an accurate list of authors.
                    133: