rbootd.8 - pub/scm/linux/kernel/git/deller/rbootd - Git at Google

 .\"	$NetBSD: rbootd.8,v 1.3 1995/08/21 17:05:16 thorpej Exp $
 .\"
 .\" Copyright (c) 1988, 1992 The University of Utah and the Center
 .\"	for Software Science (CSS).
 .\" Copyright (c) 1992, 1993
 .\"	The Regents of the University of California.  All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Center for Software Science of the University of Utah Computer
 .\" Science Department.  CSS requests users of this software to return
 .\" to css-dist@cs.utah.edu any improvements that they make and grant
 .\" CSS redistribution rights.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" 1. Redistributions of source code must retain the above copyright
 .\"    notice, this list of conditions and the following disclaimer.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 3. All advertising materials mentioning features or use of this software
 .\"    must display the following acknowledgement:
 .\"	This product includes software developed by the University of
 .\"	California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
 .\"	from: @(#)rbootd.8	8.2 (Berkeley) 12/11/93
 .\"
 .\" Utah Hdr: rbootd.man 3.1 92/07/06
 .\" Author: Jeff Forys, University of Utah CSS
 .\"
 .Dd "December 11, 1993"
 .Dt RBOOTD 8
 .Os
 .Sh NAME
 .Nm rbootd
 .Nd HP remote boot server
 .Sh SYNOPSIS
 .Nm rbootd
 .Op Fl ad
 .Op Fl i Ar interface
 .Op config_file
 .Sh DESCRIPTION
 The
 .Nm rbootd
 utility services boot requests from Hewlett-Packard workstations over a
 local area network.
 All boot files must reside in the boot file directory; further, if a
 client supplies path information in its boot request, it will be silently
 stripped away before processing.
 By default,
 .Nm rbootd
 only responds to requests from machines listed in its configuration file.
 .Pp
 The options are as follows:
 .Bl -tag -width Fl
 .It Fl a
 Respond to boot requests from any machine.
 The configuration file is ignored if this option is specified.
 .It Fl d
 Run
 .Nm rbootd
 in debug mode.
 Packets sent and received are displayed to the terminal.
 .It Fl i Ar interface
 Service boot requests on specified interface.
 If unspecified,
 .Nm rbootd
 searches the system interface list for the lowest numbered, configured
 ``up'' interface (excluding loopback).
 Ties are broken by choosing the earliest match.
 .El
 .Pp
 Specifying
 .Ar config_file
 on the command line causes
 .Nm rbootd
 to use a different configuration file from the default.
 .Pp
 The configuration file is a text file where each line describes a particular
 machine.
 A line must start with a machine's Ethernet address followed by an optional
 list of boot file names.
 An Ethernet address is specified in hexadecimal with each of its six octets
 separated by a colon.
 The boot file names come from the boot file directory.
 The ethernet address and boot file(s) must be separated by white-space
 and/or comma characters.
 A pound sign causes the remainder of a line to be ignored.
 .Pp
 Here is a sample configuration file:
 .Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX "# vandy (anything)"
 .It #
 .It # ethernet addr	boot file(s)	comments
 .It #
 .It 08:00:09:0:66:ad	SYSHPBSD	# snake (4.3BSD)
 .It 08:00:09:0:59:5b		# vandy (anything)
 .It 8::9:1:C6:75	SYSHPBSD,SYSHPUX	# jaguar (either)
 .El
 .Pp
 .Nm Rbootd
 logs status and error messages via
 .Xr syslog 3 .
 A startup message is always logged, and in the case of fatal errors (or
 deadly signals) a message is logged announcing the server's termination.
 In general, a non-fatal error is handled by ignoring the event that caused
 it (e.g. an invalid Ethernet address in the config file causes that line
 to be invalidated).
 .Pp
 The following signals have the specified effect when sent to the server
 process using the
 .Xr kill 1
 command:
 .Bl -tag -width SIGUSR1 -offset -compact
 .It SIGHUP
 Drop all active connections and reconfigure.
 .It SIGUSR1
 Turn on debugging, do nothing if already on.
 .It SIGUSR2
 Turn off debugging, do nothing if already off.
 .El
 .Sh "FILES"
 .Bl -tag -width /usr/bin/rbootd -compact
 .It /etc/rbootd.conf
 configuration file
 .It /tmp/rbootd.dbg
 debug output
 .It /var/lib/rbootd
 directory containing boot files
 .It /var/run/rbootd.pid
 process id
 .El
 .Sh SEE ALSO
 .Xr kill 1 ,
 .Xr socket 2 ,
 .Xr signal 3 ,
 .Xr syslog 3 ,
 .Sh BUGS
 If multiple servers are started on the same interface, each will receive
 and respond to the same boot packets.
 The interface should be specified in a configuration file rather than
 having to be put on the command line as an argument.  Also the location
 of the boot images is hardcoded into the binary at compile time.
	.\" $NetBSD: rbootd.8,v 1.3 1995/08/21 17:05:16 thorpej Exp $
	.\"
	.\" Copyright (c) 1988, 1992 The University of Utah and the Center
	.\" for Software Science (CSS).
	.\" Copyright (c) 1992, 1993
	.\" The Regents of the University of California. All rights reserved.
	.\"
	.\" This code is derived from software contributed to Berkeley by
	.\" the Center for Software Science of the University of Utah Computer
	.\" Science Department. CSS requests users of this software to return
	.\" to css-dist@cs.utah.edu any improvements that they make and grant
	.\" CSS redistribution rights.
	.\"
	.\" Redistribution and use in source and binary forms, with or without
	.\" modification, are permitted provided that the following conditions
	.\" are met:
	.\" 1. Redistributions of source code must retain the above copyright
	.\" notice, this list of conditions and the following disclaimer.
	.\" 2. Redistributions in binary form must reproduce the above copyright
	.\" notice, this list of conditions and the following disclaimer in the
	.\" documentation and/or other materials provided with the distribution.
	.\" 3. All advertising materials mentioning features or use of this software
	.\" must display the following acknowledgement:
	.\" This product includes software developed by the University of
	.\" California, Berkeley and its contributors.
	.\" 4. Neither the name of the University nor the names of its contributors
	.\" may be used to endorse or promote products derived from this software
	.\" without specific prior written permission.
	.\"
	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.
	.\"
	.\" from: @(#)rbootd.8 8.2 (Berkeley) 12/11/93
	.\"
	.\" Utah Hdr: rbootd.man 3.1 92/07/06
	.\" Author: Jeff Forys, University of Utah CSS
	.\"
	.Dd "December 11, 1993"
	.Dt RBOOTD 8
	.Os
	.Sh NAME
	.Nm rbootd
	.Nd HP remote boot server
	.Sh SYNOPSIS
	.Nm rbootd
	.Op Fl ad
	.Op Fl i Ar interface
	.Op config_file
	.Sh DESCRIPTION
	The
	.Nm rbootd
	utility services boot requests from Hewlett-Packard workstations over a
	local area network.
	All boot files must reside in the boot file directory; further, if a
	client supplies path information in its boot request, it will be silently
	stripped away before processing.
	By default,
	.Nm rbootd
	only responds to requests from machines listed in its configuration file.
	.Pp
	The options are as follows:
	.Bl -tag -width Fl
	.It Fl a
	Respond to boot requests from any machine.
	The configuration file is ignored if this option is specified.
	.It Fl d
	Run
	.Nm rbootd
	in debug mode.
	Packets sent and received are displayed to the terminal.
	.It Fl i Ar interface
	Service boot requests on specified interface.
	If unspecified,
	.Nm rbootd
	searches the system interface list for the lowest numbered, configured
	``up'' interface (excluding loopback).
	Ties are broken by choosing the earliest match.
	.El
	.Pp
	Specifying
	.Ar config_file
	on the command line causes
	.Nm rbootd
	to use a different configuration file from the default.
	.Pp
	The configuration file is a text file where each line describes a particular
	machine.
	A line must start with a machine's Ethernet address followed by an optional
	list of boot file names.
	An Ethernet address is specified in hexadecimal with each of its six octets
	separated by a colon.
	The boot file names come from the boot file directory.
	The ethernet address and boot file(s) must be separated by white-space
	and/or comma characters.
	A pound sign causes the remainder of a line to be ignored.
	.Pp
	Here is a sample configuration file:
	.Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX "# vandy (anything)"
	.It #
	.It # ethernet addr boot file(s) comments
	.It #
	.It 08:00:09:0:66:ad SYSHPBSD # snake (4.3BSD)
	.It 08:00:09:0:59:5b # vandy (anything)
	.It 8::9:1:C6:75 SYSHPBSD,SYSHPUX # jaguar (either)
	.El
	.Pp
	.Nm Rbootd
	logs status and error messages via
	.Xr syslog 3 .
	A startup message is always logged, and in the case of fatal errors (or
	deadly signals) a message is logged announcing the server's termination.
	In general, a non-fatal error is handled by ignoring the event that caused
	it (e.g. an invalid Ethernet address in the config file causes that line
	to be invalidated).
	.Pp
	The following signals have the specified effect when sent to the server
	process using the
	.Xr kill 1
	command:
	.Bl -tag -width SIGUSR1 -offset -compact
	.It SIGHUP
	Drop all active connections and reconfigure.
	.It SIGUSR1
	Turn on debugging, do nothing if already on.
	.It SIGUSR2
	Turn off debugging, do nothing if already off.
	.El
	.Sh "FILES"
	.Bl -tag -width /usr/bin/rbootd -compact
	.It /etc/rbootd.conf
	configuration file
	.It /tmp/rbootd.dbg
	debug output
	.It /var/lib/rbootd
	directory containing boot files
	.It /var/run/rbootd.pid
	process id
	.El
	.Sh SEE ALSO
	.Xr kill 1 ,
	.Xr socket 2 ,
	.Xr signal 3 ,
	.Xr syslog 3 ,
	.Sh BUGS
	If multiple servers are started on the same interface, each will receive
	and respond to the same boot packets.
	The interface should be specified in a configuration file rather than
	having to be put on the command line as an argument. Also the location
	of the boot images is hardcoded into the binary at compile time.