usr.sbin/arp/arp.8

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