xref: /netbsd/usr.sbin/arp/arp.8 (revision bf9ec67e)
1.\"	$NetBSD: arp.8,v 1.14 2002/01/22 01:35:39 enami Exp $
2.\"
3.\" Copyright (c) 1985, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	from: @(#)arp.8	8.2 (Berkeley) 4/27/95
35.\"
36.Dd April 27, 1995
37.Dt ARP 8
38.Os
39.Sh NAME
40.Nm arp
41.Nd address resolution display and control
42.Sh SYNOPSIS
43.Nm
44.Op Fl n
45.Ar hostname
46.Nm ""
47.Op Fl nv
48.Fl a
49.Nm ""
50.Op Fl v
51.Fl d
52.Op Fl a | Ar hostname
53.Nm ""
54.Fl s Ar hostname ether_addr
55.Op Ar temp
56.Op Ar pub
57.Nm ""
58.Fl f Ar filename
59.Sh DESCRIPTION
60The
61.Nm
62program displays and modifies the Internet-to-Ethernet address translation
63tables used by the address resolution protocol
64.Pq Xr arp 4 .
65With no flags, the program displays the current
66.Tn ARP
67entry for
68.Ar hostname .
69The host may be specified by name or by number,
70using Internet dot notation.
71.Pp
72Available options:
73.Bl -tag -width Ds
74.It Fl a
75The program displays all of the current
76.Tn ARP
77entries.
78.It Fl d
79A super-user may delete an entry for the host called
80.Ar hostname
81with the
82.Fl d
83flag.  If used with
84.Fl a
85instead of a
86.Ar hostname ,
87it will delete all arp entries.
88.It Fl n
89Show network addresses as numbers (normally
90.Nm
91attempts to display addresses symbolically).
92.It Fl s Ar hostname ether_addr
93Create an
94.Tn ARP
95entry for the host called
96.Ar hostname
97with the Ethernet address
98.Ar ether_addr .
99The Ethernet address is given as six hex bytes separated by colons.
100The entry will be permanent unless the word
101.Ar temp
102is given in the command.
103If the word
104.Ar pub
105is given, the entry will be "published"; i.e., this system will
106act as an
107.Tn ARP
108server,
109responding to requests for
110.Ar hostname
111even though the host address is not its own.
112.It Fl f
113Causes the file
114.Ar filename
115to be read and multiple entries to be set in the
116.Tn ARP
117tables.  Entries
118in the file should be of the form
119.Pp
120.Bd -filled -offset indent -compact
121.Ar hostname ether_addr
122.Op Ar temp
123.Op Ar pub
124.Ed
125.Pp
126with argument meanings as given above.
127.It Fl v
128Display verbose information when adding or deleting
129.Tn ARP
130entries.
131.El
132.Sh SEE ALSO
133.Xr inet 3 ,
134.Xr arp 4 ,
135.Xr ifconfig 8
136.Sh HISTORY
137The
138.Nm
139command appeared in
140.Bx 4.3 .
141