bgpd.8 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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. .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. .SH DESCRIPTION
  32. .B bgpd
  33. is a routing component that works with the
  34. .B Quagga
  35. routing engine.
  36. .SH OPTIONS
  37. Options available for the
  38. .B bgpd
  39. command:
  40. .TP
  41. \fB\-d\fR, \fB\-\-daemon\fR
  42. Runs in daemon mode, forking and exiting from tty.
  43. .TP
  44. \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  45. Specifies the config file to use for startup. If not specified this
  46. option will likely default to \fB\fI/usr/local/etc/bgpd.conf\fR.
  47. .TP
  48. \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  49. Specify the group to run as. Default is \fIquagga\fR.
  50. .TP
  51. \fB\-h\fR, \fB\-\-help\fR
  52. A brief message.
  53. .TP
  54. \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  55. When bgpd starts its process identifier is written to
  56. \fB\fIpid-file\fR. The init system uses the recorded PID to stop or
  57. restart bgpd. The likely default is \fB\fI/var/run/bgpd.pid\fR.
  58. .TP
  59. \fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR
  60. Set the port that bgpd will listen to for bgp data.
  61. .TP
  62. \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  63. Specify the port that the bgpd VTY will listen on. This defaults to
  64. 2605, as specified in \fI/etc/services\fR.
  65. .TP
  66. \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  67. Specify the address that the bgpd VTY will listen on. Default is all
  68. interfaces.
  69. .TP
  70. \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  71. Specify the user to run as. Default is \fIquagga\fR.
  72. .TP
  73. \fB\-r\fR, \fB\-\-retain\fR
  74. When the program terminates, retain routes added by \fBbgpd\fR.
  75. .TP
  76. \fB\-S\fR, \fB\-\-skip_runas\fR
  77. Skip setting the process effective user and group.
  78. .TP
  79. \fB\-v\fR, \fB\-\-version\fR
  80. Print the version and exit.
  81. .SH FILES
  82. .TP
  83. .BI /usr/local/sbin/bgpd
  84. The default location of the
  85. .B bgpd
  86. binary.
  87. .TP
  88. .BI /usr/local/etc/bgpd.conf
  89. The default location of the
  90. .B bgpd
  91. config file.
  92. .TP
  93. .BI $(PWD)/bgpd.log
  94. If the
  95. .B bgpd
  96. process is config'd to output logs to a file, then you will find this
  97. file in the directory where you started \fBbgpd\fR.
  98. .SH WARNING
  99. This man page is intended to be a quick reference for command line
  100. options. The definitive document is the Info file \fBQuagga\fR.
  101. .SH DIAGNOSTICS
  102. The bgpd process may log to standard output, to a VTY, to a log
  103. file, or through syslog to the system logs. \fBbgpd\fR supports many
  104. debugging options, see the Info file, or the source for details.
  105. .SH "SEE ALSO"
  106. .BR ripd (8),
  107. .BR ripngd (8),
  108. .BR ospfd (8),
  109. .BR ospf6d (8),
  110. .BR isisd (8),
  111. .BR nhrpd (8),
  112. .BR zebra (8),
  113. .BR vtysh (1)
  114. .SH BUGS
  115. .B bgpd
  116. eats bugs for breakfast. If you have food for the maintainers try
  117. .BI http://bugzilla.quagga.net
  118. .SH AUTHORS
  119. See
  120. .BI http://www.zebra.org
  121. and
  122. .BI http://www.quagga.net
  123. or the Info file for an accurate list of authors.