xref: /netbsd-src/share/man/man8/hpcboot.8 (revision 99bf06da72a7a4255ced072fb784b208bcc11cc0)
1.\"	$NetBSD: hpcboot.8,v 1.6 2019/12/23 17:31:54 reed Exp $
2.\"
3.\" Copyright (c) 2004 Valeriy E. Ushakov
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. Neither the name of the author nor the names of any
12.\"    contributors may be used to endorse or promote products derived
13.\"    from this software without specific prior written permission.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd April 3, 2004
28.Dt HPCBOOT 8
29.Os
30.Sh NAME
31.Nm hpcboot
32.Nd load and boot kernel from Windows\ CE
33.Sh SYNOPSIS
34.Nm hpcboot.exe
35.Sh DESCRIPTION
36.Nm
37is a program that runs on Windows\ CE.
38It loads and executes the specified
39.Nx
40kernel.
41.Nm
42supports hpcarm, hpcmips, and hpcsh ports.
43.Pp
44Click on the
45.Dq Boot
46button to start the boot process with selected options.
47Click on the
48.Dq Cancel
49button to exit
50.Nm .
51.\"
52.Ss Kernel Tab
53.\"
54On this tab you can select the kernel to boot and options to pass to
55the kernel.
56.Bl -tag -width "xx"
57.It Directory
58In this combobox you specify the
59.Dq current
60directory.
61The kernel and miniroot image pathnames are taken to be relative to
62this directory.
63.Pp
64.Nm
65can load kernel and miniroot from FAT and UFS filesystems, and via
66HTTP.
67.\" FIXME: describe the syntax for each of the above
68.It Kernel
69In this text field you specify the name of the kernel to load.
70Kernels compressed with
71.Xr gzip 1
72are supported.
73.It Model
74Select your H/PC model in this combobox.
75.It Root File System
76This group of controls lets you specify the desired root file system
77type.
78You can select
79.Xr wd 4 ,
80.Xr sd 4 ,
81.Xr md 4 ,
82and NFS root.
83.Pp
84If you select
85.Xr md 4
86memory disk root file system, you should specify the path name of the
87file system image in the text field below.
88Miniroot images compressed with
89.Xr gzip 1
90are supported.
91.It Kernel Boot Flags
92This group of controls is used to pass boot flags to the kernel.
93.El
94.\"
95.Ss Option Tab
96.\"
97On this tab you can specify miscellaneous options that mostly control the
98.Nm
99program itself.
100.Bl -tag -width "xx"
101.It Auto Boot
102If this option is selected
103.Nm
104will automatically boot
105.Nx
106after the specified timeout.
107.It Reverse Video
108Tells kernel if it should use the framebuffer in reverse video mode.
109.It Pause Before Boot
110If selected, a warning dialog will be presented
111.Em before
112anything is done, right after the
113.Dq Boot
114button is pressed.
115.It Load Debug Info
116This option currently does nothing.
117.It Safety Message
118If selected, a warning dialog will be presented
119.Em after
120the kernel has been loaded and prepared to be started.
121This will be your last chance to cancel the boot.
122.It Extra Kernel Options
123In this text field you can specify additional options to pass to the
124kernel.
125.El
126.\"
127.Ss Console Tab
128.\"
129This tab gets its name from the big text area that
130.Nm
131uses as the
132.Dq console
133to report its progress.
134.Bl -tag -width "xx"
135.It Save To File
136If checked, the progress log will be sent to the specified file instead.
137.It Dq Checkboxes Anonymous
138The row of 8 checkboxes controls debugging options for
139.Nm
140itself.
141They control the bits of an internal variable, the leftmost checkbox
142being the 7th bit.
143.It Dq Buttons Anonymous
144The buttons
145.Dq a
146to
147.Dq d
148control 4
149.Dq hooks
150a developer might want to use during
151.Nm
152development.
153.El
154.Sh SEE ALSO
155.Xr kloader 4 ,
156.Xr boot 8
157.Sh HISTORY
158The
159.Nm
160utility first appeared in
161.Nx 1.6 .
162.Sh BUGS
163.Nm
164reads the entire kernel image at once,
165and requires enough free area on the main memory.
166