freebsd-skq/usr.sbin/arp/arp.8

.\" Copyright (c) 1985, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)arp.8	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd June 6, 1993
.Dt ARP 8
.Os BSD 4.3
.Sh NAME
.Nm arp
.Nd address resolution display and control
.Sh SYNOPSIS
.Nm
.Op Fl n
.Ar hostname
.Nm
.Op Fl n
.Fl a
.Nm
.Fl d Ar hostname
.Op Cm proxy
.Nm
.Fl d
.Fl a
.Nm
.Fl s Ar hostname ether_addr
.Op Cm temp
.Op Cm pub
.Nm
.Fl S Ar hostname ether_addr
.Op Cm temp
.Op Cm pub
.Nm
.Fl f Ar filename
.Sh DESCRIPTION
The
.Nm
program displays and modifies the Internet-to-Ethernet address translation
tables used by the address resolution protocol
.Pq Xr arp 4 .
With no flags, the program displays the current
.Tn ARP
entry for
.Ar hostname .
The host may be specified by name or by number,
using Internet dot notation.
.Pp
Available options:
.Bl -tag -width indent
.It Fl a
The program displays or deletes all of the current
.Tn ARP
entries.
.It Fl d
A super-user may delete an entry for the host called
.Ar hostname
with the
.Fl d
flag.
The
.Cm proxy
keyword is sometimes required when deleting published ARP entries.
This flag may be combined with the
.Fl a
flag to delete all entries.
.It Fl n
Show network addresses as numbers (normally
.Nm
attempts to display addresses symbolically).
.It Fl s Ar hostname ether_addr
Create an
.Tn ARP
entry for the host called
.Ar hostname
with the Ethernet address 
.Ar ether_addr .
The Ethernet address is given as six hex bytes separated by colons.
The entry will be permanent unless the word
.Cm temp
is given in the command. 
If the word
.Cm pub
is given, the entry will be "published"; i.e., this system will
act as an
.Tn ARP
server,
responding to requests for 
.Ar hostname
even though the host address is not its own.
In this case the
.Ar ether_addr
can be given as
.Cm auto
in which case the interfaces on this host will be examined,
and if one of them is found to occupy the same subnet, its
Ethernet address will be used.
.It Fl S Ar hostname ether_addr
Is just like
.Fl s
except any existing
.Tn ARP
entry for this host will be deleted first.
.It Fl f
Causes the file
.Ar filename
to be read and multiple entries to be set in the
.Tn ARP
tables.  Entries
in the file should be of the form
.Pp
.Bd -filled -offset indent -compact
.Ar hostname ether_addr
.Op Cm temp
.Op Cm pub
.Ed
.Pp
with argument meanings as given above.
.El
.Sh SEE ALSO
.Xr inet 3 ,
.Xr arp 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" Copyright (c) 1985, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)arp.8 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
			`.Dd June 6, 1993`
			`.Dt ARP 8`
			`.Os BSD 4.3`
			`.Sh NAME`
			`.Nm arp`
			`.Nd address resolution display and control`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Document -n flag from OpenBSD. Obtained from: OpenBSD. 1997-09-03 06:32:31 +00:00			`.Op Fl n`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar hostname`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Document -n flag from OpenBSD. Obtained from: OpenBSD. 1997-09-03 06:32:31 +00:00			`.Op Fl n`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Fl a`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Fl d Ar hostname`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Op Cm proxy`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Submitted by: Archie@Whistle.com (Archie Cobbs) allow teh -a option to work with the -d option thus: arp -d -a now flushes your arp cache. also fix the -n option so that -an now works correctly. 1997-11-13 01:16:57 +00:00			`.Fl d`
			`.Fl a`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Fl s Ar hostname ether_addr`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Op Cm temp`
			`.Op Cm pub`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Clean up warnings. fix return/exit codes in some cases. Add -S which will delete any old entry first. Add "auto" in proxy case, so it finds the right interface automatically. 1996-02-08 21:05:52 +00:00			`.Fl S Ar hostname ether_addr`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Op Cm temp`
			`.Op Cm pub`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Fl f Ar filename`
			`.Sh DESCRIPTION`
			`The`
Use err(3). Document -n flag from OpenBSD. Obtained from: OpenBSD. 1997-09-03 06:32:31 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`program displays and modifies the Internet-to-Ethernet address translation`
			`tables used by the address resolution protocol`
			`.Pq Xr arp 4 .`
			`With no flags, the program displays the current`
			`.Tn ARP`
			`entry for`
			`.Ar hostname .`
			`The host may be specified by name or by number,`
			`using Internet dot notation.`
			`.Pp`
			`Available options:`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl a`
Submitted by: Archie@Whistle.com (Archie Cobbs) allow teh -a option to work with the -d option thus: arp -d -a now flushes your arp cache. also fix the -n option so that -an now works correctly. 1997-11-13 01:16:57 +00:00			`The program displays or deletes all of the current`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Tn ARP`
			`entries.`
			`.It Fl d`
			`A super-user may delete an entry for the host called`
			`.Ar hostname`
			`with the`
			`.Fl d`
Revert previous checkin ("proxy" is required in some instances). Add a note to that effect to the man page. 2001-02-01 21:23:16 +00:00			`flag.`
			`The`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Cm proxy`
Revert previous checkin ("proxy" is required in some instances). Add a note to that effect to the man page. 2001-02-01 21:23:16 +00:00			`keyword is sometimes required when deleting published ARP entries.`
			`This flag may be combined with the`
Submitted by: Archie@Whistle.com (Archie Cobbs) allow teh -a option to work with the -d option thus: arp -d -a now flushes your arp cache. also fix the -n option so that -an now works correctly. 1997-11-13 01:16:57 +00:00			`.Fl a`
			`flag to delete all entries.`
Use err(3). Document -n flag from OpenBSD. Obtained from: OpenBSD. 1997-09-03 06:32:31 +00:00			`.It Fl n`
			`Show network addresses as numbers (normally`
			`.Nm`
			`attempts to display addresses symbolically).`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl s Ar hostname ether_addr`
			`Create an`
			`.Tn ARP`
			`entry for the host called`
			`.Ar hostname`
			`with the Ethernet address`
			`.Ar ether_addr .`
			`The Ethernet address is given as six hex bytes separated by colons.`
			`The entry will be permanent unless the word`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Cm temp`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`is given in the command.`
			`If the word`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Cm pub`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`is given, the entry will be "published"; i.e., this system will`
			`act as an`
			`.Tn ARP`
			`server,`
			`responding to requests for`
			`.Ar hostname`
			`even though the host address is not its own.`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`In this case the`
			`.Ar ether_addr`
			`can be given as`
			`.Cm auto`
Clean up warnings. fix return/exit codes in some cases. Add -S which will delete any old entry first. Add "auto" in proxy case, so it finds the right interface automatically. 1996-02-08 21:05:52 +00:00			`in which case the interfaces on this host will be examined,`
			`and if one of them is found to occupy the same subnet, its`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`Ethernet address will be used.`
Clean up warnings. fix return/exit codes in some cases. Add -S which will delete any old entry first. Add "auto" in proxy case, so it finds the right interface automatically. 1996-02-08 21:05:52 +00:00			`.It Fl S Ar hostname ether_addr`
			`Is just like`
			`.Fl s`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`except any existing`
			`.Tn ARP`
			`entry for this host will be deleted first.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl f`
			`Causes the file`
			`.Ar filename`
			`to be read and multiple entries to be set in the`
			`.Tn ARP`
			`tables. Entries`
			`in the file should be of the form`
			`.Pp`
			`.Bd -filled -offset indent -compact`
			`.Ar hostname ether_addr`
mdoc(7) police: modifiers should be marked with .Cm, not .Ar. 2001-02-05 17:01:07 +00:00			`.Op Cm temp`
			`.Op Cm pub`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ed`
			`.Pp`
			`with argument meanings as given above.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr inet 3 ,`
			`.Xr arp 4 ,`
			`.Xr ifconfig 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.3 .`