]>
Commit | Line | Data |
---|---|---|
a07169b1 | 1 | .TH BGPD 8 "25 November 2004" "@PACKAGE_FULLNAME@ BGPD daemon" "Version @PACKAGE_VERSION@" |
718e3744 | 2 | .SH NAME |
a07169b1 | 3 | bgpd \- a BGPv4, BGPv4\+, BGPv4\- routing engine for use with @PACKAGE_FULLNAME@. |
718e3744 | 4 | |
5 | .SH SYNOPSIS | |
6 | .B bgpd | |
7 | [ | |
a008f49a | 8 | .B \-dhrSv |
246c135e | 9 | ] [ |
10 | .B \-f | |
11 | .I config-file | |
12 | ] [ | |
13 | .B \-i | |
14 | .I pid-file | |
15 | ] [ | |
16 | .B \-p | |
17 | .I bgp-port-number | |
18 | ] [ | |
246c135e | 19 | .B \-P |
20 | .I port-number | |
21 | ] [ | |
22 | .B \-A | |
23 | .I vty-address | |
24 | ] [ | |
25 | .B \-u | |
26 | .I user | |
c065230a | 27 | ] [ |
28 | .B \-g | |
29 | .I group | |
6b0275ac DL |
30 | ] [ |
31 | .B \-M | |
32 | .I module:options | |
718e3744 | 33 | ] |
718e3744 | 34 | .SH DESCRIPTION |
35 | .B bgpd | |
36 | is a routing component that works with the | |
a07169b1 | 37 | .B @PACKAGE_FULLNAME@ |
718e3744 | 38 | routing engine. |
718e3744 | 39 | .SH OPTIONS |
246c135e | 40 | Options available for the |
41 | .B bgpd | |
42 | command: | |
718e3744 | 43 | .TP |
44 | \fB\-d\fR, \fB\-\-daemon\fR | |
45 | Runs in daemon mode, forking and exiting from tty. | |
718e3744 | 46 | .TP |
47 | \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR | |
48 | Specifies the config file to use for startup. If not specified this | |
a07169b1 | 49 | option will default to \fB\fI@CFG_SYSCONF@/bgpd.conf\fR. |
718e3744 | 50 | .TP |
c065230a | 51 | \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR |
a07169b1 | 52 | Specify the group to run as. Default is \fI@enable_group@\fR. |
c065230a | 53 | .TP |
718e3744 | 54 | \fB\-h\fR, \fB\-\-help\fR |
55 | A brief message. | |
718e3744 | 56 | .TP |
57 | \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR | |
a0e64a63 | 58 | When bgpd starts its process identifier is written to |
718e3744 | 59 | \fB\fIpid-file\fR. The init system uses the recorded PID to stop or |
a07169b1 | 60 | restart bgpd. The default is \fB\fI@CFG_STATE@/bgpd.pid\fR. |
718e3744 | 61 | .TP |
c065230a | 62 | \fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR |
718e3744 | 63 | Set the port that bgpd will listen to for bgp data. |
718e3744 | 64 | .TP |
65 | \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR | |
66 | Specify the port that the bgpd VTY will listen on. This defaults to | |
67 | 2605, as specified in \fI/etc/services\fR. | |
6c110e70 | 68 | .TP |
69 | \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR | |
70 | Specify the address that the bgpd VTY will listen on. Default is all | |
151fe8a4 | 71 | interfaces. |
6c110e70 | 72 | .TP |
73 | \fB\-u\fR, \fB\-\-user \fR\fIuser\fR | |
a07169b1 | 74 | Specify the user to run as. Default is \fI@enable_user@\fR. |
718e3744 | 75 | .TP |
76 | \fB\-r\fR, \fB\-\-retain\fR | |
77 | When the program terminates, retain routes added by \fBbgpd\fR. | |
718e3744 | 78 | .TP |
a008f49a LB |
79 | \fB\-S\fR, \fB\-\-skip_runas\fR |
80 | Skip setting the process effective user and group. | |
81 | .TP | |
6b0275ac DL |
82 | \fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR |
83 | Load a module at startup. May be specified more than once. | |
84 | The \fBsnmp\fR module may be available for | |
85 | \fBbgpd\fR, if the package was built with SNMP support. | |
86 | .TP | |
718e3744 | 87 | \fB\-v\fR, \fB\-\-version\fR |
88 | Print the version and exit. | |
718e3744 | 89 | .SH FILES |
718e3744 | 90 | .TP |
a07169b1 | 91 | .BI @CFG_SBIN@/bgpd |
718e3744 | 92 | The default location of the |
93 | .B bgpd | |
94 | binary. | |
718e3744 | 95 | .TP |
a07169b1 | 96 | .BI @CFG_SYSCONF@/bgpd.conf |
718e3744 | 97 | The default location of the |
98 | .B bgpd | |
99 | config file. | |
718e3744 | 100 | .TP |
101 | .BI $(PWD)/bgpd.log | |
102 | If the | |
103 | .B bgpd | |
104 | process is config'd to output logs to a file, then you will find this | |
105 | file in the directory where you started \fBbgpd\fR. | |
718e3744 | 106 | .SH WARNING |
246c135e | 107 | This man page is intended to be a quick reference for command line |
a07169b1 | 108 | options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. |
718e3744 | 109 | .SH DIAGNOSTICS |
110 | The bgpd process may log to standard output, to a VTY, to a log | |
111 | file, or through syslog to the system logs. \fBbgpd\fR supports many | |
112 | debugging options, see the Info file, or the source for details. | |
718e3744 | 113 | .SH "SEE ALSO" |
246c135e | 114 | .BR ripd (8), |
115 | .BR ripngd (8), | |
116 | .BR ospfd (8), | |
117 | .BR ospf6d (8), | |
118 | .BR isisd (8), | |
caba6093 | 119 | .BR nhrpd (8), |
246c135e | 120 | .BR zebra (8), |
121 | .BR vtysh (1) | |
718e3744 | 122 | .SH BUGS |
123 | .B bgpd | |
124 | eats bugs for breakfast. If you have food for the maintainers try | |
a07169b1 | 125 | .BI @PACKAGE_BUGREPORT@ |
246c135e | 126 | .SH AUTHORS |
127 | See | |
128 | .BI http://www.zebra.org | |
129 | and | |
a07169b1 | 130 | .BI @PACKAGE_URL@ |
246c135e | 131 | or the Info file for an accurate list of authors. |
718e3744 | 132 |