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