diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2005-02-02 22:51:00 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2005-02-02 22:51:00 +0000 |
commit | 07ecc9e018b5ac5646e14295a97a6d4d08e6ae35 (patch) | |
tree | 4857052d68702b64320e2b11e8ea378a13d46116 /usr.sbin/ospfd/ospfd.conf.5 | |
parent | d250713c1eef7093c5c22a829d45ae0075bc104d (diff) |
various fixes;
Diffstat (limited to 'usr.sbin/ospfd/ospfd.conf.5')
-rw-r--r-- | usr.sbin/ospfd/ospfd.conf.5 | 98 |
1 files changed, 53 insertions, 45 deletions
diff --git a/usr.sbin/ospfd/ospfd.conf.5 b/usr.sbin/ospfd/ospfd.conf.5 index a87c967d505..04f30c46d92 100644 --- a/usr.sbin/ospfd/ospfd.conf.5 +++ b/usr.sbin/ospfd/ospfd.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ospfd.conf.5,v 1.1 2005/02/02 21:22:28 norby Exp $ +.\" $OpenBSD: ospfd.conf.5,v 1.2 2005/02/02 22:50:59 jmc Exp $ .\" .\" Copyright (c) 2005 Esben Norby <norby@openbsd.org> .\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org> @@ -38,18 +38,19 @@ User-defined variables may be defined and used later, simplifying the configuration file. .It Sy Global Configuration Global settings for -.Xr ospfd 8 . A number of global settings can be overruled in specfic areas or -interfaces. +.Xr ospfd 8 . +A number of global settings can be overruled in specfic areas or interfaces. .It Sy Areas -An OSPF router must be a member of at least one area. Areas are used to group -interfaces, simplifying configuration. +An OSPF router must be a member of at least one area. +Areas are used to group interfaces, simplifying configuration. +.El .Sh MACROS Much like .Xr cpp 1 or .Xr m4 1 , macros can be defined that will later be expanded in context. -Macro names must start with a letter, and may contain letters, digits +Macro names must start with a letter, and may contain letters, digits, and underscores. Macro names may not be reserved words (for example, .Ic area , @@ -58,7 +59,7 @@ or .Ic hello-interval ) . Macros are not expanded inside quotes. .Pp -For example, +For example: .Bd -literal -offset indent hi="5" area 0.0.0.0 { @@ -70,11 +71,10 @@ area 0.0.0.0 { .Pp The same can be accomplished by specifying the hello-interval globally or within the area declaration. -.Pp .Sh GLOBAL CONFIGURATION All interface related settings can be configured globally, per area and per -interface. The only settings that can be set globally and not overuled are -listed below. +interface. +The only settings that can be set globally and not overruled are listed below. .Pp .Bl -tag -width Ds -compact .It Xo @@ -89,27 +89,29 @@ The default is .Ic yes . .Pp .It Ic router-id Ar address -Set the router ID, if not specified the the lowest IP address of the router +Set the router ID; if not specified, the lowest IP address of the router will be used. -.Pp .\".It Ic spf-delay Ar seconds -.\"Set SPF delay in seconds. The delay between receiving an update to the link -.\"state database and starting the shortest path first calculation. The default -.\"value is 1, valid range is 1-10 seconds. +.\"Set SPF delay in seconds. +.\"The delay between receiving an update to the link +.\"state database and starting the shortest path first calculation. +.\"The default value is 1; valid range is 1\-10 seconds. .\".Pp .\".It Ic spf-holdtime Ar seconds -.\"Set the SPF holdtime in seconds. The minimum time between two consecutive -.\"shortest path first calculations. The default value is 5 seconds, the valid -.\"is range 1-5 seconds. +.\"Set the SPF holdtime in seconds. +.\"The minimum time between two consecutive +.\"shortest path first calculations. +.\"The default value is 5 seconds; the valid is range 1\-5 seconds. .\".Pp +.El .Sh AREAS -Areas are used for grouping interfaces. All interface specific parameters can +Areas are used for grouping interfaces. +All interface specific parameters can be configured per area, overruling the global settings. .Pp .Bl -tag -width Ds -compact .It Ic area Ar address Specify an area section, grouping one or more interfaces. -.Pp .Bd -literal -offset indent area 0.0.0.0 { interface em0 { @@ -118,59 +120,66 @@ area 0.0.0.0 { } } .Ed -.Pp +.El .Sh INTERFACES -Each interface can have several parameteres configured individually, otherwise -they are enherited. -.Pp +Each interface can have several parameters configured individually, otherwise +they are inherited. .Bd -literal -offset indent - interface em0 { - } +interface em0 { +} .Ed .Pp Interface specific parameters are listed below. .Pp .Bl -tag -width Ds -compact .It Ic auth-key Ar key -Set the authentication key. If the auth-type is set to simple, up to 8 -characters can be specified. +Set the authentication key. +If the auth-type is set to simple, up to 8 characters can be specified. .Pp .It Xo .Ic auth-type .Po Ic none Ns \&| Ns .Ic simple Ns \&| Ns Ic crypt Pc .Xc -Set the authentication type. The default is none. Simple authentication uses a -plaintext pssword, up to 8 characters. Crypt authentication uses a MD5 hash. +Set the authentication type. +The default is none. +Simple authentication uses a plaintext password, up to 8 characters. +Crypt authentication uses an MD5 hash. .Pp .It Ic hello-interval Ar seconds -Set the hello interval. The default value is 10, valid range is 1-65535 seconds. +Set the hello interval. +The default value is 10; valid range is 1\-65535 seconds. .Pp .It Ic metric Ar cost -Set the interface metric a.k.a. cost. The default value is 10, valid range is -1-65535. +Set the interface metric a.k.a. cost. +The default value is 10; valid range is 1\-65535. .Pp .It Ic passive Prevent transmission and reception of OSPF packets on this interface. .Pp .It Ic retransmit-interval Ar seconds -Set retransmit interval. The default value is 5 seconds, valid range is 5-3600 -seconds. +Set retransmit interval. +The default value is 5 seconds; valid range is 5\-3600 seconds. .Pp .It Ic router-dead-time Ar seconds -Set the router dead time, a.k.a. neighbor inactivity timer. The default value -is 40 seconds, valid range is 2-2147483647 seconds. When a neigbhor has been -inactive for router-dead-time it's state is set to DOWN. Neighbors +Set the router dead time, a.k.a. neighbor inactivity timer. +The default value is 40 seconds; valid range is 2\-2147483647 seconds. +When a neighbor has been +inactive for router-dead-time its state is set to DOWN. +Neighbors that have been inactive for more than 24 hours are completely removed. .Pp .It Ic router-priority Ar seconds -Set the router priority. The default value is 1, valid range is 0-255. If set -to 0 the router is not elegible as Desginated Router or Backup Designated +Set the router priority. +The default value is 1; valid range is 0\-255. +If set +to 0 the router is not eligible as a Designated Router or Backup Designated Router. .Pp .It Ic transmit-delay Ar seconds -Set the transmit delay. The default value is 1, valid range is 1-3600 seconds. -.Pp +Set the transmit delay. +The default value is 1; valid range is 1\-3600 seconds. +.El .Sh FILES .Bl -tag -width "/etc/ospfd.conf" -compact .It Pa /etc/ospfd.conf @@ -178,12 +187,11 @@ Set the transmit delay. The default value is 1, valid range is 1-3600 seconds. configuration file .El .Sh SEE ALSO -.Xr ospfctl 8 -.Xr ospfd 8 +.Xr ospfctl 8 , +.Xr ospfd 8 , .Xr rc.conf.local 8 .Sh HISTORY The .Nm file format first appeared in .Ox 3.7 . - |