1 ################################################################################
2 # Thelp DDisplay command help
3
4 help [topic [subtopic]]
5 help index
6
7 The help command displays help on commands and their usage.
8
9 In command help, a term enclosed with <...> indicates a value as
10 described by the term. A term enclosed with [...] is optional,
11 and may not be required by all forms of the command.
12
13 Some commands may not be available. Use the '?' command to list
14 most available commands.
15
16 ################################################################################
17 # T? DList available commands
18
19 ?
20
21 Lists all available commands.
22
23 ################################################################################
24 # Tautoboot DBoot after a delay
25
26 autoboot [<delay> [<prompt>]]
27
28 Displays <prompt> or a default prompt, and counts down <delay> seconds
29 before attempting to boot. If <delay> is not specified, the default
30 value is 10.
31
32 ################################################################################
33 # Tbeadm DList or switch Boot Environment
34
35 beadm activate beName [<device>]
36 beadm list [<device>]
37
38 beadm activate unloads the currently loaded configuration and modules,
39 sets currdev to <device> and loads configuration from new device.
40 Use lsdev to get available device names.
41
42 ################################################################################
43 # Tboot DBoot immediately
44
45 boot [<kernelname>] [-<arg> ...]
46
47 Boot the system. If arguments are specified, they are added to the
48 arguments for the kernel. If <kernelname> is specified, and a kernel
49 has not already been loaded, it will be booted instead of the default
50 kernel.
51
52 ################################################################################
53 # Tbcachestat DGet disk block cache stats
54
55 bcachestat
56
57 Displays statistics about disk cache usage. For debugging only.
58
59 ################################################################################
60 # Tchain DChain load disk block
61
62 chain disk:
63
64 chain will read stage1 (MBR or VBR) boot block from specified device
65 to address 0000:7C00 and attempts to run it. Use lsdev to get available
66 device names. Disk name must end with colon.
67
68 ################################################################################
69 # Techo DEcho arguments
70
71 echo [-n] [<message>]
72
73 Emits <message>, with no trailing newline if -n is specified. This is
74 most useful in conjunction with scripts and the '@' line prefix.
75
76 Variables are substituted by prefixing them with $, eg.
77
78 echo Current device is $currdev
79
80 will print the current device.
81
82 ################################################################################
83 # Tframebuffer DManage framebuffer setup
84
85 framebuffer on | off | get | list [depth] | set <display or mode number>
86
87 Switch framebuffer mode on or off, get current mode, list available
88 modes or set mode by using either display resolution or framebuffer
89 mode number. If the system does not provide display resolution via
90 EDID, the default resolution will be set 800x600. If depth is not
91 specified, the best depth is used.
92
93 ################################################################################
94 # Tload DLoad a kernel or module
95
96 load [-t <type>] <filename> [arguments]
97
98 Loads the module contained in <filename> into memory. If no other
99 modules are loaded, <filename> must be a kernel or the command will
100 fail.
101
102 If -t is specified, the module is loaded as raw data of <type>, for
103 later use by the kernel or other modules. <type> may be any string.
104
105 Optional arguments will be set as module arguments.
106
107 ################################################################################
108 # Tls DList files
109
110 ls [-l] [<path>]
111
112 Displays a listing of files in the directory <path>, or the root
113 directory of the current device if <path> is not specified.
114
115 The -l argument displays file sizes as well; the process of obtaining
116 file sizes on some media may be very slow.
117
118 ################################################################################
119 # Tlsdev DList devices
120
121 lsdev [-v]
122
123 List all of the devices from which it may be possible to load modules.
124 If -v is specified, print more details.
125
126 ################################################################################
127 # Tlsmod DList modules
128
129 lsmod [-v]
130
131 List loaded modules. If [-v] is specified, print more details.
132
133 ################################################################################
134 # Tmore DPage files
135
136 more <filename> [<filename> ...]
137
138 Show contents of text files. When displaying the contents of more,
139 than one file, if the user elects to quit displaying a file, the
140 remaining files will not be shown.
141
142 ################################################################################
143 # Tpnpscan DScan for PnP devices
144
145 pnpscan [-v]
146
147 Scan for Plug-and-Play devices. This command is normally automatically
148 run as part of the boot process, in order to dynamically load modules
149 required for system operation.
150
151 If the -v argument is specified, details on the devices found will
152 be printed.
153
154 ################################################################################
155 # Tset DSet a variable
156
157 set <variable name>
158 set <variable name>=<value>
159
160 The set command is used to set variables.
161
162 ################################################################################
163 # Tsetprop DSet a variable
164
165 setprop <variable name> <value>
166
167 The setprop command is used to set variables.
168
169 ################################################################################
170 # Tset Sautoboot_delay DSet the default autoboot delay
171
172 set autoboot_delay=<value>
173
174 Sets the default delay for the autoboot command to <value> seconds.
175 Set value to -1 if you don't want to allow user to interrupt autoboot
176 process and escape to the loader prompt.
177
178 ################################################################################
179 # Tset Sbootfile DSet the default boot file set
180
181 set bootfile=<filename>[;<filename>...]
182
183 Sets the default set of kernel boot filename(s). It may be overridden
184 by setting the bootfile variable to a semicolon-separated list of
185 filenames, each of which will be searched for in the module_path
186 directories. The default bootfile set is "unix".
187
188 ################################################################################
189 # Tset Sboot_ask DPrompt for configuration information
190
191 set boot_ask
192
193 Instructs the kernel to prompt the user for the configuration
194 information when the kernel is booted.
195
196 ################################################################################
197 # Tset Sboot_debug DDrop to the kernel debugger (kmdb)
198
199 set boot_debug
200
201 Instructs the kernel to start in the kmdb debugger, rather than
202 proceeding to initialize when booted. Can only be used when boot_kmdb
203 is set.
204
205 ################################################################################
206 # Tset Sboot_kmdb DStart the kernel debugger (kmdb)
207
208 set boot_kmdb
209
210 Instructs the kernel to start the kmdb debugger and then continue
211 with normal boot.
212
213 ################################################################################
214 # Tset Sboot_reconfigure DInitaiate reconfiguration boot
215
216 set boot_reconfigure
217
218 The system will probe all attached hardware devices and configure
219 the logical namespace in /dev.
220
221 ################################################################################
222 # Tset Sboot_multicons DUse multiple consoles
223
224 set boot_multicons
225
226 Enables multiple console support in the kernel early on boot.
227 In a running system, console configuration can be manipulated
228 by the conscontrol(8) utility.
229
230 ################################################################################
231 # Tset Sboot_single DBoot into the single user mode
232
233 set boot_single
234
235 Boots only to init level 's'.
236
237 ################################################################################
238 # Tset Sboot_verbose DBoot with verbose messages enabled
239
240 set boot_verbose
241
242 Without this setting, the messages are only logged in the system log.
243
244 ################################################################################
245 # Tset Sconsole DSet the current console
246
247 set console[=<value>[,<value>]]
248
249 Sets the current console. If <value> is omitted, a list of valid
250 consoles will be displayed.
251
252 ################################################################################
253 # Tset Scurrdev DSet the current device
254
255 set currdev=<device>
256
257 Selects the default device. See lsdev for available devices.
258
259 ################################################################################
260 # Tset Smodule_path DSet the module search path
261
262 set module_path=<path>[;<path>...]
263
264 Sets the list of directories which will be searched in for modules
265 named in a load command or implicitly required by a dependency. The
266 default module_path is "/boot/modules" with the kernel directory
267 prepended.
268
269 ################################################################################
270 # Tset Sprompt DSet the command prompt
271
272 set prompt=<value>
273
274 The command prompt is displayed when the loader is waiting for input.
275 Variable substitution is performed on the prompt. The default
276 prompt can be set with:
277
278 set prompt=\${interpret}
279
280 ################################################################################
281 # Tset Sscreen-font DSet the framebuffer font
282
283 Without the value, will list the currently available list
284 of the fonts.
285
286 ################################################################################
287 # Tset Srootdev DSet the root filesystem
288
289 set rootdev=<path>
290
291 By default the value of $currdev is used to set the root filesystem
292 when the kernel is booted. This can be overridden by setting
293 $rootdev explicitly.
294
295 ################################################################################
296 # Tshow DShow the values of variables
297
298 show [<variable>]
299
300 Displays the value of <variable>, or all variables if not specified.
301
302 ################################################################################
303 # Tinclude DRead commands from a script file
304
305 include <filename> [<filename> ...]
306
307 The entire contents of <filename> are read into memory before executing
308 commands, so it is safe to source a file from removable media.
309
310 ################################################################################
311 # Tread DRead input from the terminal
312
313 read [-t <value>] [-p <prompt>] [<variable name>]
314
315 The read command reads a line of input from the terminal. If the
316 -t argument is specified, it will return nothing if no input has been
317 received after <value> seconds. (Any keypress will cancel the
318 timeout).
319
320 If -p is specified, <prompt> is printed before reading input. No
321 newline is emitted after the prompt.
322
323 If a variable name is supplied, the variable is set to the value read,
324 less any terminating newline.
325
326 ################################################################################
327 # Tunload DRemove all modules from memory
328
329 unload
330
331 This command removes any kernel and all loaded modules from memory.
332
333 ################################################################################
334 # Tunset DUnset a variable
335
336 unset <variable name>
337
338 If allowed, the named variable's value is discarded and the variable
339 is removed.
340
341 ################################################################################