summaryrefslogtreecommitdiff
path: root/usr.sbin/bgpd
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2004-07-13 19:53:02 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2004-07-13 19:53:02 +0000
commit1fe54e04fa926e442498ef0ab01e9e5fe5fbba68 (patch)
treef30909904765fccbefd0d6432594c82490a15c46 /usr.sbin/bgpd
parentae5e43b6a0c38853f6c1c27a8915b9886f944c39 (diff)
tweaks; ok henning@
Diffstat (limited to 'usr.sbin/bgpd')
-rw-r--r--usr.sbin/bgpd/bgpd.868
1 files changed, 55 insertions, 13 deletions
diff --git a/usr.sbin/bgpd/bgpd.8 b/usr.sbin/bgpd/bgpd.8
index 222249321a6..f66bee7ad1c 100644
--- a/usr.sbin/bgpd/bgpd.8
+++ b/usr.sbin/bgpd/bgpd.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bgpd.8,v 1.11 2004/07/09 11:01:22 henning Exp $
+.\" $OpenBSD: bgpd.8,v 1.12 2004/07/13 19:53:01 jmc Exp $
.\"
.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
.\"
@@ -24,16 +24,52 @@
.Nm bgpd
.Bk -words
.Op Fl dnv
-.Op Fl D Ar macro=value
+.Oo Xo
+.Fl D Ar macro Ns = Ns Ar value Oc
+.Xc
.Op Fl f Ar file
.Ek
.Sh DESCRIPTION
.Nm
-is a daemon usually invoked at boot time to manage the network routing tables.
-It uses the Border Gateway Protocol, Version 4, as described in RFC 1771.
+is a Border Gateway Protocol
+.Pq BGP
+daemon which manages the network routing tables.
+Its main purpose is to exchange information with other BGP systems
+describing
+.Qq network reachability .
+.Nm
+uses the Border Gateway Protocol, Version 4,
+as described in RFC 1771.
+Please refer to that document for more information about BGP.
+.Pp
+.Nm
+is usually started at boot time, and can be enabled by
+setting the following in
+.Pa /etc/rc.conf.local :
+.Pp
+.Dl bgpd_flags=\&"\&"
+.Pp
+See
+.Xr rc 8
+and
+.Xr rc.conf 8
+for more information on the boot process
+and enabling daemons.
+.Pp
+When
+.Nm
+starts up, it reads settings from a configuration file,
+typically
+.Xr bgpd.conf 5 .
+A running
+.Nm
+process can be controlled using the
+.Xr bgpctl 8
+utility.
+.Pp
The options are as follows:
-.Bl -tag -width Ds
-.It Fl D Ar macro=value
+.Bl -tag -width "-f fileXXX"
+.It Fl D Ar macro Ns = Ns Ar value
Define
.Ar macro
to be set to
@@ -43,23 +79,29 @@ Overrides the definition of
.Ar macro
in the configuration file.
.It Fl d
-Do not daemonize and log to
+Do not daemonize.
+If this option is specified,
+.Nm
+will run in the foreground and log to
.Em stderr .
.It Fl f Ar file
-Specify an alternate location,
-.Ar file ,
-for the configuration file.
+Use
+.Ar file
+as the configuration file,
+instead of the default
+.Pa /etc/bgpd.conf .
.It Fl n
Configtest mode.
-Only check the config file for validity.
+Only check the configuration file for validity.
.It Fl v
Produce more verbose output.
.El
.Sh FILES
-.Bl -tag -width "/etc/bgpd.conf" -compact
+.Bl -tag -width "/etc/bgpd.confXXX" -compact
.It Pa /etc/bgpd.conf
+default
.Nm
-configuration file.
+configuration file
.El
.Sh SEE ALSO
.Xr bgpd.conf 5 ,