hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 1 | .TH ZEBRA 8 "10 August 2004" "Zebra daemon" "Version 0.96.5" |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 2 | .SH NAME |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 3 | zebra \- a routing manager for use with associated Quagga components. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 4 | .SH SYNOPSIS |
| 5 | .B zebra |
| 6 | [ |
| 7 | .B \-bdhklrv |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 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 |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 23 | ] |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 24 | .SH DESCRIPTION |
| 25 | .B zebra |
| 26 | is a routing manager that implements the |
| 27 | .B zebra |
| 28 | route engine. |
| 29 | .B zebra |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 30 | supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 31 | .SH OPTIONS |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 32 | Options available for the |
| 33 | .B zebra |
| 34 | command: |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 35 | .TP |
| 36 | \fB\-b\fR, \fB\-\-batch\fR |
| 37 | Runs in batch mode, \fBzebra\fR parses its config and exits. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 38 | .TP |
| 39 | \fB\-d\fR, \fB\-\-daemon\fR |
| 40 | Runs in daemon mode, forking and exiting from tty. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 41 | .TP |
| 42 | \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR |
| 43 | 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. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 44 | .TP |
| 45 | \fB\-h\fR, \fB\-\-help\fR |
| 46 | A brief message. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 47 | .TP |
| 48 | \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR |
| 49 | When zebra starts its process idenifier is written to |
| 50 | \fB\fIpid-file\fR. The init system uses the recorded PID to stop or |
| 51 | restart zebra. The likely default is \fB\fI/var/run/zebra.pid\fR. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 52 | .TP |
| 53 | \fB\-k\fR, \fB\-\-keep_kernel\fR |
| 54 | On startup, don't delete self inserted routes. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 55 | .TP |
| 56 | \fB\-l\fR, \fB\-\-log_mode\fR |
| 57 | Turn verbose logging on. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 58 | .TP |
| 59 | \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR |
| 60 | Specify the port that the zebra VTY will listen on. This defaults to |
| 61 | 2602, as specified in \fB\fI/etc/services\fR. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 62 | .TP |
hasso | 6c110e7 | 2003-11-27 13:02:03 +0000 | [diff] [blame] | 63 | \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR |
| 64 | Specify the address that the zebra VTY will listen on. Default is all |
| 65 | intrefaces. |
hasso | 6c110e7 | 2003-11-27 13:02:03 +0000 | [diff] [blame] | 66 | .TP |
| 67 | \fB\-u\fR, \fB\-\-user \fR\fIuser\fR |
| 68 | Specify the user and group to run as. User and group have to have same |
| 69 | name at the moment. Default is \fIquagga\fR. |
hasso | 6c110e7 | 2003-11-27 13:02:03 +0000 | [diff] [blame] | 70 | .TP |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 71 | \fB\-r\fR, \fB\-\-retain\fR |
| 72 | When the program terminates, retain routes added by \fBzebra\fR. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 73 | .TP |
| 74 | \fB\-v\fR, \fB\-\-version\fR |
| 75 | Print the version and exit. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 76 | .SH FILES |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 77 | .TP |
| 78 | .BI /usr/local/sbin/zebra |
| 79 | The default location of the |
| 80 | .B zebra |
| 81 | binary. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 82 | .TP |
| 83 | .BI /usr/local/etc/zebra.conf |
| 84 | The default location of the |
| 85 | .B zebra |
| 86 | config file. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 87 | .TP |
| 88 | .BI $(PWD)/zebra.log |
| 89 | If the |
| 90 | .B zebra |
| 91 | process is config'd to output logs to a file, then you will find this |
| 92 | file in the directory where you started \fBzebra\fR. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 93 | .SH WARNING |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 94 | This man page is intended to be a quick reference for command line |
| 95 | options. The definitive document is the Info file \fBQuagga\fR. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 96 | .SH DIAGNOSTICS |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 97 | The zebra process may log to standard output, to a VTY, to a log |
| 98 | file, or through syslog to the system logs. \fBzebra\fR supports many |
| 99 | debugging options, see the Info file, or the source for details. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 100 | .SH "SEE ALSO" |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 101 | .BR bgpd (8), |
| 102 | .BR ripd (8), |
| 103 | .BR ripngd (8), |
| 104 | .BR ospfd (8), |
| 105 | .BR ospf6d (8), |
| 106 | .BR isisd (8), |
| 107 | .BR vtysh (1) |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 108 | .SH BUGS |
| 109 | .B zebra |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 110 | eats bugs for breakfast. If you have food for the maintainers try |
hasso | 2f04e67 | 2004-02-20 18:53:22 +0000 | [diff] [blame] | 111 | .BI http://bugzilla.quagga.net |
hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 112 | .SH AUTHORS |
| 113 | See |
| 114 | .BI http://www.zebra.org |
| 115 | and |
| 116 | .BI http://www.quagga.org |
| 117 | or the Info file for an accurate list of authors. |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 118 | |