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