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