xref: /netbsd/usr.sbin/rbootd/rbootd.8 (revision bf9ec67e)
1.\"	$NetBSD: rbootd.8,v 1.7 2002/02/02 01:40:52 wiz Exp $
2.\"
3.\" Copyright (c) 1988, 1992 The University of Utah and the Center
4.\"	for Software Science (CSS).
5.\" Copyright (c) 1992, 1993
6.\"	The Regents of the University of California.  All rights reserved.
7.\"
8.\" This code is derived from software contributed to Berkeley by
9.\" the Center for Software Science of the University of Utah Computer
10.\" Science Department.  CSS requests users of this software to return
11.\" to css-dist@cs.utah.edu any improvements that they make and grant
12.\" CSS redistribution rights.
13.\"
14.\" Redistribution and use in source and binary forms, with or without
15.\" modification, are permitted provided that the following conditions
16.\" are met:
17.\" 1. Redistributions of source code must retain the above copyright
18.\"    notice, this list of conditions and the following disclaimer.
19.\" 2. Redistributions in binary form must reproduce the above copyright
20.\"    notice, this list of conditions and the following disclaimer in the
21.\"    documentation and/or other materials provided with the distribution.
22.\" 3. All advertising materials mentioning features or use of this software
23.\"    must display the following acknowledgement:
24.\"	This product includes software developed by the University of
25.\"	California, Berkeley and its contributors.
26.\" 4. Neither the name of the University nor the names of its contributors
27.\"    may be used to endorse or promote products derived from this software
28.\"    without specific prior written permission.
29.\"
30.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40.\" SUCH DAMAGE.
41.\"
42.\"	from: @(#)rbootd.8	8.2 (Berkeley) 12/11/93
43.\"
44.\" Utah Hdr: rbootd.man 3.1 92/07/06
45.\" Author: Jeff Forys, University of Utah CSS
46.\"
47.Dd December 11, 1993
48.Dt RBOOTD 8
49.Os
50.Sh NAME
51.Nm rbootd
52.Nd HP remote boot server
53.Sh SYNOPSIS
54.Nm
55.Op Fl ad
56.Op Fl i Ar interface
57.Op config_file
58.Sh DESCRIPTION
59The
60.Nm
61utility services boot requests from Hewlett-Packard workstations over a
62local area network.
63All boot files must reside in the boot file directory; further, if a
64client supplies path information in its boot request, it will be silently
65stripped away before processing.
66By default,
67.Nm
68only responds to requests from machines listed in its configuration file.
69If the client doesn't supply a file name (HP700 series machines don't), the first one listed for this machine will be supplied.
70.Pp
71The options are as follows:
72.Bl -tag -width Fl
73.It Fl a
74Respond to boot requests from any machine.
75The configuration file is ignored if this option is specified.
76.It Fl d
77Run
78.Nm
79in debug mode.
80Packets sent and received are displayed to the terminal.
81.It Fl i Ar interface
82Service boot requests on specified interface.
83If unspecified,
84.Nm
85searches the system interface list for the lowest numbered, configured
86``up'' interface (excluding loopback).
87Ties are broken by choosing the earliest match.
88.El
89.Pp
90Specifying
91.Ar config_file
92on the command line causes
93.Nm
94to use a different configuration file from the default.
95.Pp
96The configuration file is a text file where each line describes a particular
97machine.
98A line must start with a machine's Ethernet address followed by an optional
99list of boot file names.
100An Ethernet address is specified in hexadecimal with each of its six octets
101separated by a colon.
102The boot file names come from the boot file directory.
103The ethernet address and boot file(s) must be separated by white-space
104and/or comma characters.
105A pound sign causes the remainder of a line to be ignored.
106.Pp
107Here is a sample configuration file:
108.Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX "# vandy (anything)"
109.It #
110.It # ethernet addr	boot file(s)	comments
111.It #
112.It 08:00:09:0:66:ad	SYSHPBSD	# snake (4.3BSD)
113.It 08:00:09:0:59:5b		# vandy (anything)
114.It 8::9:1:C6:75	SYSHPBSD,SYSHPUX	# jaguar (either)
115.El
116.Pp
117.Nm
118logs status and error messages via
119.Xr syslog 3 .
120A startup message is always logged, and in the case of fatal errors (or
121deadly signals) a message is logged announcing the server's termination.
122In general, a non-fatal error is handled by ignoring the event that caused
123it (e.g. an invalid Ethernet address in the config file causes that line
124to be invalidated).
125.Pp
126The following signals have the specified effect when sent to the server
127process using the
128.Xr kill 1
129command:
130.Bl -tag -width SIGUSR1 -offset -compact
131.It SIGHUP
132Drop all active connections and reconfigure.
133.It SIGUSR1
134Turn on debugging, do nothing if already on.
135.It SIGUSR2
136Turn off debugging, do nothing if already off.
137.El
138.Sh FILES
139.Bl -tag -width /usr/libexec/rbootd -compact
140.It Pa /dev/bpf#
141packet-filter device
142.It Pa /etc/rbootd.conf
143configuration file
144.It Pa /tmp/rbootd.dbg
145debug output
146.It Pa /usr/mdec/rbootd
147directory containing boot files
148.It Pa /var/run/rbootd.pid
149process id
150.El
151.Sh SEE ALSO
152.Xr kill 1 ,
153.Xr socket 2 ,
154.Xr signal 3 ,
155.Xr syslog 3 ,
156.Xr rmp 4
157.Sh BUGS
158If multiple servers are started on the same interface, each will receive
159and respond to the same boot packets.
160