xref: /illumos-gate/usr/src/boot/common/help.common (revision 533affcbc7fc4d0c8132976ea454aaa715fe2307)
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# Tconsole DOutput information about console devices
61
62	console
63
64	Display the currently active console device(s) and show
65	information about available console devices.
66
67################################################################################
68# Tchain DChain load disk block
69
70	chain disk:
71
72	chain will read stage1 (MBR or VBR) boot block from specified device
73	to address 0000:7C00 and attempts to run it. Use lsdev to get available
74	device names. Disk name must end with colon.
75
76################################################################################
77# Techo DEcho arguments
78
79	echo [-n] [<message>]
80
81	Emits <message>, with no trailing newline if -n is specified.  This is
82	most useful in conjunction with scripts and the '@' line prefix.
83
84	Variables are substituted by prefixing them with $, eg.
85
86		echo Current device is $currdev
87
88	will print the current device.
89
90################################################################################
91# Tframebuffer DManage framebuffer setup
92
93	framebuffer on | off | get | list [depth] | set <display or mode number>
94
95	Switch framebuffer mode on or off, get current mode, list available
96	modes or set mode by using either display resolution or framebuffer
97	mode number. If the system does not provide display resolution via
98	EDID, the default resolution will be set to 800x600. If depth is not
99	specified, the best depth is used.
100
101################################################################################
102# Tload DLoad a kernel or module
103
104	load [-t <type>] <filename> [arguments]
105
106	Loads the module contained in <filename> into memory.  If no other
107	modules are loaded, <filename> must be a kernel or the command will
108	fail.
109
110	If -t is specified, the module is loaded as raw data of <type>, for
111	later use by the kernel or other modules.  <type> may be any string.
112
113	Optional arguments will be set as module arguments.
114
115################################################################################
116# Tls DList files
117
118	ls [-l] [<path>]
119
120	Displays a listing of files in the directory <path>, or the root
121	directory of the current device if <path> is not specified.
122
123	The -l argument displays file sizes as well; the process of obtaining
124	file sizes on some media may be very slow.
125
126################################################################################
127# Tlsdev DList devices
128
129	lsdev [-v]
130
131	List all of the devices from which it may be possible to load modules.
132	If -v is specified, print more details.
133
134################################################################################
135# Tlsmod DList modules
136
137	lsmod [-v]
138
139	List loaded modules. If [-v] is specified, print more details.
140
141################################################################################
142# Tmap-vdisk DMap virtual disk
143
144	map-vdisk filename
145
146	Map file as virtual disk.
147
148################################################################################
149# Tmore DPage files
150
151	more <filename> [<filename> ...]
152
153	Show contents of text files. When displaying the contents of more,
154	than one file, if the user elects to quit displaying a file, the
155	remaining files will not be shown.
156
157################################################################################
158# Tpnpscan DScan for PnP devices
159
160	pnpscan [-v]
161
162	Scan for Plug-and-Play devices.  This command is normally automatically
163	run as part of the boot process, in order to dynamically load modules
164	required for system operation.
165
166	If the -v argument is specified, details on the devices found will
167	be printed.
168
169################################################################################
170# Tset DSet a variable
171
172	set <variable name>
173	set <variable name>=<value>
174
175	The set command is used to set variables.
176
177################################################################################
178# Tsetprop DSet a variable
179
180	setprop <variable name> <value>
181
182	The setprop command is used to set variables.
183
184################################################################################
185# Tset Sautoboot_delay DSet the default autoboot delay
186
187	set autoboot_delay=<value>
188
189	Sets the default delay for the autoboot command to <value> seconds.
190	Set value to -1 if you don't want to allow user to interrupt autoboot
191	process and escape to the loader prompt.
192
193################################################################################
194# Tset Sbootfile DSet the default boot file set
195
196	set bootfile=<filename>[;<filename>...]
197
198	Sets the default set of kernel boot filename(s). It may be overridden
199	by setting the bootfile variable to a semicolon-separated list of
200	filenames, each of which will be searched for in the module_path
201	directories. The default bootfile set is "unix".
202
203################################################################################
204# Tset Sboot_ask DPrompt for configuration information
205
206	set boot_ask
207
208	Instructs the kernel to prompt the user for the configuration
209	information when the kernel is booted.
210
211################################################################################
212# Tset Sboot_drop_into_kmdb DDrop into the kernel debugger (kmdb)
213
214	set boot_drop_into_kmdb
215
216	Instructs the kernel to start in the kmdb debugger, rather than
217	proceeding to initialize when booted. Can only be used when boot_kmdb
218	is set.
219
220################################################################################
221# Tset Sboot_kmdb DStart the kernel debugger (kmdb)
222
223	set boot_kmdb
224
225	Instructs the kernel to start the kmdb debugger and then continue
226	with normal boot.
227
228################################################################################
229# Tset Sboot_reconfigure DInitaiate reconfiguration boot
230
231	set boot_reconfigure
232
233	The system will probe all attached hardware devices and configure
234	the logical namespace in /dev.
235
236################################################################################
237# Tset Sboot_multicons DUse multiple consoles
238
239	set boot_multicons
240
241	Enables multiple console support in the kernel early on boot.
242	In a running system, console configuration can be manipulated
243	by the conscontrol(8) utility.
244
245################################################################################
246# Tset Sboot_single DBoot into the single user mode
247
248	set boot_single
249
250	Boots only to init level 's'.
251
252################################################################################
253# Tset Sboot_verbose DBoot with verbose messages enabled
254
255	set boot_verbose
256
257	Without this setting, the messages are only logged in the system log.
258
259################################################################################
260# Tset Sconsole DSet the current console
261
262	set console[=<value>[,<value>]]
263
264	Sets the current console.  If <value> is omitted, a list of valid
265	consoles will be displayed.
266
267################################################################################
268# Tset Scurrdev DSet the current device
269
270	set currdev=<device>
271
272	Selects the default device.  See lsdev for available devices.
273
274################################################################################
275# Tset Smodule_path DSet the module search path
276
277	set module_path=<path>[;<path>...]
278
279	Sets the list of directories which will be searched in for modules
280	named in a load command or implicitly required by a dependency. The
281	default module_path is "/boot/modules" with the kernel directory
282	prepended.
283
284################################################################################
285# Tset Sprompt DSet the command prompt
286
287	set prompt=<value>
288
289	The command prompt is displayed when the loader is waiting for input.
290	Variable substitution is performed on the prompt.  The default
291	prompt can be set with:
292
293		set prompt=\${interpret}
294
295################################################################################
296# Tset Sscreen-font DSet the framebuffer font
297
298	Without the value, will list the currently available list
299	of the fonts.
300
301################################################################################
302# Tset Srootdev DSet the root filesystem
303
304	set rootdev=<path>
305
306	By default the value of $currdev is used to set the root filesystem
307	when the kernel is booted.  This can be overridden by setting
308	$rootdev explicitly.
309
310################################################################################
311# Tshow DShow the values of variables
312
313	show [<variable>]
314
315	Displays the value of <variable>, or all variables if not specified.
316
317################################################################################
318# Tsifting DSearch for words containing a substring
319
320	sifting <substring>
321
322	Displays words in the search order list containing the provided
323	<substring>.
324
325################################################################################
326# Tinclude DRead commands from a script file
327
328	include <filename> [<filename> ...]
329
330	The entire contents of <filename> are read into memory before executing
331	commands, so it is safe to source a file from removable media.
332
333################################################################################
334# Tread DRead input from the terminal
335
336	read [-t <value>] [-p <prompt>] [<variable name>]
337
338	The read command reads a line of input from the terminal.  If the
339	-t argument is specified, it will return nothing if no input has been
340	received after <value> seconds.  (Any keypress will cancel the
341	timeout).
342
343	If -p is specified, <prompt> is printed before reading input. No
344	newline is emitted after the prompt.
345
346	If a variable name is supplied, the variable is set to the value read,
347	less any terminating newline.
348
349################################################################################
350# Tunload DRemove all modules from memory
351
352	unload
353
354	This command removes any kernel and all loaded modules from memory.
355
356################################################################################
357# Tunmap-vdisk DUnmap virtual disk
358
359	unmap-vdisk diskname
360
361	Delete virtual disk mapping.
362
363################################################################################
364# Tunset DUnset a variable
365
366	unset <variable name>
367
368	If allowed, the named variable's value is discarded and the variable
369	is removed.
370
371################################################################################
372