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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)arp.8       8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 18, 2008
  32 .Dt ARP 8
  33 .Os
  34 .Sh NAME
  35 .Nm arp
  36 .Nd address resolution display and control
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl n
  40 .Op Fl i Ar interface
  41 .Ar hostname
  42 .Nm
  43 .Op Fl n
  44 .Op Fl i Ar interface
  45 .Fl a
  46 .Nm
  47 .Fl d Ar hostname
  48 .Op Cm pub
  49 .Nm
  50 .Fl d
  51 .Op Fl i Ar interface
  52 .Fl a
  53 .Nm
  54 .Fl s Ar hostname ether_addr
  55 .Op Cm temp
  56 .Op Cm reject
  57 .Op Cm blackhole
  58 .Op Cm pub Op Cm only
  59 .Nm
  60 .Fl S Ar hostname ether_addr
  61 .Op Cm temp
  62 .Op Cm reject
  63 .Op Cm blackhole
  64 .Op Cm pub Op Cm only
  65 .Nm
  66 .Fl f Ar filename
  67 .Sh DESCRIPTION
  68 The
  69 .Nm
  70 utility displays and modifies the Internet-to-Ethernet address translation
  71 tables used by the address resolution protocol
  72 .Pq Xr arp 4 .
  73 With no flags, the program displays the current
  74 .Tn ARP
  75 entry for
  76 .Ar hostname .
  77 The host may be specified by name or by number,
  78 using Internet dot notation.
  79 .Pp
  80 Available options:
  81 .Bl -tag -width indent
  82 .It Fl a
  83 The program displays or deletes all of the current
  84 .Tn ARP
  85 entries.
  86 .It Fl d
  87 A super-user may delete an entry for the host called
  88 .Ar hostname
  89 with the
  90 .Fl d
  91 flag.
  92 If the
  93 .Cm pub
  94 keyword is specified, only the
  95 .Dq published
  96 .Tn ARP
  97 entry
  98 for this host will be deleted.
  99 .Pp
 100 Alternatively, the
 101 .Fl d
 102 flag may be combined with the
 103 .Fl a
 104 flag to delete all entries.
 105 .It Fl i Ar interface
 106 Limit the operation scope to the
 107 .Tn ARP
 108 entries on
 109 .Ar interface .
 110 Applicable only to the following operations:
 111 display one, display all, delete all.
 112 .It Fl n
 113 Show network addresses as numbers (normally
 114 .Nm
 115 attempts to display addresses symbolically).
 116 .It Fl s Ar hostname ether_addr
 117 Create an
 118 .Tn ARP
 119 entry for the host called
 120 .Ar hostname
 121 with the Ethernet address
 122 .Ar ether_addr .
 123 The Ethernet address is given as six hex bytes separated by colons.
 124 The entry will be permanent unless the word
 125 .Cm temp
 126 is given in the command.
 127 If the word
 128 .Cm pub
 129 is given, the entry will be
 130 .Dq published ;
 131 i.e., this system will
 132 act as an
 133 .Tn ARP
 134 server,
 135 responding to requests for
 136 .Ar hostname
 137 even though the host address is not its own.
 138 In this case the
 139 .Ar ether_addr
 140 can be given as
 141 .Cm auto
 142 in which case the interfaces on this host will be examined,
 143 and if one of them is found to occupy the same subnet, its
 144 Ethernet address will be used.
 145 If the
 146 .Cm only
 147 keyword is also specified, this will create a
 148 .Dq "published (proxy only)"
 149 entry.
 150 This type of entry is created automatically if
 151 .Nm
 152 detects that a routing table entry for
 153 .Ar hostname
 154 already exists.
 155 .Pp
 156 If the
 157 .Cm reject
 158 keyword is specified the entry will be marked so that traffic to
 159 the host will be discarded and the sender will be notified the
 160 host is unreachable.
 161 The
 162 .Cm blackhole
 163 keyword is similar in that traffic is discarded but the sender is
 164 not notified.
 165 These can be used to block external traffic to a host without
 166 using a firewall.
 167 .It Fl S Ar hostname ether_addr
 168 Is just like
 169 .Fl s
 170 except any existing
 171 .Tn ARP
 172 entry for this host will be deleted first.
 173 .It Fl f Ar filename
 174 Cause the file
 175 .Ar filename
 176 to be read and multiple entries to be set in the
 177 .Tn ARP
 178 tables.
 179 Entries
 180 in the file should be of the form
 181 .Pp
 182 .Bd -ragged -offset indent -compact
 183 .Ar hostname ether_addr
 184 .Op Cm temp
 185 .Op Cm pub
 186 .Ed
 187 .Pp
 188 with argument meanings as given above.
 189 Leading whitespace and empty lines are ignored.
 190 A
 191 .Ql #
 192 character will mark the rest of the line as a comment.
 193 .El
 194 .Sh SEE ALSO
 195 .Xr inet 3 ,
 196 .Xr arp 4 ,
 197 .Xr ifconfig 8
 198 .Sh HISTORY
 199 The
 200 .Nm
 201 utility appeared in
 202 .Bx 4.3 .