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