xref: /freebsd/usr.sbin/arp/arp.8 (revision e627b39baccd1ec9129690167cf5e6d860509655)
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.Ar hostname
43.Nm arp
44.Fl a
45.Nm arp
46.Fl d Ar hostname
47.Nm arp
48.Fl s Ar hostname ether_addr
49.Op Ar temp
50.Op Ar pub
51.Nm arp
52.Fl S Ar hostname ether_addr
53.Op Ar temp
54.Op Ar pub
55.Nm arp
56.Fl f Ar filename
57.Sh DESCRIPTION
58The
59.Nm arp
60program displays and modifies the Internet-to-Ethernet address translation
61tables used by the address resolution protocol
62.Pq Xr arp 4 .
63With no flags, the program displays the current
64.Tn ARP
65entry for
66.Ar hostname .
67The host may be specified by name or by number,
68using Internet dot notation.
69.Pp
70Available options:
71.Bl -tag -width Ds
72.It Fl a
73The program displays all of the current
74.Tn ARP
75entries.
76.It Fl d
77A super-user may delete an entry for the host called
78.Ar hostname
79with the
80.Fl d
81flag.
82.It Fl s Ar hostname ether_addr
83Create an
84.Tn ARP
85entry for the host called
86.Ar hostname
87with the Ethernet address
88.Ar ether_addr .
89The Ethernet address is given as six hex bytes separated by colons.
90The entry will be permanent unless the word
91.Ar temp
92is given in the command.
93If the word
94.Ar pub
95is given, the entry will be "published"; i.e., this system will
96act as an
97.Tn ARP
98server,
99responding to requests for
100.Ar hostname
101even though the host address is not its own.
102In this case the ether_addr can be given as `auto''
103in which case the interfaces on this host will be examined,
104and if one of them is found to occupy the same subnet, its
105ether_addr will be used.
106.It Fl S Ar hostname ether_addr
107Is just like
108.Fl s
109except any existing arp entry for this host will be deleted first.
110.It Fl f
111Causes the file
112.Ar filename
113to be read and multiple entries to be set in the
114.Tn ARP
115tables.  Entries
116in the file should be of the form
117.Pp
118.Bd -filled -offset indent -compact
119.Ar hostname ether_addr
120.Op Ar temp
121.Op Ar pub
122.Ed
123.Pp
124with argument meanings as given above.
125.El
126.Sh SEE ALSO
127.Xr inet 3 ,
128.Xr arp 4 ,
129.Xr ifconfig 8
130.Sh HISTORY
131The
132.Nm
133command appeared in
134.Bx 4.3 .
135