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