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. 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 April 6, 2017
  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 -libxo Ar options
  40 .Op Fl n
  41 .Op Fl i Ar interface
  42 .Ar hostname
  43 .Nm
  44 .Op Fl -libxo Ar options
  45 .Op Fl n
  46 .Op Fl i Ar interface
  47 .Fl a
  48 .Nm
  49 .Fl d Ar hostname
  50 .Op Cm pub
  51 .Nm
  52 .Fl d
  53 .Op Fl i Ar interface
  54 .Fl a
  55 .Nm
  56 .Fl s Ar hostname ether_addr
  57 .Op Cm temp
  58 .Op Cm blackhole No \&| Cm reject
  59 .Op Cm pub
  60 .Nm
  61 .Fl S Ar hostname ether_addr
  62 .Op Cm temp
  63 .Op Cm blackhole No \&| Cm reject
  64 .Op Cm pub
  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 -libxo
  83 Generate output via
  84 .Xr libxo 3
  85 in a selection of different human and machine readable formats.
  86 See
  87 .Xr xo_parse_args 3
  88 for details on command line arguments.
  89 .It Fl a
  90 The program displays or deletes all of the current
  91 .Tn ARP
  92 entries.
  93 .It Fl d
  94 A super-user may delete an entry for the host called
  95 .Ar hostname
  96 with the
  97 .Fl d
  98 flag.
  99 If the
 100 .Cm pub
 101 keyword is specified, only the
 102 .Dq published
 103 .Tn ARP
 104 entry
 105 for this host will be deleted.
 106 .Pp
 107 Alternatively, the
 108 .Fl d
 109 flag may be combined with the
 110 .Fl a
 111 flag to delete all entries.
 112 .It Fl i Ar interface
 113 Limit the operation scope to the
 114 .Tn ARP
 115 entries on
 116 .Ar interface .
 117 Applicable only to the following operations:
 118 display one, display all, delete all.
 119 .It Fl n
 120 Show network addresses as numbers (normally
 121 .Nm
 122 attempts to display addresses symbolically).
 123 .It Fl s Ar hostname ether_addr
 124 Create an
 125 .Tn ARP
 126 entry for the host called
 127 .Ar hostname
 128 with the Ethernet address
 129 .Ar ether_addr .
 130 The Ethernet address is given as six hex bytes separated by colons.
 131 The entry will be permanent unless the word
 132 .Cm temp
 133 is given in the command.
 134 If the word
 135 .Cm pub
 136 is given, the entry will be
 137 .Dq published ;
 138 i.e., this system will
 139 act as an
 140 .Tn ARP
 141 server,
 142 responding to requests for
 143 .Ar hostname
 144 even though the host address is not its own.
 145 In this case the
 146 .Ar ether_addr
 147 can be given as
 148 .Cm auto
 149 in which case the interfaces on this host will be examined,
 150 and if one of them is found to occupy the same subnet, its
 151 Ethernet address will be used.
 152 .Pp
 153 If the
 154 .Cm reject
 155 keyword is specified the entry will be marked so that traffic to
 156 the host will be discarded and the sender will be notified the
 157 host is unreachable.
 158 The
 159 .Cm blackhole
 160 keyword is similar in that traffic is discarded but the sender is
 161 not notified.
 162 These can be used to block external traffic to a host without
 163 using a firewall.
 164 .It Fl S Ar hostname ether_addr
 165 Is just like
 166 .Fl s
 167 except any existing
 168 .Tn ARP
 169 entry for this host will be deleted first.
 170 .It Fl f Ar filename
 171 Cause the file
 172 .Ar filename
 173 to be read and multiple entries to be set in the
 174 .Tn ARP
 175 tables.
 176 Entries
 177 in the file should be of the form
 178 .Pp
 179 .Bd -ragged -offset indent -compact
 180 .Ar hostname ether_addr
 181 .Op Cm temp
 182 .Op Cm blackhole No \&| Cm reject
 183 .Op Cm pub
 184 .Ed
 185 .Pp
 186 with argument meanings as given above.
 187 Leading whitespace and empty lines are ignored.
 188 A
 189 .Ql #
 190 character will mark the rest of the line as a comment.
 191 .El
 192 .Sh SEE ALSO
 193 .Xr inet 3 ,
 194 .Xr libxo 3 ,
 195 .Xr xo_parse_args 3 ,
 196 .Xr arp 4 ,
 197 .Xr ifconfig 8 ,
 198 .Xr ndp 8
 199 .Sh HISTORY
 200 The
 201 .Nm
 202 utility appeared in
 203 .Bx 4.3 .