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