xref: /openbsd/usr.sbin/rbootd/rbootd.8 (revision d415bd75)
1.\"	$OpenBSD: rbootd.8,v 1.19 2020/05/16 16:58:12 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: May 16 2020 $
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.Dq up
84interface (excluding loopback).
85Ties are broken by choosing the earliest match.
86.El
87.Pp
88Specifying
89.Ar config_file
90on the command line causes
91.Nm
92to use a different configuration file from the default.
93.Pp
94The configuration file is a text file where each line describes a particular
95machine.
96A line must start with a machine's Ethernet address followed by an optional
97list of boot file names.
98An Ethernet address is specified in hexadecimal with each of its six octets
99separated by a colon.
100The boot file names come from the boot file directory.
101The Ethernet address and boot file(s) must be separated by whitespace
102and/or comma characters.
103A pound sign causes the remainder of a line to be ignored.
104.Pp
105Here is a sample configuration file:
106.Bd -literal -offset indent
107#
108# Ethernet addr		boot file(s)		comments
109#
11008:00:09:0:66:ad	SYSHPBSD		# snake (4.3BSD)
11108:00:09:0:59:5b				# vandy (anything)
1128::9:1:C6:75		SYSHPBSD,SYSHPUX	# jaguar (either)
113.Ed
114.Pp
115.Nm
116logs status and error messages via
117.Xr syslog 3 .
118A startup message is always logged, and in the case of fatal errors (or
119deadly signals) a message is logged announcing the server's termination.
120In general, a non-fatal error is handled by ignoring the event that caused
121it (e.g., an invalid Ethernet address in the config file causes that line
122to be invalidated).
123.Pp
124The following signals have the specified effect when sent to the server
125process using the
126.Xr kill 1
127command:
128.Bl -tag -width SIGUSR1 -offset indent -compact
129.It SIGHUP
130Drop all active connections and reconfigure.
131.It SIGUSR1
132Turn on debugging, do nothing if already on.
133.It SIGUSR2
134Turn off debugging, do nothing if already off.
135.El
136.Sh FILES
137.Bl -tag -width /etc/examples/rbootd.conf -compact
138.It Pa /dev/bpf
139Packet-filter device.
140.It Pa /etc/rbootd.conf
141Configuration file.
142.It Pa /etc/examples/rbootd.conf
143Example configuration file.
144.It Pa /tmp/rbootd.dbg
145Debug output.
146.It Pa /usr/mdec/rbootd
147Directory containing boot files.
148.El
149.Sh SEE ALSO
150.Xr kill 1 ,
151.Xr socket 2 ,
152.Xr signal 3 ,
153.Xr syslog 3
154.Sh BUGS
155If multiple servers are started on the same interface, each will receive
156and respond to the same boot packets.
157