doc/bgpd.8.in

   1 .TH BGPD 8 "25 November 2004" "@PACKAGE_FULLNAME@ BGPD daemon" "Version @PACKAGE_VERSION@"
   2 .SH NAME
   3 bgpd \- a BGPv4, BGPv4\+, BGPv4\- routing engine for use with @PACKAGE_FULLNAME@.
   4
   5 .SH SYNOPSIS
   6 .B bgpd
   7 [
   8 .B \-dhrSv
   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 ] [
  19 .B \-P
  20 .I port-number
  21 ] [
  22 .B \-A
  23 .I vty-address
  24 ] [
  25 .B \-u
  26 .I user
  27 ] [
  28 .B \-g
  29 .I group
  30 ] [
  31 .B \-M
  32 .I module:options
  33 ]
  34 .SH DESCRIPTION
  35 .B bgpd
  36 is a routing component that works with the
  37 .B @PACKAGE_FULLNAME@
  38 routing engine.
  39 .SH OPTIONS
  40 Options available for the
  41 .B bgpd
  42 command:
  43 .TP
  44 \fB\-d\fR, \fB\-\-daemon\fR
  45 Runs in daemon mode, forking and exiting from tty.
  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
  49 option will default to \fB\fI@CFG_SYSCONF@/bgpd.conf\fR.
  50 .TP
  51 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  52 Specify the group to run as. Default is \fI@enable_group@\fR.
  53 .TP
  54 \fB\-h\fR, \fB\-\-help\fR
  55 A brief message.
  56 .TP
  57 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  58 When bgpd starts its process identifier is written to
  59 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  60 restart bgpd.  The default is \fB\fI@CFG_STATE@/bgpd.pid\fR.
  61 .TP
  62 \fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR
  63 Set the port that bgpd will listen to for bgp data.
  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.
  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
  71 interfaces.
  72 .TP
  73 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  74 Specify the user to run as. Default is \fI@enable_user@\fR.
  75 .TP
  76 \fB\-r\fR, \fB\-\-retain\fR
  77 When the program terminates, retain routes added by \fBbgpd\fR.
  78 .TP
  79 \fB\-S\fR, \fB\-\-skip_runas\fR
  80 Skip setting the process effective user and group.
  81 .TP
  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
  87 \fB\-v\fR, \fB\-\-version\fR
  88 Print the version and exit.
  89 .SH FILES
  90 .TP
  91 .BI @CFG_SBIN@/bgpd
  92 The default location of the
  93 .B bgpd
  94 binary.
  95 .TP
  96 .BI @CFG_SYSCONF@/bgpd.conf
  97 The default location of the
  98 .B bgpd
  99 config file.
 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.
 106 .SH WARNING
 107 This man page is intended to be a quick reference for command line
 108 options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
 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.
 113 .SH "SEE ALSO"
 114 .BR ripd (8),
 115 .BR ripngd (8),
 116 .BR ospfd (8),
 117 .BR ospf6d (8),
 118 .BR isisd (8),
 119 .BR nhrpd (8),
 120 .BR zebra (8),
 121 .BR vtysh (1)
 122 .SH BUGS
 123 .B bgpd
 124 eats bugs for breakfast. If you have food for the maintainers try
 125 .BI @PACKAGE_BUGREPORT@
 126 .SH AUTHORS
 127 See
 128 .BI http://www.zebra.org
 129 and
 130 .BI @PACKAGE_URL@
 131 or the Info file for an accurate list of authors.
 132