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