xref: /freebsd/usr.sbin/arp/arp.8 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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.\"
34.Dd June 6, 1993
35.Dt ARP 8
36.Os BSD 4.3
37.Sh NAME
38.Nm arp
39.Nd address resolution display and control
40.Sh SYNOPSIS
41.Nm arp
42.Op Fl n
43.Ar hostname
44.Nm arp
45.Op Fl n
46.Fl a
47.Nm arp
48.Fl d Ar hostname
49.Nm arp
50.Fl s Ar hostname ether_addr
51.Op Ar temp
52.Op Ar pub
53.Nm arp
54.Fl S Ar hostname ether_addr
55.Op Ar temp
56.Op Ar pub
57.Nm arp
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.
84.It Fl n
85Show network addresses as numbers (normally
86.Nm
87attempts to display addresses symbolically).
88.It Fl s Ar hostname ether_addr
89Create an
90.Tn ARP
91entry for the host called
92.Ar hostname
93with the Ethernet address
94.Ar ether_addr .
95The Ethernet address is given as six hex bytes separated by colons.
96The entry will be permanent unless the word
97.Ar temp
98is given in the command.
99If the word
100.Ar pub
101is given, the entry will be "published"; i.e., this system will
102act as an
103.Tn ARP
104server,
105responding to requests for
106.Ar hostname
107even though the host address is not its own.
108In this case the ether_addr can be given as ``auto''
109in which case the interfaces on this host will be examined,
110and if one of them is found to occupy the same subnet, its
111ether_addr will be used.
112.It Fl S Ar hostname ether_addr
113Is just like
114.Fl s
115except any existing arp entry for this host will be deleted first.
116.It Fl f
117Causes the file
118.Ar filename
119to be read and multiple entries to be set in the
120.Tn ARP
121tables.  Entries
122in the file should be of the form
123.Pp
124.Bd -filled -offset indent -compact
125.Ar hostname ether_addr
126.Op Ar temp
127.Op Ar pub
128.Ed
129.Pp
130with argument meanings as given above.
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