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