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