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