* Move /kernel to /boot/kernel and /modules to /boot/modules.
[dragonfly.git] / sys / boot / common / help.common
CommitLineData
984263bc
MD
1################################################################################
2# Thelp DDisplay command help
3
4 help [topic [subtopic]]
bc65ccee 5 help index
984263bc
MD
6 ?
7
8 The help command displays help on commands and their usage.
f4e821f3 9 $DragonFly: src/sys/boot/common/help.common,v 1.6 2008/09/01 19:39:45 dillon Exp $
984263bc
MD
10
11 In command help, a term enclosed with <...> indicates a value as
12 described by the term. A term enclosed with [...] is optional,
13 and may not be required by all forms of the command.
14
15 Some commands may not be available. Use the '?' command to list
16 most available commands.
17
5ee58eed
MD
18 If needed, disable the use of ACPI with:
19
20 unset acpi_load
bc65ccee 21 set hint.acpi.0.disabled="1"
5ee58eed 22
984263bc
MD
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# Tboot DBoot immediately
34
35 boot [<kernelname>] [-<arg> ...]
36
37 Boot the system. If arguments are specified, they are added to the
38 arguments for the kernel. If <kernelname> is specified, and a kernel
39 has not already been loaded, it will be booted instead of the default
40 kernel.
41
42################################################################################
43# Techo DEcho arguments
44
45 echo [-n] [<message>]
46
47 Emits <message>, with no trailing newline if -n is specified. This is
48 most useful in conjunction with scripts and the '@' line prefix.
49
50 Variables are substituted by prefixing them with $, eg.
51
52 echo Current device is $currdev
53
54 will print the current device.
55
56################################################################################
57# Tload DLoad a kernel or module
58
59 load [-t <type>] <filename>
60
61 Loads the module contained in <filename> into memory. If no other
62 modules are loaded, <filename> must be a kernel or the command will
63 fail.
64
65 If -t is specified, the module is loaded as raw data of <type>, for
66 later use by the kernel or other modules. <type> may be any string.
67
68################################################################################
69# Tls DList files
70
71 ls [-l] [<path>]
72
73 Displays a listing of files in the directory <path>, or the root
74 directory of the current device if <path> is not specified.
75
76 The -l argument displays file sizes as well; the process of obtaining
77 file sizes on some media may be very slow.
78
79################################################################################
80# Tlsdev DList devices
81
82 lsdev [-v]
83
84 List all of the devices from which it may be possible to load modules.
85 If -v is specified, print more details.
86
87################################################################################
88# Tlsmod DList modules
89
90 lsmod [-v]
91
92 List loaded modules. If [-v] is specified, print more details.
93
94################################################################################
95# Tmore DPage files
96
97 more <filename> [<filename> ...]
98
99 Show contents of text files. When displaying the contents of more,
100 than one file, if the user elects to quit displaying a file, the
101 remaining files will not be shown.
102
103################################################################################
104# Tpnpscan DScan for PnP devices
105
106 pnpscan [-v]
107
108 Scan for Plug-and-Play devices. This command is normally automatically
109 run as part of the boot process, in order to dynamically load modules
110 required for system operation.
111
112 If the -v argument is specified, details on the devices found will
113 be printed.
114
115################################################################################
116# Tset DSet a variable
117
118 set <variable name>
119 set <variable name>=<value>
120
121 The set command is used to set variables.
122
123################################################################################
124# Tset Sautoboot_delay DSet the default autoboot delay
125
126 set autoboot_delay=<value>
127
128 Sets the default delay for the autoboot command to <value> seconds.
129
130################################################################################
131# Tset Sbootfile DSet the default boot file set
132
133 set bootfile=<filename>[;<filename>...]
134
135 Sets the default set of kernel boot filename(s). It may be overridden
136 by setting the bootfile variable to a semicolon-separated list of
137 filenames, each of which will be searched for in the module_path
5ee58eed 138 directories. The default bootfile set is "kernel".
984263bc
MD
139
140################################################################################
141# Tset Sboot_askname DPrompt for root device
142
143 set boot_askname
144
145 Instructs the kernel to prompt the user for the name of the root device
146 when the kernel is booted.
147
148################################################################################
149# Tset Sboot_ddb DDrop to the kernel debugger (DDB)
150
151 set boot_ddb
152
153 Instructs the kernel to start in the DDB debugger, rather than
154 proceeding to initialise when booted.
155
156################################################################################
157# Tset Sboot_gdb DSelect gdb-remote mode
158
159 set boot_gdb
160
161 Selects gdb-remote mode for the kernel debugger by default.
162
163################################################################################
164# Tset Sboot_single DStart system in single-user mode
165
166 set boot_single
167
168 Prevents the kernel from initiating a multi-user startup, single-user
169 mode will be entered when the kernel has finished device probes.
170
171################################################################################
172# Tset Sboot_verbose DVerbose boot messages
173
174 set boot_verbose
175
176 Setting this variable causes extra debugging information to be printed
177 by the kernel during the boot phase.
178
179################################################################################
180# Tset Sconsole DSet the current console
181
182 set console[=<value>]
183
184 Sets the current console. If <value> is omitted, a list of valid
185 consoles will be displayed.
186
187################################################################################
188# Tset Scurrdev DSet the current device
189
190 set currdev=<device>
191
bc65ccee 192 Selects the default device. See lsdev for available devices.
984263bc
MD
193
194################################################################################
195# Tset Sinit_path DSet the list of init candidates
196
197 set init_path=<path>[:<path>...]
198
199 Sets the list of binaries which the kernel will try to run as initial
200 process.
201
202
203################################################################################
204# Tset Smodule_path DSet the module search path
205
206 set module_path=<path>[;<path>...]
207
208 Sets the list of directories which will be searched in for modules
209 named in a load command or implicitly required by a dependency. The
f4e821f3 210 default module_path is "/boot;/boot/modules;/;/modules".
984263bc
MD
211
212################################################################################
213# Tset Sprompt DSet the command prompt
214
215 set prompt=<value>
216
217 The command prompt is displayed when the loader is waiting for input.
218 Variable substitution is performed on the prompt. The default
219 prompt can be set with:
220
bc65ccee 221 set prompt=\${interpret}
984263bc
MD
222
223################################################################################
224# Tset Srootdev DSet the root filesystem
225
226 set rootdev=<path>
227
228 By default the value of $currdev is used to set the root filesystem
229 when the kernel is booted. This can be overridden by setting
230 $rootdev explicitly.
231
232################################################################################
233# Tset Stunables DSet kernel tunable values
234
235 Various kernel tunable parameters can be overridden by specifying new
236 values in the environment.
237
238 set kern.ipc.nmbclusters=<value> NMBCLUSTERS
239
240 Set the number of mbuf clusters to be allocated. The value
241 cannot be set below the default determined when the kernel
242 was compiled.
243
5ee58eed
MD
244 set kern.ipc.nsfbufs=<value> NSFBUFS
245
246 Set the number of sendfile buffers to be allocated. This
247 overrides the value determined when the kernel was compiled.
248
4ad6607f 249 set kern.vm.kmem.size=<value>
984263bc
MD
250
251 Sets the size of kernel memory (bytes). This overrides
5ee58eed 252 the value determined when the kernel was compiled.
984263bc 253
5ee58eed 254 set machdep.disable_mtrrs=1
984263bc 255
5ee58eed 256 Disable the use of i686 MTRRs (i386 only)
984263bc
MD
257
258 set net.inet.tcp.tcbhashsize=<value> TCBHASHSIZE
259
260 Overrides the compile-time set value of TCBHASHSIZE or
261 the preset default of 512. Must be a power of 2.
262
5ee58eed
MD
263 hw.syscons.sc_no_suspend_vtswitch=<value>
264
265 Disable VT switching on suspend.
266
267 value is 0 (default) or non-zero to enable.
268
984263bc
MD
269 set hw.physmem=<value> MAXMEM (i386 only)
270
271 Limits the amount of physical memory space available to
272 the system to <value> bytes. <value> may have a k, M or G
273 suffix to indicate kilobytes, megabytes and gigabytes
274 respectively. Note that the current i386 architecture
275 limits this value to 4GB.
276
277 On systems where memory cannot be accurately probed,
278 this option provides a hint as to the actual size of
279 system memory (which will be tested before use).
280
5ee58eed
MD
281 set hw.pci.allow_unsupported_io_range=<value>
282
283 Allow the PCI Bridge to pass through an unsupported
284 memory range assigned by the BIOS.
285
286 value is 0 (default) or non-zero to enable.
287
288 set hw.pci.enable_io_modes=<value>
289
290 Enable PCI resources which are left off by some BIOSes
291 or are not enabled correctly by the device driver.
292
293 value is 1 (default), but this may cause problems with
294 some peripherals. Set to 0 to disable.
295
984263bc
MD
296################################################################################
297# Tshow DShow the values of variables
298
299 show [<variable>]
300
301 Displays the value of <variable>, or all variables if not specified.
302 Multiple paths can be separated with a semicolon.
303
304################################################################################
305# Tinclude DRead commands from a script file
306
307 include <filename> [<filename> ...]
308
309 The entire contents of <filename> are read into memory before executing
310 commands, so it is safe to source a file from removable media.
311
312################################################################################
313# Tread DRead input from the terminal
314
315 read [-t <value>] [-p <prompt>] [<variable name>]
316
317 The read command reads a line of input from the terminal. If the
318 -t argument is specified, it will return nothing if no input has been
319 received after <value> seconds. (Any keypress will cancel the
320 timeout).
321
322 If -p is specified, <prompt> is printed before reading input. No
323 newline is emitted after the prompt.
324
325 If a variable name is supplied, the variable is set to the value read,
326 less any terminating newline.
327
328################################################################################
329# Tunload DRemove all modules from memory
330
331 unload
332
333 This command removes any kernel and all loaded modules from memory.
334
335################################################################################
336# Tunset DUnset a variable
337
338 unset <variable name>
339
340 If allowed, the named variable's value is discarded and the variable
341 is removed.
342
343################################################################################