share/man/man8/man8.alpha/setnetbootinfo.8

   1 .\" $NetBSD: setnetbootinfo.8,v 1.10 2001/09/05 23:53:22 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 1999 Christopher G. Demetriou
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"          This product includes software developed for the
  17 .\"          NetBSD Project.  See http://www.NetBSD.org/ for
  18 .\"          information about NetBSD.
  19 .\" 4. The name of the author may not be used to endorse or promote products
  20 .\"    derived from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
  34 .\"
  35 .Dd April 3, 1999
  36 .Dt SETNETBOOTINFO 8 alpha
  37 .Os
  38 .Sh NAME
  39 .Nm setnetbootinfo
  40 .Nd configure Alpha network bootstrap program
  41 .Sh SYNOPSIS
  42 .Nm /usr/mdec/setnetbootinfo
  43 .Op Fl vf
  44 .Op Fl o Ar outfile
  45 .Oo
  46 .Fl a Ar ether-address | Fl h Ar ether-host
  47 .Oc
  48 .Ar infile
  49 .Nm /usr/mdec/setnetbootinfo
  50 .Op Fl v
  51 .Fl u o Ar outfile Ar infile
  52 .Sh DESCRIPTION
  53 The
  54 .Nm setnetbootinfo
  55 utility configures the
  56 .Nx Ns Tn /alpha
  57 network bootstrap program so
  58 that it can be used to bootstrap systems with old firmware revisions.
  59 .Pp
  60 The
  61 .Nx Ns Tn /alpha
  62 network bootstrap program needs to have the ethernet
  63 address of the interface being used to boot the system available when
  64 querying other hosts on the network for bootstrapping information.
  65 Alpha systems with old firmware revisions provide no way for
  66 network bootstrap programs to determine the ethernet address of
  67 the interface that they are booting from, and so the
  68 .Nx Ns Tn /alpha
  69 network bootstrap program must find that information in another way.
  70 (Newer firmware revisions include the ethernet address in the name of
  71 the device that is being booted from.)
  72 The
  73 .Nm
  74 utility encodes an ethernet address (and other information) directly
  75 into the network bootstrap program.
  76 .Pp
  77 The options recognized by
  78 .Nm
  79 are as follows:
  80 .Bl -tag -width flag
  81 .It Fl a Ar ether-address
  82 Encode the given ethernet address into the network bootstrap program.
  83 (This option and the
  84 .Fl h
  85 option are mutually exclusive.)
  86 .It Fl f
  87 Force the address information being encoded in the bootstrap
  88 program to be used regardless of whether or not the bootstrap
  89 program can get address information from the booting system's
  90 firmware.
  91 .It Fl h Ar ether-host
  92 Encode the ethernet address of the specified host into the network
  93 bootstrap program.  The host's name is translated to an ethernet
  94 address using the
  95 .Xr ether_hostton 3
  96 function.
  97 (This option and the
  98 .Fl a
  99 option are mutually exclusive.)
 100 .It Fl o Ar outfile
 101 Output the resulting bootstrap program into the file named by
 102 .Ar outfile ,
 103 replacing it if it already exists.  If the
 104 .Fl o
 105 flag is not specified, the output file name will be
 106 the name of the input bootstrap program concatenated with a
 107 period and the digits of the ethernet address being encoded.
 108 For instance, if the input file is named
 109 .Pa /usr/mdec/netboot
 110 and is being configured to encode the ethernet address
 111 .Li 08:00:2b:bd:5d:fd ,
 112 then the default output file name would be
 113 .Pa /usr/mdec/netboot.08002bbd5dfd .
 114 It is safe to set the output file name to be the same as the
 115 input file name; the input file is read in its entirety before
 116 the output file is modified.
 117 .It Fl u
 118 Remove configuration information from the specified network
 119 bootstrap program.  If this option is used, an output file name must be
 120 specified with the
 121 .Fl o
 122 option, and neither the
 123 .Fl a
 124 or the
 125 .Fl h
 126 options may be specified.
 127 .It Fl v
 128 Verbose mode.
 129 .El
 130 .Sh FILES
 131 .Bl -tag -width /usr/mdec/ustarboot -compact
 132 .It Pa /usr/mdec/netboot
 133 network bootstrap program
 134 .El
 135 .\" .Sh EXAMPLES
 136 .\" There should be some examples of how to use
 137 .\" .Nm setnetbootinfo .
 138 .\" XXX
 139 .Sh SEE ALSO
 140 .Xr boot 8 ,
 141 .Xr bootpd 8
 142 .Sh HISTORY
 143 The
 144 .Nx Ns Tn /alpha
 145 .Nm
 146 command first appeared in
 147 .Nx 1.3 .
 148 .Sh AUTHORS
 149 The
 150 .Nm
 151 utility was written by Chris Demetriou.