xref: /openbsd-src/sys/arch/hppa/stand/boot/boot.8 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: boot.8,v 1.22 2015/09/10 15:16:43 schwarze Exp $
2.\"
3.\" Copyright (c) 2002 Miodrag Vallat
4.\" Copyright (c) 1997-2002 Michael Shalayeff
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.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT,
20.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22.\" SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
25.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26.\" THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\"
29.Dd $Mdocdate: September 10 2015 $
30.Dt BOOT 8 hppa
31.Os
32.Sh NAME
33.Nm boot ,
34.Nm boot.conf
35.Nd hppa-specific bootstrap
36.Sh DESCRIPTION
37The main purpose of this program is to load the system kernel while dealing
38with the various features of the PA-RISC hardware.
39.Pp
40As described in
41.Xr boot_hppa 8 ,
42this program is loaded by the PDC firmware
43and provides a convenient way to load the kernel.
44.Pp
45Basic operations include:
46.Pp
47.Bl -bullet -compact
48.It
49Loading kernels from any device supported by your system.
50.It
51Loading kernels compressed by
52.Xr gzip 1 .
53.It
54Providing an interactive command line.
55.It
56Detecting and switching between multiple consoles.
57.El
58.Pp
59The sequence of its operation is as follows: initialization,
60parsing the configuration file, then an interactive command line.
61While at the command line you have 5 seconds to type any commands, if needed.
62If time expires, the kernel will be loaded according to
63the current variable settings (see the
64.Nm set
65command).
66Each time a kernel load fails, the timeout is increased by one second.
67The sequence of
68.Nm
69operations is as follows:
70.Bl -enum
71.It
72If the file
73.Pa /etc/boot.conf
74exists on the filesystem or LIF image
75.Nm
76was loaded from, open and parse it.
77Lines beginning with the
78.Sq #
79character,
80as well as whitespace at the beginning of lines,
81are ignored.
82The file may contain any commands
83.Nm
84accepts at the interactive prompt.
85Though default settings usually suffice, they can be changed here.
86.It
87The header line
88.Pp
89.Dl >> OpenBSD/hppa BOOT [x.xx]
90.Pp
91is displayed to the active console, where
92.Ar x.xx
93is the version number of the
94.Nm
95program, followed by the
96.Pp
97.Dl boot>
98.Pp
99prompt, which means you are in interactive mode and may enter commands.
100If you do not,
101.Nm
102will proceed to load the kernel with the current parameters after the
103timeout period has expired.
104.El
105.Pp
106By default,
107.Nm
108attempts to load the kernel executable
109.Pa /bsd .
110If it fails to find the kernel and no alternative kernel image has
111been specified, the system will be unable to boot.
112.Sh COMMANDS
113The following commands are accepted at the
114.Nm
115prompt:
116.Bl -tag -width shorten
117.It boot Oo Oo Ar device : Oc Ns Ar image Oc Op Fl acds
118Boots the specified kernel image
119with any options given.
120If
121.Ar device
122or
123.Ar image
124are omitted, values from
125.Nm
126variables will be used.
127.Bl -tag -width _a_
128.It Fl a
129Causes the kernel to ask for the
130.Nm root
131device to use.
132.It Fl c
133Causes the kernel to go into
134.Xr boot_config 8
135before performing
136.Xr autoconf 4
137procedures.
138.It Fl d
139Causes the kernel to drop into
140.Xr ddb 4
141at the earliest convenient point.
142.It Fl s
143Causes the kernel to boot single-user.
144.El
145.It echo Op Ar args
146Displays
147.Ar args
148on the console device.
149.It help
150Prints a list of available commands and machine dependent
151commands, if any.
152.It machine Op Ar command
153Issues machine-dependent commands.
154These are defined for hppa architecture:
155.Bl -tag -width keyboard
156.It Nm console
157Displays or sets the console path.
158.Pp
159When invoked with no argument, this command will display the configured
160console path found in the stable storage area.
161.Pp
162Otherwise, the argument will be interpreted as a console path
163definition string, and
164.Nm
165will attempt to switch the console configuration to the desired device.
166The console definition attempts to follow the PDC syntax,
167and would have a form of:
168.Bd -filled
169graphics
170.Op _head
171.Op .mode
172.Ed
173for graphics console, and
174.Bd -filled
175rs232
176.Op _2
177.Op .speed Op .bits Op .parity
178.Ed
179for serial console.
180.Pp
181The default head and mode for graphics console are 0, that is the default
182videomode of the first graphics device.
183The default serial settings are 9600 bps, 8 data bits, and no parity.
184.It Nm keyboard
185Displays or sets the keyboard path.
186.Pp
187When invoked with no argument, this command will display the configured
188keyboard path found in the stable storage area.
189.Pp
190Otherwise, the argument will be interpreted as a keyboard path definition
191string, and
192.Nm
193will attempt to switch the keyboard configuration to the desired port.
194The keyboard definition attempts to follow the PDC syntax,
195and would have a form of:
196.Bd -filled
197hil
198.Ed
199for hil keyboard, and
200.Bd -filled
201ps2
202.Ed
203for PS/2 keyboard.
204.El
205.Pp
206After changing any path settings, the machine usually has to be restarted for
207the changes to have effect.
208.It ls Op Ar directory
209Prints contents of the specified
210.Ar directory
211in long format including: attributes and file type, owner, group,
212size, filename.
213.It reboot
214Reboots the machine by initiating a warm boot procedure.
215.It set Op Ar varname Op Ar value
216If invoked without arguments, prints a list of variables and their values.
217If only
218.Ar varname
219is specified, displays contents of that variable.
220If
221.Ar varname
222and
223.Ar value
224are both specified, sets that variable to the given value.
225Variables include:
226.Pp
227.Bl -tag -compact -width boothow
228.It Nm addr
229Address at which to load the kernel.
230.It Nm debug
231Debug flag if
232.Nm
233was compiled with DEBUG defined.
234.It Nm device
235Boot device name (i.e.,
236.Li lf0a ,
237.Li sd0a ) .
238.It Nm howto
239Options to pass to the loaded kernel.
240.It Nm image
241File name containing the kernel image.
242.It Nm timeout
243Number of seconds boot will wait for human intervention before
244booting the default kernel image.
245.\" .It Nm tty
246.\" Active console device name (i.e.,
247.\" .Li ttya ,
248.\" .Li ttyb ,
249.\" .Li ite0) .
250.El
251.\" .It stty Op Ar device Op Ar speed
252.\" Displays or sets the
253.\" .Ar speed
254.\" for a console
255.\" .Ar device .
256.\" If changing the baudrate for the currently active console,
257.\" .Nm
258.\" offers you five seconds of grace time before committing the change
259.\" to allow you to change your terminal's speed to match.
260.\" If changing speed
261.\" .Em not
262.\" for the active console, the baudrate is set for the
263.\" .Em next
264.\" time you switch to a serial console.
265.\" The baudrate value is not used for the
266.\" .Li ite0
267.\" console.
268.\" .Pp
269.\" The default baudrate is 9600bps.
270.It time
271Displays system time and date.
272.El
273.Sh FILES
274.Bl -tag -width /etc/boot.conf -compact
275.It Pa /boot
276system bootstrap
277.It Pa /etc/boot.conf
278system bootstrap's startup file
279.It Pa /bsd
280kernel image
281.It Pa /bsd.rd
282kernel image for installation/recovery
283.El
284.Sh EXAMPLES
285Boot the default kernel:
286.Pp
287.Dl boot> boot
288.Pp
289Remove the 5 second pause at boot-time permanently, causing
290.Nm
291to load the kernel immediately without prompting:
292.Pp
293.Dl # echo \&"boot\&" > /etc/boot.conf
294.Pp
295Use serial console on the first serial port, with the usual 9600 8N1 settings.
296A null modem cable should connect the specified serial port to a terminal.
297Useful for debugging.
298.Pp
299.Dl boot> machine console rs232.9600.8.none
300.Pp
301Boot the kernel named
302.Pa /bsd
303from the second SCSI disk in
304.Dq User Kernel Configuration
305mode (see
306.Xr boot_config 8 ) .
307This mechanism allows for the explicit enabling and disabling of devices
308during the current boot sequence, as well as the modification
309of device parameters.
310Once booted, such changes can be made permanent by using
311.Xr config 8 Ns 's
312.Fl e
313option.
314.Pp
315.Dl boot> boot sd1a:/bsd -c
316.Sh SEE ALSO
317.Xr gzip 1 ,
318.Xr autoconf 4 ,
319.Xr ddb 4 ,
320.Xr boot_config 8 ,
321.Xr boot_hppa 8 ,
322.\" .Xr installboot 8 ,
323.Xr reboot 8
324.Sh HISTORY
325This program was written by Michael Shalayeff for
326.Ox 2.1 .
327The hppa specific parts were written by Michael Shalayeff and Miodrag Vallat
328for
329.Ox 3.1 .
330.Sh CAVEATS
331Making mistakes in console paths may cost you a toupee.
332.Sh BUGS
333Changing the display resolution (mode) on a graphics console does not work
334correctly.
335