share/man/man8/man8.alpha/mkbootimage.8

   1 .\" $NetBSD: mkbootimage.8,v 1.6 2002/02/13 08:18:25 ross Exp $
   2 .\"
   3 .\" Copyright (c) 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 MKBOOTIMAGE 8 alpha
  37 .Os
  38 .Sh NAME
  39 .Nm mkbootimage
  40 .Nd turn Alpha bootstrap programs into bootable images
  41 .Sh SYNOPSIS
  42 .Nm /usr/mdec/mkbootimage
  43 .Op Fl nv
  44 .Ar infile
  45 .Op Ar outfile
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility creates bootable image files from
  50 .Nx Ns Tn /alpha
  51 bootstrap programs.  Bootable image
  52 files can be placed directly on disk or tape to create bootable
  53 media which can be booted by the SRM console.  This is
  54 primarily useful for creating bootable tapes or disk sets with the
  55 .Pa /usr/mdec/ustarboot
  56 bootstrap program, or for creating firmware upgrade media
  57 using firmware upgrade programs.
  58 .Pp
  59 The bootstrap program
  60 .Ar infile
  61 is padded to a 512-byte boundary, has a properly formed
  62 Alpha Boot Block prepended, and is written to the output file
  63 .Ar outfile .
  64 If no output file is specified, the result is written to
  65 standard output.
  66 .Pp
  67 The
  68 .Nm
  69 utility does not install bootstrap programs to make
  70 disks bootable.  To do that, use
  71 .Xr installboot 8 .
  72 Similarly, it is not necessary to use
  73 .Nm
  74 to create images to boot over the network; network-capable
  75 bootstrap programs are usable without modification.
  76 .Pp
  77 The options recognized by
  78 .Nm
  79 are as follows:
  80 .Bl -tag -width flag
  81 .It Fl n
  82 Do not actually write the result to the output file or
  83 standard output.
  84 .It Fl v
  85 Print information about what
  86 .Nm
  87 is doing.
  88 .El
  89 .Pp
  90 The
  91 .Nm
  92 utility exits 0 on success, and \*[Gt]0 if an error occurs.
  93 .Sh FILES
  94 .Bl -tag -width /usr/mdec/ustarboot -compact
  95 .It Pa /usr/mdec/ustarboot
  96 .Dq ustar
  97 file system bootstrap program
  98 .El
  99 .Sh EXAMPLES
 100 .Bd -literal -offset indent
 101 mkbootimage as200_v5_8.exe as200_v5_8.exe.bootimage
 102 .Ed
 103 .Pp
 104 Create a bootable image from the (firmware image) file
 105 .Pa as200_v5_8.exe .
 106 That bootable image could then be written to floppy,
 107 disk, CD-ROM, or tape to create bootable firmware
 108 update media.
 109 .Pp
 110 .Bd -literal -offset indent
 111 (mkbootimage /usr/mdec/ustarboot; tar cvf - netbsd) | \\
 112     dd of=/dev/rst0
 113 .Ed
 114 .Pp
 115 Make a bootable image from the bootstrap program
 116 .Pa /usr/mdec/ustarboot ,
 117 concatenate it with a tar file containing a kernel,
 118 and write the output to a tape.  This is an example of
 119 how to create a tape which boots a kernel.
 120 .Sh SEE ALSO
 121 .Xr boot 8 ,
 122 .Xr installboot 8
 123 .Sh HISTORY
 124 The
 125 .Nx Ns Tn /alpha
 126 .Nm
 127 command first appeared in
 128 .Nx 1.4 .
 129 .Sh AUTHORS
 130 The
 131 .Nm
 132 utility was written by Chris Demetriou.