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