libexec/rbootd/rbootd.8

   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 .\" $FreeBSD: src/libexec/rbootd/rbootd.8,v 1.9.2.3 2001/03/05 18:21:59 ru 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
  54 .Op Fl ad
  55 .Op Fl i Ar interface
  56 .Op config_file
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility services boot requests from Hewlett-Packard workstations over a
  61 local area network.
  62 All boot files must reside in the boot file directory; further, if a
  63 client supplies path information in its boot request, it will be silently
  64 stripped away before processing.
  65 By default,
  66 .Nm
  67 only responds to requests from machines listed in its configuration file.
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width indent
  71 .It Fl a
  72 Respond to boot requests from any machine.
  73 The configuration file is ignored if this option is specified.
  74 .It Fl d
  75 Run
  76 .Nm
  77 in debug mode.
  78 Packets sent and received are displayed to the terminal.
  79 .It Fl i Ar interface
  80 Service boot requests on specified interface.
  81 If unspecified,
  82 .Nm
  83 searches the system interface list for the lowest numbered, configured
  84 ``up'' interface (excluding loopback).
  85 Ties are broken by choosing the earliest match.
  86 .El
  87 .Pp
  88 Specifying
  89 .Ar config_file
  90 on the command line causes
  91 .Nm
  92 to use a different configuration file from the default.
  93 .Pp
  94 The configuration file is a text file where each line describes a particular
  95 machine.
  96 A line must start with a machine's Ethernet address followed by an optional
  97 list of boot file names.
  98 An Ethernet address is specified in hexadecimal with each of its six octets
  99 separated by a colon.
 100 The boot file names come from the boot file directory.
 101 The ethernet address and boot file(s) must be separated by white-space
 102 and/or comma characters.
 103 A pound sign causes the remainder of a line to be ignored.
 104 .Pp
 105 Here is a sample configuration file:
 106 .Bl -column 08:00:09:0:66:ad SYSHPBSD,SYSHPUX
 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
 116 logs status and error messages via
 117 .Xr syslog 3 .
 118 A startup message is always logged, and in the case of fatal errors (or
 119 deadly signals) a message is logged announcing the server's termination.
 120 In general, a non-fatal error is handled by ignoring the event that caused
 121 it (e.g. an invalid Ethernet address in the config file causes that line
 122 to be invalidated).
 123 .Pp
 124 The following signals have the specified effect when sent to the server
 125 process using the
 126 .Xr kill 1
 127 command:
 128 .Bl -tag -width SIGUSR1 -offset -compact
 129 .It SIGHUP
 130 Drop all active connections and reconfigure.
 131 .It SIGUSR1
 132 Turn on debugging, do nothing if already on.
 133 .It SIGUSR2
 134 Turn off debugging, do nothing if already off.
 135 .El
 136 .Sh "FILES"
 137 .Bl -tag -width /usr/libexec/rbootd -compact
 138 .It Pa /dev/bpf#
 139 packet-filter device
 140 .It Pa /etc/rbootd.conf
 141 configuration file
 142 .It Pa /tmp/rbootd.dbg
 143 debug output
 144 .It Pa /usr/mdec/rbootd
 145 directory containing boot files
 146 .It Pa /var/run/rbootd.pid
 147 process 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
 155 If multiple servers are started on the same interface, each will receive
 156 and respond to the same boot packets.