summaryrefslogtreecommitdiff
path: root/usr.sbin
diff options
context:
space:
mode:
authorIgor Sobrado <sobrado@cvs.openbsd.org>2008-12-28 22:05:05 +0000
committerIgor Sobrado <sobrado@cvs.openbsd.org>2008-12-28 22:05:05 +0000
commit458e0a5bff35351ad58928b6809093b53753d747 (patch)
tree4a89fa60bb8b1b316a37f69aa339f149091b9c40 /usr.sbin
parenta8d8a614bdf5c5bba0ed63b992edc95771086359 (diff)
a few documentation updates for opsf6(8) and ospf6ctl(8): remove an
existing (but undocumented) flag from the usage of ospf6d; documentation tweaks; while here, synchronize synopsis and usage. ok claudio@
Diffstat (limited to 'usr.sbin')
-rw-r--r--usr.sbin/ospf6ctl/ospf6ctl.811
-rw-r--r--usr.sbin/ospf6ctl/ospf6ctl.c4
-rw-r--r--usr.sbin/ospf6d/ospf6d.810
-rw-r--r--usr.sbin/ospf6d/ospf6d.c4
4 files changed, 14 insertions, 15 deletions
diff --git a/usr.sbin/ospf6ctl/ospf6ctl.8 b/usr.sbin/ospf6ctl/ospf6ctl.8
index 66c7fcf18a9..4d5648299f7 100644
--- a/usr.sbin/ospf6ctl/ospf6ctl.8
+++ b/usr.sbin/ospf6ctl/ospf6ctl.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ospf6ctl.8,v 1.1 2007/10/12 08:22:53 norby Exp $
+.\" $OpenBSD: ospf6ctl.8,v 1.2 2008/12/28 22:05:04 sobrado Exp $
.\"
.\" Copyright (c) 2004, 2005, 2007 Esben Norby <norby@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: October 12 2007 $
+.Dd $Mdocdate: December 28 2008 $
.Dt OSPF6CTL 8
.Os
.Sh NAME
@@ -23,7 +23,7 @@
.Sh SYNOPSIS
.Nm
.Ar command
-.Op Ar arguments ...
+.Op Ar argument ...
.Sh DESCRIPTION
The
.Nm
@@ -34,11 +34,10 @@ daemon.
The following commands are available:
.Bl -tag -width Ds
.It Cm fib couple
-Insert the learned routes into the Forwarding Information Base
+Insert the learned routes into the Forwarding Information Base (FIB),
a.k.a. the kernel routing table.
.It Cm fib decouple
-Remove the learned routes from the Forwarding Information Base
-a.k.a. the kernel routing table.
+Remove the learned routes from the FIB.
Decoupling the FIB from an OSPF router may create routing loops and could cause
major routing issues in the complete OSPF cloud.
Only routers with just one link to the OSPF cloud can safely decouple the FIB.
diff --git a/usr.sbin/ospf6ctl/ospf6ctl.c b/usr.sbin/ospf6ctl/ospf6ctl.c
index e26b0250877..5d62713e2f3 100644
--- a/usr.sbin/ospf6ctl/ospf6ctl.c
+++ b/usr.sbin/ospf6ctl/ospf6ctl.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: ospf6ctl.c,v 1.15 2008/12/28 21:32:33 claudio Exp $ */
+/* $OpenBSD: ospf6ctl.c,v 1.16 2008/12/28 22:05:04 sobrado Exp $ */
/*
* Copyright (c) 2005 Claudio Jeker <claudio@openbsd.org>
@@ -75,7 +75,7 @@ usage(void)
{
extern char *__progname;
- fprintf(stderr, "usage: %s <command> [arg [...]]\n", __progname);
+ fprintf(stderr, "usage: %s command [argument ...]\n", __progname);
exit(1);
}
diff --git a/usr.sbin/ospf6d/ospf6d.8 b/usr.sbin/ospf6d/ospf6d.8
index 74ecf7bb544..2502e1cd842 100644
--- a/usr.sbin/ospf6d/ospf6d.8
+++ b/usr.sbin/ospf6d/ospf6d.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ospf6d.8,v 1.6 2007/10/25 16:10:12 jmc Exp $
+.\" $OpenBSD: ospf6d.8,v 1.7 2008/12/28 22:05:04 sobrado Exp $
.\"
.\" Copyright (c) 2004, 2005, 2007 Esben Norby <norby@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: October 25 2007 $
+.Dd $Mdocdate: December 28 2008 $
.Dt OSPF6D 8
.Os
.Sh NAME
@@ -43,8 +43,8 @@ consisting of routers and networks.
.Pp
Dijkstra's shortest path first algorithm is used to compute the Route
Information Base using the LSDB as input.
-The Forwarding Information Base a.k.a. the kernel route table is updated
-with information from the RIB.
+The Forwarding Information Base (FIB), a.k.a. the kernel routing table,
+is updated with information from the RIB.
.Pp
OSPF routers communicate via two multicast groups: ff02::5 all Shortest
Path First routers and ff02::6 all Designated Routers.
@@ -87,7 +87,7 @@ election is skipped since only two routers are connected.
.Pp
To limit the impact changes in the network have on the LSDB it is possible
to segment an OSPF network into areas.
-Area 0.0.0.0 a.k.a. the backbone area must always be present.
+Area 0.0.0.0 (a.k.a. the backbone area) must always be present.
Routers can be configured as Area Border Router
.Pq ABR ,
being part of multiple areas.
diff --git a/usr.sbin/ospf6d/ospf6d.c b/usr.sbin/ospf6d/ospf6d.c
index 869122e3b0b..867d1861561 100644
--- a/usr.sbin/ospf6d/ospf6d.c
+++ b/usr.sbin/ospf6d/ospf6d.c
@@ -1,4 +1,4 @@
-/* $OpenBSD: ospf6d.c,v 1.10 2008/05/13 11:46:57 pyr Exp $ */
+/* $OpenBSD: ospf6d.c,v 1.11 2008/12/28 22:05:04 sobrado Exp $ */
/*
* Copyright (c) 2005 Claudio Jeker <claudio@openbsd.org>
@@ -118,7 +118,7 @@ usage(void)
{
extern char *__progname;
- fprintf(stderr, "usage: %s [-cdnv] [-D macro=value] [-f file]\n",
+ fprintf(stderr, "usage: %s [-dnv] [-D macro=value] [-f file]\n",
__progname);
exit(1);
}