xref: /freebsd/libexec/rbootd/rbootd.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 1988, 1992 The University of Utah and the Center
2.\"	for Software Science (CSS).
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.\" Utah Hdr: rbootd.man 3.1 92/07/06
37.\" Author: Jeff Forys, University of Utah CSS
38.\"
39.Dd December 11, 1993
40.Dt RBOOTD 8
41.Os
42.Sh NAME
43.Nm rbootd
44.Nd HP remote boot server
45.Sh SYNOPSIS
46.Nm
47.Op Fl ad
48.Op Fl i Ar interface
49.Op config_file
50.Sh DESCRIPTION
51The
52.Nm
53utility services boot requests from Hewlett-Packard workstations over a
54local area network.
55All boot files must reside in the boot file directory; further, if a
56client supplies path information in its boot request, it will be silently
57stripped away before processing.
58By default,
59.Nm
60only responds to requests from machines listed in its configuration file.
61.Pp
62The options are as follows:
63.Bl -tag -width indent
64.It Fl a
65Respond to boot requests from any machine.
66The configuration file is ignored if this option is specified.
67.It Fl d
68Run
69.Nm
70in debug mode.
71Packets sent and received are displayed to the terminal.
72.It Fl i Ar interface
73Service boot requests on specified interface.
74If unspecified,
75.Nm
76searches the system interface list for the lowest numbered, configured
77``up'' interface (excluding loopback).
78Ties are broken by choosing the earliest match.
79.El
80.Pp
81Specifying
82.Ar config_file
83on the command line causes
84.Nm
85to use a different configuration file from the default.
86.Pp
87The configuration file is a text file where each line describes a particular
88machine.
89A line must start with a machine's Ethernet address followed by an optional
90list of boot file names.
91An Ethernet address is specified in hexadecimal with each of its six octets
92separated by a colon.
93The boot file names come from the boot file directory.
94The ethernet address and boot file(s) must be separated by white-space
95and/or comma characters.
96A pound sign causes the remainder of a line to be ignored.
97.Pp
98Here is a sample configuration file:
99.Bd -literal
100#
101# ethernet addr     boot file(s)        comments
102#
10308:00:09:0:66:ad    SYSHPBSD            # snake (4.3BSD)
10408:00:09:0:59:5b                        # vandy (anything)
1058::9:1:C6:75        SYSHPBSD,SYSHPUX    # jaguar (either)
106.Ed
107.Pp
108The
109.Nm
110utility logs status and error messages via
111.Xr syslog 3 .
112A startup message is always logged, and in the case of fatal errors (or
113deadly signals) a message is logged announcing the server's termination.
114In general, a non-fatal error is handled by ignoring the event that caused
115it (e.g.\& an invalid Ethernet address in the config file causes that line
116to be invalidated).
117.Pp
118The following signals have the specified effect when sent to the server
119process using the
120.Xr kill 1
121command:
122.Bl -tag -width SIGUSR1 -offset xxxxxxxx
123.It SIGHUP
124Drop all active connections and reconfigure.
125.It SIGUSR1
126Turn on debugging, do nothing if already on.
127.It SIGUSR2
128Turn off debugging, do nothing if already off.
129.El
130.Sh "FILES"
131.Bl -tag -width /usr/libexec/rbootd -compact
132.It Pa /dev/bpf#
133packet-filter device
134.It Pa /etc/rbootd.conf
135configuration file
136.It Pa /tmp/rbootd.dbg
137debug output
138.It Pa /usr/mdec/rbootd
139directory containing boot files
140.It Pa /var/run/rbootd.pid
141process id
142.El
143.Sh SEE ALSO
144.Xr kill 1 ,
145.Xr socket 2 ,
146.Xr signal 3 ,
147.Xr syslog 3
148.Sh BUGS
149If multiple servers are started on the same interface, each will receive
150and respond to the same boot packets.
151