various cleanup:

- fix examples
- fix macro abuse
- hex -> hexadecimal
- rewording for clarity and consistency
- make -a description seem less dangerous
- sort options

work, help, ok jmc
ok otto

1 files changed, 54 insertions, 48 deletions

diff --git a/usr.sbin/arp/arp.8 b/usr.sbin/arp/arp.8
index 8a37d5ae8c2..128b2be5084 100644
--- a/usr.sbin/arp/arp.8
+++ b/usr.sbin/arp/arp.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: arp.8,v 1.13 2003/06/02 23:36:52 millert Exp $
+.\"	$OpenBSD: arp.8,v 1.14 2004/07/09 19:54:41 jaredy Exp $
 .\"	$NetBSD: arp.8,v 1.7 1995/03/01 11:50:59 chopps Exp $
 .\"
 .\" Copyright (c) 1985, 1991, 1993
@@ -49,8 +49,8 @@
 .Fl d a
 .Nm arp
 .Fl s Ar hostname ether_addr
-.Op Ar temp | permanent
-.Op Ar pub
+.Op Cm temp | permanent
+.Op Cm pub
 .Nm arp
 .Fl f Ar filename
 .Sh DESCRIPTION
@@ -69,43 +69,46 @@ using Internet dot notation.
 Available options:
 .Bl -tag -width Ds
 .It Fl a
-The program displays or deletes all of the current
+Display all of the current
 .Tn ARP
 entries.
-.It Fl d
-A superuser may delete an entry for the host called
-.Ar hostname
-with the
+See also the
 .Fl d
-flag.
-.Pp
+option below.
+.It Fl d
+Delete an entry for the host called
+.Ar hostname .
 Alternatively, the
 .Fl d
 flag may be combined with the
 .Fl a
 flag to delete all entries, with hostname lookups automatically
 disabled.
-.It Fl n
-Show network addresses as numbers (normally
-.Nm
-attempts to display addresses symbolically).
-.It Fl s Ar hostname ether_addr
-Create an
+Only the superuser may delete entries.
+.It Fl f Ar filename
+Process entries from
+.Ar filename
+to be set in the
 .Tn ARP
-entry for the host called
-.Ar hostname
-with the Ethernet address
-.Ar ether_addr .
-The Ethernet address is given as six hex bytes separated by
-colons.
-The entry will be static, i.e., not time out, unless the word
-.Ar temp
+tables.
+Entries in the file should be of the form:
+.Pp
+.Bd -filled -offset indent -compact
+.Ar hostname ether_addr
+.Op Cm temp | permanent
+.Op Cm pub
+.Ed
+.Pp
+The entry will be static, i.e., will not time out, unless the word
+.Cm temp
 is given in the command.
-A static ARP entry can be overwritten by network traffic, unless the word
-.Ar permanent
+A static
+.Tn ARP
+entry can be overwritten by network traffic, unless the word
+.Cm permanent
 is given.
 If the word
-.Ar pub
+.Cm pub
 is given, the entry will be
 .Dq published ;
 i.e., this system will
@@ -116,45 +119,48 @@ responding to requests for
 .Ar hostname
 even though the host address is not its own.
 This behavior has traditionally been called
-.Em "proxy arp" .
-.It Fl f
-Causes the file
-.Ar filename
-to be read and multiple entries to be set in the
+.Em proxy ARP .
+.It Fl n
+Show network addresses as numbers (normally
+.Nm
+attempts to display addresses symbolically).
+.It Fl s Ar hostname ether_addr
+Create an
 .Tn ARP
-tables.
-Entries in the file should be of the form
-.Pp
-.Bd -filled -offset indent -compact
-.Ar hostname ether_addr
-.Op Ar temp | permanent
-.Op Ar pub
-.Ed
+entry for the host called
+.Ar hostname
+with the Ethernet address
+.Ar ether_addr .
+The Ethernet address is given as six hexadecimal bytes separated by
+colons.
 .Pp
-with argument meanings as given above.
+The
+.Cm permanent , pub ,
+or
+.Cm temp
+modifiers may be specified with meanings as given above.
 .El
 .Sh EXAMPLES
 To view the current
-.Nm
+.Xr arp 4
 table:
 .Pp
 .Dl $ arp -a
 .Pp
 To create a
 .Em permanent
-.Nm entry
-(One that cannot be overwritten by other network traffic):
+entry (one that cannot be overwritten by other network traffic):
 .Pp
 .Dl # arp -s 10.0.0.2 00:90:27:bb:cc:dd permanent
 .Pp
 To create
-.Em proxy arp
+.Em proxy ARP
 entries on an interface, fxp0,
-for the IP Addresses 204.1.2.3 and 204.1.2.4, do a:
+for the IP addresses 204.1.2.3 and 204.1.2.4:
 .Pp
 .Bd -unfilled -offset indent -compact
-# arp -s 209.1.2.3 00:90:27:bb:cc:dd pub
-# arp -s 209.1.2.4 00:90:27:bb:cc:dd pub
+# arp -s 204.1.2.3 00:90:27:bb:cc:dd pub
+# arp -s 204.1.2.4 00:90:27:bb:cc:dd pub
 .Ed
 .Pp
 (where 00:90:27:bb:cc:dd is the MAC address of fxp0)