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