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 January 31, 2013
  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 blackhole No \&| Cm reject
  57 .Op Cm pub
  58 .Nm
  59 .Fl S Ar hostname ether_addr
  60 .Op Cm temp
  61 .Op Cm blackhole No \&| Cm reject
  62 .Op Cm pub
  63 .Nm
  64 .Fl f Ar filename
  65 .Sh DESCRIPTION
  66 The
  67 .Nm
  68 utility displays and modifies the Internet-to-Ethernet address translation
  69 tables used by the address resolution protocol
  70 .Pq Xr arp 4 .
  71 With no flags, the program displays the current
  72 .Tn ARP
  73 entry for
  74 .Ar hostname .
  75 The host may be specified by name or by number,
  76 using Internet dot notation.
  77 .Pp
  78 Available options:
  79 .Bl -tag -width indent
  80 .It Fl a
  81 The program displays or deletes all of the current
  82 .Tn ARP
  83 entries.
  84 .It Fl d
  85 A super-user may delete an entry for the host called
  86 .Ar hostname
  87 with the
  88 .Fl d
  89 flag.
  90 If the
  91 .Cm pub
  92 keyword is specified, only the
  93 .Dq published
  94 .Tn ARP
  95 entry
  96 for this host will be deleted.
  97 .Pp
  98 Alternatively, the
  99 .Fl d
 100 flag may be combined with the
 101 .Fl a
 102 flag to delete all entries.
 103 .It Fl i Ar interface
 104 Limit the operation scope to the
 105 .Tn ARP
 106 entries on
 107 .Ar interface .
 108 Applicable only to the following operations:
 109 display one, display all, delete all.
 110 .It Fl n
 111 Show network addresses as numbers (normally
 112 .Nm
 113 attempts to display addresses symbolically).
 114 .It Fl s Ar hostname ether_addr
 115 Create an
 116 .Tn ARP
 117 entry for the host called
 118 .Ar hostname
 119 with the Ethernet address
 120 .Ar ether_addr .
 121 The Ethernet address is given as six hex bytes separated by colons.
 122 The entry will be permanent unless the word
 123 .Cm temp
 124 is given in the command.
 125 If the word
 126 .Cm pub
 127 is given, the entry will be
 128 .Dq published ;
 129 i.e., this system will
 130 act as an
 131 .Tn ARP
 132 server,
 133 responding to requests for
 134 .Ar hostname
 135 even though the host address is not its own.
 136 In this case the
 137 .Ar ether_addr
 138 can be given as
 139 .Cm auto
 140 in which case the interfaces on this host will be examined,
 141 and if one of them is found to occupy the same subnet, its
 142 Ethernet address will be used.
 143 .Pp
 144 If the
 145 .Cm reject
 146 keyword is specified the entry will be marked so that traffic to
 147 the host will be discarded and the sender will be notified the
 148 host is unreachable.
 149 The
 150 .Cm blackhole
 151 keyword is similar in that traffic is discarded but the sender is
 152 not notified.
 153 These can be used to block external traffic to a host without
 154 using a firewall.
 155 .It Fl S Ar hostname ether_addr
 156 Is just like
 157 .Fl s
 158 except any existing
 159 .Tn ARP
 160 entry for this host will be deleted first.
 161 .It Fl f Ar filename
 162 Cause the file
 163 .Ar filename
 164 to be read and multiple entries to be set in the
 165 .Tn ARP
 166 tables.
 167 Entries
 168 in the file should be of the form
 169 .Pp
 170 .Bd -ragged -offset indent -compact
 171 .Ar hostname ether_addr
 172 .Op Cm temp
 173 .Op Cm blackhole No \&| Cm reject
 174 .Op Cm pub
 175 .Ed
 176 .Pp
 177 with argument meanings as given above.
 178 Leading whitespace and empty lines are ignored.
 179 A
 180 .Ql #
 181 character will mark the rest of the line as a comment.
 182 .El
 183 .Sh SEE ALSO
 184 .Xr inet 3 ,
 185 .Xr arp 4 ,
 186 .Xr ifconfig 8 ,
 187 .Xr ndp 8
 188 .Sh HISTORY
 189 The
 190 .Nm
 191 utility appeared in
 192 .Bx 4.3 .