Prefer the clearer m_getc() API over m_getm().
[dragonfly.git] / usr.sbin / rarpd / rarpd.8
1 .\" @(#) $FreeBSD: src/usr.sbin/rarpd/rarpd.8,v 1.9.2.5 2002/12/01 19:19:34 dwmalone Exp $ (LBL)
2 .\" @(#) $DragonFly: src/usr.sbin/rarpd/rarpd.8,v 1.2 2003/06/17 04:30:02 dillon Exp $ (LBL)
3 .\"
4 .\" Copyright (c) 1990, 1991, 1993 The Regents of the University of
5 .\" California. All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that: (1) source code distributions
9 .\" retain the above copyright notice and this paragraph in its entirety, (2)
10 .\" distributions including binary code include the above copyright notice and
11 .\" this paragraph in its entirety in the documentation or other materials
12 .\" provided with the distribution, and (3) all advertising materials mentioning
13 .\" features or use of this software display the following acknowledgement:
14 .\" ``This product includes software developed by the University of California,
15 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
16 .\" the University nor the names of its contributors may be used to endorse
17 .\" or promote products derived from this software without specific prior
18 .\" written permission.
19 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
20 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
21 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
22 .\"
23 .Dd November 16, 2001
24 .Dt RARPD 8
25 .Os
26 .Sh NAME
27 .Nm rarpd
28 .Nd reverse ARP daemon
29 .Sh SYNOPSIS
30 .Nm
31 .Op Fl adfsv
32 .Op Fl t Ar directory
33 .Op Ar interface
34 .Sh DESCRIPTION
35 The
36 .Nm
37 utility services Reverse ARP requests on the Ethernet connected to
38 .Ar interface .
39 Upon receiving a request,
40 .Nm
41 maps the target hardware address to an IP address via its name, which
42 must be present in both the
43 .Xr ethers 5
44 and
45 .Xr hosts 5
46 databases.
47 If a host does not exist in both databases, the translation cannot
48 proceed and a reply will not be sent.
49 .Pp
50 By default, a request is honored only if the server
51 (i.e., the host that
52 .Nm
53 is running on)
54 can "boot" the target; that is, a file or directory matching the glob
55 .Pa /tftpboot/\fIipaddr\fP*
56 exists, where
57 .Em ipaddr
58 is the target IP address in hex.
59 For example, the IP address 204.216.27.18 will be replied to if any of
60 .Pa /tftpboot/CCD81B12 ,
61 .Pa /tftpboot/CCD81B12.SUN3 ,
62 or
63 .Pa /tftpboot/CCD81B12-boot
64 exist.
65 This requirement can be overridden with the
66 .Fl s
67 flag (see below).
68 .Pp
69 In normal operation,
70 .Nm
71 forks a copy of itself and runs in the background.
72 Anomalies and errors are reported via
73 .Xr syslog 3 .
74 .Pp
75 The following options are available:
76 .Bl -tag -width indent
77 .It Fl a
78 Listen on all the Ethernets attached to the system.
79 If
80 .Fl a
81 is omitted, an interface must be specified.
82 .It Fl d
83 If
84 .Fl f
85 is also specified,
86 .Nm
87 logs messages to
88 .Em stdout
89 and
90 .Em stderr
91 instead of via
92 .Xr syslog 3 .
93 .It Fl f
94 Run in the foreground.
95 .It Fl s
96 Supply a response to any RARP request for which an ethernet to IP address
97 mapping exists; do not depend on the existence of
98 .Pa /tftpboot/\fIipaddr\fP* .
99 .It Fl t
100 Supply an alternate tftp root directory to
101 .Pa /tftpboot ,
102 similar to the
103 .Fl s
104 option of
105 .Xr tftpd 8 .
106 This permits
107 .Nm
108 to selectively respond to RARP requests, but use an alternate directory
109 for IP checking.
110 .It Fl v
111 Enable verbose syslogging.
112 .El
113 .Sh FILES
114 .Bl -tag -width /etc/ethers -compact
115 .It Pa /etc/ethers
116 .It Pa /etc/hosts
117 .It Pa /tftpboot
118 .El
119 .Sh SEE ALSO
120 .Xr bpf 4
121 .Rs
122 .%A "Finlayson, R."
123 .%A "Mann, T."
124 .%A "Mogul, J.C."
125 .%A "Theimer, M."
126 .%T "RFC 903: Reverse Address Resolution Protocol"
127 .%D "June 1984"
128 .%O "4 p"
129 .Re
130 .Sh AUTHORS
131 .An -nosplit
132 .An Craig Leres Aq leres@ee.lbl.gov
133 and
134 .An Steven McCanne Aq mccanne@ee.lbl.gov .
135 Lawrence Berkeley Laboratory, University of California, Berkeley, CA.
136 .Sh BUGS
137 The
138 .Nm
139 utility can depend on the DNS to resolve the name discovered from
140 .Pa /etc/ethers .
141 If this name is not in the DNS but is in
142 .Pa /etc/hosts ,
143 the DNS lookup can cause a delayed RARP response, so in this situation
144 it is recommended to configure
145 .Pa /etc/host.conf
146 to read
147 .Pa /etc/hosts
148 first.