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