Return to bgpd.8 CVS log

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

quagga

    1: .TH BGPD 8 "25 November 2004" "Quagga BGPD daemon" "Version 0.97.3"
    2: .SH NAME
    3: bgpd \- a BGPv4, BGPv4\+, BGPv4\- routing engine for use with Quagga routing
    4: software
    5: 
    6: .SH SYNOPSIS
    7: .B bgpd
    8: [
    9: .B \-dhrv
   10: ] [
   11: .B \-f
   12: .I config-file
   13: ] [
   14: .B \-i
   15: .I pid-file
   16: ] [
   17: .B \-p
   18: .I bgp-port-number
   19: ] [
   20: .B \-P
   21: .I port-number
   22: ] [
   23: .B \-A
   24: .I vty-address
   25: ] [
   26: .B \-u
   27: .I user
   28: ] [
   29: .B \-g
   30: .I group
   31: ]
   32: .SH DESCRIPTION
   33: .B bgpd 
   34: is a routing component that works with the 
   35: .B Quagga
   36: routing engine.
   37: .SH OPTIONS
   38: Options available for the
   39: .B bgpd
   40: command:
   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/bgpd.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 bgpd starts its process identifier is written to
   57: \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
   58: restart bgpd.  The likely default is \fB\fI/var/run/bgpd.pid\fR.
   59: .TP
   60: \fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR
   61: Set the port that bgpd will listen to for bgp data.  
   62: .TP
   63: \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
   64: Specify the port that the bgpd VTY will listen on. This defaults to
   65: 2605, as specified in \fI/etc/services\fR.
   66: .TP
   67: \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
   68: Specify the address that the bgpd 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 \fBbgpd\fR.
   76: .TP
   77: \fB\-v\fR, \fB\-\-version\fR
   78: Print the version and exit.
   79: .SH FILES
   80: .TP
   81: .BI /usr/local/sbin/bgpd
   82: The default location of the 
   83: .B bgpd
   84: binary.
   85: .TP
   86: .BI /usr/local/etc/bgpd.conf
   87: The default location of the 
   88: .B bgpd
   89: config file.
   90: .TP
   91: .BI $(PWD)/bgpd.log 
   92: If the 
   93: .B bgpd
   94: process is config'd to output logs to a file, then you will find this
   95: file in the directory where you started \fBbgpd\fR.
   96: .SH WARNING
   97: This man page is intended to be a quick reference for command line
   98: options. The definitive document is the Info file \fBQuagga\fR.
   99: .SH DIAGNOSTICS
  100: The bgpd process may log to standard output, to a VTY, to a log
  101: file, or through syslog to the system logs. \fBbgpd\fR supports many
  102: debugging options, see the Info file, or the source for details.
  103: .SH "SEE ALSO"
  104: .BR ripd (8),
  105: .BR ripngd (8),
  106: .BR ospfd (8),
  107: .BR ospf6d (8),
  108: .BR isisd (8),
  109: .BR zebra (8),
  110: .BR vtysh (1)
  111: .SH BUGS
  112: .B bgpd
  113: eats bugs for breakfast. If you have food for the maintainers try 
  114: .BI http://bugzilla.quagga.net
  115: .SH AUTHORS
  116: See
  117: .BI http://www.zebra.org
  118: and
  119: .BI http://www.quagga.net
  120: or the Info file for an accurate list of authors.
  121: