usr.sbin/arp/arp.8

   1 .\"     $NetBSD: arp.8,v 1.19 2006/01/31 17:47:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1985, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)arp.8 8.2 (Berkeley) 4/27/95
  31 .\"
  32 .Dd January 31, 2006
  33 .Dt ARP 8
  34 .Os
  35 .Sh NAME
  36 .Nm arp
  37 .Nd address resolution display and control
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl n
  41 .Ar hostname
  42 .Nm
  43 .Op Fl nv
  44 .Fl a
  45 .Nm
  46 .Op Fl v
  47 .Fl d
  48 .Fl a
  49 .Nm
  50 .Op Fl v
  51 .Fl d Ar hostname
  52 .Op Ar proxy
  53 .Nm
  54 .Fl s Ar hostname ether_addr
  55 .Op Ar temp
  56 .Op Ar pub Op Ar proxy
  57 .Nm
  58 .Fl f Ar filename
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 program displays and modifies the Internet-to-Ethernet address translation
  63 tables used by the address resolution protocol
  64 .Pq Xr arp 4 .
  65 With no flags, the program displays the current
  66 .Tn ARP
  67 entry for
  68 .Ar hostname .
  69 The host may be specified by name or by number,
  70 using Internet dot notation.
  71 .Pp
  72 Available options:
  73 .Bl -tag -width Ds
  74 .It Fl a
  75 The program displays all of the current
  76 .Tn ARP
  77 entries.
  78 .It Fl d
  79 A super-user may delete an entry for the host called
  80 .Ar hostname
  81 with the
  82 .Fl d
  83 flag.
  84 If the
  85 .Cm proxy
  86 keyword is specified, only the published
  87 .Dq proxy only
  88 .Tn ARP
  89 entry
  90 for this host will be deleted.
  91 If used with
  92 .Fl a
  93 instead of a
  94 .Ar hostname ,
  95 it will delete all arp entries.
  96 .It Fl f
  97 Causes the file
  98 .Ar filename
  99 to be read and multiple entries to be set in the
 100 .Tn ARP
 101 tables.
 102 Entries in the file should be of the form
 103 .Pp
 104 .Bd -filled -offset indent -compact
 105 .Ar hostname ether_addr
 106 .Op Ar temp
 107 .Op Ar pub
 108 .Ed
 109 .Pp
 110 with argument meanings as described below.
 111 .It Fl n
 112 Show network addresses as numbers (normally
 113 .Nm
 114 attempts to display addresses symbolically).
 115 .It Fl s Ar hostname ether_addr
 116 Create an
 117 .Tn ARP
 118 entry for the host called
 119 .Ar hostname
 120 with the Ethernet address
 121 .Ar ether_addr .
 122 The Ethernet address is given as six hex bytes separated by colons.
 123 The entry will be permanent unless the word
 124 .Ar temp
 125 is given in the command.
 126 If the word
 127 .Ar pub
 128 is given, the entry will be "published"; i.e., this system will
 129 act as an
 130 .Tn ARP
 131 server,
 132 responding to requests for
 133 .Ar hostname
 134 even though the host address is not its own.  If the word
 135 .Ar proxy
 136 is also given, the published entry will be a
 137 .Dq proxy only
 138 entry.
 139 .It Fl v
 140 Display verbose information when adding or deleting
 141 .Tn ARP
 142 entries.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr inet 3 ,
 146 .Xr arp 4 ,
 147 .Xr ifconfig 8
 148 .Sh HISTORY
 149 The
 150 .Nm
 151 command appeared in
 152 .Bx 4.3 .