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