Sync usage with man page.
[netbsd-mini2440.git] / share / man / man8 / man8.acorn32 / boot32.8
blob326cb96fe45ee5dc977a3d7a11c5222e30e94034
1 .\" $NetBSD: boot32.8,v 1.2 2004/02/23 19:39:48 wiz Exp $
2 .\"
3 .\" Copyright (c) 2000, 2001 Ben Harris
4 .\" Copyright (c) 2004 Reinoud Zandijk
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .Dd September 4, 2009
30 .Dt BOOT32 8 acorn32
31 .Os
32 .Sh NAME
33 .Nm boot32
34 .Nd Bootloader for
35 .Nx Ns /acorn32
36 .Sh SYNOPSIS
37 .Nm *boot32
38 .Op Fl acdqsv
39 .Op Ar root=rootdir
40 .Op Ar file
41 .Sh DESCRIPTION
42 .Nm
43 is a program that runs under
44 .Tn RISC OS
45 and launches the
46 .Nx Ns /acorn32
47 kernel.
48 It needs to be installed in a RISC OS filesystem and given file
49 type FFA (Module).
50 The kernel it is to load also needs to be stored in a
51 .Tn RISC OS
52 filesystem.
53 .Pp
54 It takes the following standard
55 .Nx
56 options, which set flags in the
57 .Va boothowto
58 variable in the booted kernel (see
59 .Xr boothowto 9 ) .
60 Not all flags may be effective.
61 .Bl -tag -width Fl
62 .It Fl a
63 .Pq Dv RB_ASKNAME
64 Cause the kernel to prompt the user for the name of the device containing the
65 root filesystem.
66 This also causes
67 .Nm
68 to prompt for the name of the kernel to be loaded.
69 .It Fl s
70 .Pq Dv RB_SINGLE
71 Cause the kernel to ask
72 .Nm init
73 to boot into single-user mode.
74 .It Fl d
75 .Pq Dv RB_KDB
76 Cause the kernel to enter the kernel debugger as soon as possible.
77 .It Fl c
78 .Pq Dv RB_USERCONF
79 Enter the in-kernel device configuration manager before attaching any
80 devices.
81 .It Fl q
82 .Pq Dv RB_QUIET
83 Cause the kernel to emit fewer messages than normal while starting up.
84 .It Fl v
85 .Pq Dv RB_VERBOSE
86 Cause the kernel to emit more messages than normal while starting up.
87 .El
88 .Pp
89 .Nm
90 attempts to load the kernel from the RISC OS file specified as
91 .Ar file ,
92 or from
93 .Pa netbsd
95 .Ar file
96 is not specified.
97 The file must be an ELF image, and may have been compressed using
98 .Xr gzip 1 .
99 .Ss Use as a module
101 is implemented as a RISC OS relocatable module.
102 It can be loaded into memory by running
103 .Ql *RMLoad boot32 .
104 After this,
106 can be booted by running
107 .Ql *boot32
108 as usual, but the command will be handled by the module.
110 It should also be possible to arrange for
112 to be loaded from ROM (e.g., from the ROM on an expansion card), in which case
114 could be made to boot automatically by making
116 the configured language using
117 .Ql *Configure Language .
118 .Ss Screen display
119 When it starts up,
121 displays the number of 4 kilobyte memory pages it has been delegated by RISC-OS
122 and gives a summary about the memory map as reported by RISC-OS followed by a
123 table of physical memory ranges available to the bootloader.
124 All this information is mainly for bughunting booting problems.
126 It then checks its internal structures and kicks out RISC-OS, relocates all
127 memory pages loaded in to their final destinations and kickstarts
128 .Nm .
129 .Sh FILES
130 .Bl -tag -width Pa
131 .It Pa /usr/mdec/boot32,ffa
132 The location of
134 in the
136 filesystem.
138 .Sh SEE ALSO
139 .Xr gzip 1 ,
140 .Xr reboot 2 ,
141 .Xr ddb 4 ,
142 .Xr userconf 4 ,
143 .Xr init 8 ,
144 .Xr boothowto 9
145 .Sh HISTORY
147 was introduced in
148 .Nx 1.6
149 as a replacement for the original
150 .Nx Ns /arm32
151 bootloader, which was written in BBC BASIC.
152 .Sh BUGS
154 cannot load kernels from a
156 filesystem.