xref: /freebsd/libexec/rbootd/rbootd.8 (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
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. All advertising materials mentioning features or use of this software
21.\"    must display the following acknowledgement:
22.\"	This product includes software developed by the University of
23.\"	California, Berkeley and its contributors.
24.\" 4. Neither the name of the University nor the names of its contributors
25.\"    may be used to endorse or promote products derived from this software
26.\"    without specific prior written permission.
27.\"
28.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38.\" SUCH DAMAGE.
39.\"
40.\"	from: @(#)rbootd.8	8.2 (Berkeley) 12/11/93
41.\"	$Id: rbootd.8,v 1.6 1997/06/23 04:02:13 steve Exp $
42.\"
43.\" Utah Hdr: rbootd.man 3.1 92/07/06
44.\" Author: Jeff Forys, University of Utah CSS
45.\"
46.Dd December 11, 1993
47.Dt RBOOTD 8
48.Os
49.Sh NAME
50.Nm rbootd
51.Nd HP remote boot server
52.Sh SYNOPSIS
53.Nm rbootd
54.Op Fl ad
55.Op Fl i Ar interface
56.Op config_file
57.Sh DESCRIPTION
58The
59.Nm rbootd
60utility services boot requests from Hewlett-Packard workstations over a
61local area network.
62All boot files must reside in the boot file directory; further, if a
63client supplies path information in its boot request, it will be silently
64stripped away before processing.
65By default,
66.Nm rbootd
67only responds to requests from machines listed in its configuration file.
68.Pp
69The options are as follows:
70.Bl -tag -width Fl
71.It Fl a
72Respond to boot requests from any machine.
73The configuration file is ignored if this option is specified.
74.It Fl d
75Run
76.Nm rbootd
77in debug mode.
78Packets sent and received are displayed to the terminal.
79.It Fl i Ar interface
80Service boot requests on specified interface.
81If unspecified,
82.Nm rbootd
83searches the system interface list for the lowest numbered, configured
84``up'' interface (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 rbootd
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 white-space
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.Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX "# vandy (anything)"
107.It #
108.It # ethernet addr	boot file(s)	comments
109.It #
110.It 08:00:09:0:66:ad	SYSHPBSD	# snake (4.3BSD)
111.It 08:00:09:0:59:5b		# vandy (anything)
112.It 8::9:1:C6:75	SYSHPBSD,SYSHPUX	# jaguar (either)
113.El
114.Pp
115.Nm Rbootd
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 -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 /usr/libexec/rbootd -compact
138.It /dev/bpf#
139packet-filter device
140.It /etc/rbootd.conf
141configuration file
142.It /tmp/rbootd.dbg
143debug output
144.It /usr/mdec/rbootd
145directory containing boot files
146.It /var/run/rbootd.pid
147process id
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