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