xref: /netbsd-src/usr.sbin/rbootd/rbootd.8 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\"	$NetBSD: rbootd.8,v 1.9 2004/12/01 23:16:02 christos Exp $
2.\"
3.\" Copyright (c) 1992, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the Center for Software Science of the University of Utah Computer
8.\" Science Department.  CSS requests users of this software to return
9.\" to css-dist@cs.utah.edu any improvements that they make and grant
10.\" CSS redistribution rights.
11.\"
12.\" Redistribution and use in source and binary forms, with or without
13.\" modification, are permitted provided that the following conditions
14.\" are met:
15.\" 1. Redistributions of source code must retain the above copyright
16.\"    notice, this list of conditions and the following disclaimer.
17.\" 2. Redistributions in binary form must reproduce the above copyright
18.\"    notice, this list of conditions and the following disclaimer in the
19.\"    documentation and/or other materials provided with the distribution.
20.\" 3. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\" Copyright (c) 1988, 1992 The University of Utah and the Center
37.\"	for Software Science (CSS).
38.\"
39.\" This code is derived from software contributed to Berkeley by
40.\" the Center for Software Science of the University of Utah Computer
41.\" Science Department.  CSS requests users of this software to return
42.\" to css-dist@cs.utah.edu any improvements that they make and grant
43.\" CSS redistribution rights.
44.\"
45.\" Redistribution and use in source and binary forms, with or without
46.\" modification, are permitted provided that the following conditions
47.\" are met:
48.\" 1. Redistributions of source code must retain the above copyright
49.\"    notice, this list of conditions and the following disclaimer.
50.\" 2. Redistributions in binary form must reproduce the above copyright
51.\"    notice, this list of conditions and the following disclaimer in the
52.\"    documentation and/or other materials provided with the distribution.
53.\" 3. All advertising materials mentioning features or use of this software
54.\"    must display the following acknowledgement:
55.\"	This product includes software developed by the University of
56.\"	California, Berkeley and its contributors.
57.\" 4. Neither the name of the University nor the names of its contributors
58.\"    may be used to endorse or promote products derived from this software
59.\"    without specific prior written permission.
60.\"
61.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
62.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
63.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
64.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
65.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
66.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
67.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
68.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
69.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
70.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
71.\" SUCH DAMAGE.
72.\"
73.\"	from: @(#)rbootd.8	8.2 (Berkeley) 12/11/93
74.\"
75.\" Utah Hdr: rbootd.man 3.1 92/07/06
76.\" Author: Jeff Forys, University of Utah CSS
77.\"
78.Dd December 11, 1993
79.Dt RBOOTD 8
80.Os
81.Sh NAME
82.Nm rbootd
83.Nd HP remote boot server
84.Sh SYNOPSIS
85.Nm
86.Op Fl ad
87.Op Fl i Ar interface
88.Op config_file
89.Sh DESCRIPTION
90The
91.Nm
92utility services boot requests from Hewlett-Packard workstations over a
93local area network.
94All boot files must reside in the boot file directory; further, if a
95client supplies path information in its boot request, it will be silently
96stripped away before processing.
97By default,
98.Nm
99only responds to requests from machines listed in its configuration file.
100If the client doesn't supply a file name (HP700 series machines don't), the first one listed for this machine will be supplied.
101.Pp
102The options are as follows:
103.Bl -tag -width Fl
104.It Fl a
105Respond to boot requests from any machine.
106The configuration file is ignored if this option is specified.
107.It Fl d
108Run
109.Nm
110in debug mode.
111Packets sent and received are displayed to the terminal.
112.It Fl i Ar interface
113Service boot requests on specified interface.
114If unspecified,
115.Nm
116searches the system interface list for the lowest numbered, configured
117``up'' interface (excluding loopback).
118Ties are broken by choosing the earliest match.
119.El
120.Pp
121Specifying
122.Ar config_file
123on the command line causes
124.Nm
125to use a different configuration file from the default.
126.Pp
127The configuration file is a text file where each line describes a particular
128machine.
129A line must start with a machine's Ethernet address followed by an optional
130list of boot file names.
131An Ethernet address is specified in hexadecimal with each of its six octets
132separated by a colon.
133The boot file names come from the boot file directory.
134The ethernet address and boot file(s) must be separated by white-space
135and/or comma characters.
136A pound sign causes the remainder of a line to be ignored.
137.Pp
138Here is a sample configuration file:
139.Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX "# vandy (anything)"
140.It #
141.It # ethernet addr	boot file(s)	comments
142.It #
143.It 08:00:09:0:66:ad	SYSHPBSD	# snake (4.3BSD)
144.It 08:00:09:0:59:5b		# vandy (anything)
145.It 8::9:1:C6:75	SYSHPBSD,SYSHPUX	# jaguar (either)
146.El
147.Pp
148.Nm
149logs status and error messages via
150.Xr syslog 3 .
151A startup message is always logged, and in the case of fatal errors (or
152deadly signals) a message is logged announcing the server's termination.
153In general, a non-fatal error is handled by ignoring the event that caused
154it (e.g. an invalid Ethernet address in the config file causes that line
155to be invalidated).
156.Pp
157The following signals have the specified effect when sent to the server
158process using the
159.Xr kill 1
160command:
161.Bl -tag -width SIGUSR1 -offset -compact
162.It SIGHUP
163Drop all active connections and reconfigure.
164.It SIGUSR1
165Turn on debugging, do nothing if already on.
166.It SIGUSR2
167Turn off debugging, do nothing if already off.
168.El
169.Sh FILES
170.Bl -tag -width /usr/libexec/rbootd -compact
171.It Pa /dev/bpf
172packet-filter device
173.It Pa /etc/rbootd.conf
174configuration file
175.It Pa /tmp/rbootd.dbg
176debug output
177.It Pa /usr/mdec/rbootd
178directory containing boot files
179.It Pa /var/run/rbootd.pid
180process id
181.El
182.Sh SEE ALSO
183.Xr kill 1 ,
184.Xr socket 2 ,
185.Xr signal 3 ,
186.Xr syslog 3 ,
187.Xr rmp 4
188.Sh BUGS
189If multiple servers are started on the same interface, each will receive
190and respond to the same boot packets.
191