]> code.delx.au - refind/blob - refind.conf-sample
Work around problem with (bogus, I think) "invalid parameter" errors
[refind] / refind.conf-sample
1 #
2 # refind.conf
3 # Configuration file for the rEFInd boot menu
4 #
5
6 # Timeout in seconds for the main menu screen. Setting the timeout to 0
7 # disables automatic booting (i.e., no timeout). Setting it to -1 causes
8 # an immediate boot to the default OS *UNLESS* a keypress is in the buffer
9 # when rEFInd launches, in which case that keypress is interpreted as a
10 # shortcut key. If no matching shortcut is found, rEFInd displays its
11 # menu with no timeout.
12 #
13 timeout 20
14
15 # Screen saver timeout; the screen blanks after the specified number of
16 # seconds with no keyboard input. The screen returns after most keypresses
17 # (unfortunately, not including modifier keys such as Shift, Control, Alt,
18 # or Option). Setting a value of "-1" causes rEFInd to start up with its
19 # screen saver active. The default is 0, which disables the screen saver.
20 #screensaver 300
21
22 # Hide user interface elements for personal preference or to increase
23 # security:
24 # banner - the rEFInd title banner (built-in or loaded via "banner")
25 # label - boot option text label in the menu
26 # singleuser - remove the submenu options to boot Mac OS X in single-user
27 # or verbose modes; affects ONLY MacOS X
28 # safemode - remove the submenu option to boot Mac OS X in "safe mode"
29 # hwtest - the submenu option to run Apple's hardware test
30 # arrows - scroll arrows on the OS selection tag line
31 # hints - brief command summary in the menu
32 # editor - the options editor (+, F2, or Insert on boot options menu)
33 # badges - device-type badges for boot options
34 # all - all of the above
35 # Default is none of these (all elements active)
36 #
37 #hideui singleuser
38 #hideui all
39
40 # Set the name of a subdirectory in which icons are stored. Icons must
41 # have the same names they have in the standard directory. The directory
42 # name is specified relative to the main rEFInd binary's directory. If
43 # an icon can't be found in the specified directory, an attempt is made
44 # to load it from the default directory; thus, you can replace just some
45 # icons in your own directory and rely on the default for others.
46 # Default is "icons".
47 #
48 #icons_dir myicons
49
50 # Use a custom title banner instead of the rEFInd icon and name. The file
51 # path is relative to the directory where refind.efi is located. The color
52 # in the top left corner of the image is used as the background color
53 # for the menu screens. Currently uncompressed BMP images with color
54 # depths of 24, 8, 4 or 1 bits are supported, as well as PNG images.
55 #
56 #banner hostname.bmp
57 #banner mybanner.png
58
59 # Specify how to handle banners that aren't exactly the same as the screen
60 # size:
61 # noscale - Crop if too big, show with border if too small
62 # fillscreen - Fill the screen
63 # Default is noscale
64 #
65 #banner_scale fillscreen
66
67 # Icon sizes. All icons are square, so just one value is specified. The
68 # big icons are used for OS selectors in the first row and the small
69 # icons are used for tools on the second row. Drive-type badges are 1/4
70 # the size of the big icons. Legal values are 32 and above. If the icon
71 # files do not hold icons of the proper size, the icons are scaled to
72 # the specified size. The default values are 48 and 128 for small and
73 # big icons, respectively.
74 #
75 #small_icon_size 96
76 #big_icon_size 256
77
78 # Custom images for the selection background. There is a big one (144 x 144)
79 # for the OS icons, and a small one (64 x 64) for the function icons in the
80 # second row. If only a small image is given, that one is also used for
81 # the big icons by stretching it in the middle. If only a big one is given,
82 # the built-in default will be used for the small icons.
83 #
84 # Like the banner option above, these options take a filename of an
85 # uncompressed BMP image file with a color depth of 24, 8, 4, or 1 bits,
86 # or a PNG image. The PNG format is required if you need transparency
87 # support (to let you "see through" to a full-screen banner).
88 #
89 #selection_big selection-big.bmp
90 #selection_small selection-small.bmp
91
92 # Set the font to be used for all textual displays in graphics mode.
93 # The font must be a PNG file with alpha channel transparency. It must
94 # contain ASCII characters 32-126 (space through tilde), inclusive, plus
95 # a glyph to be displayed in place of characters outside of this range,
96 # for a total of 96 glyphs. Only monospaced fonts are supported. Fonts
97 # may be of any size, although large fonts can produce display
98 # irregularities.
99 # The default is rEFInd's built-in font, Luxi Mono Regular 12 point.
100 #
101 #font myfont.png
102
103 # Use text mode only. When enabled, this option forces rEFInd into text mode.
104 # Passing this option a "0" value causes graphics mode to be used. Pasing
105 # it no value or any non-0 value causes text mode to be used.
106 # Default is to use graphics mode.
107 #
108 #textonly
109
110 # Set the EFI text mode to be used for textual displays. This option
111 # takes a single digit that refers to a mode number. Mode 0 is normally
112 # 80x25, 1 is sometimes 80x50, and higher numbers are system-specific
113 # modes. Mode 1024 is a special code that tells rEFInd to not set the
114 # text mode; it uses whatever was in use when the program was launched.
115 # If you specify an invalid mode, rEFInd pauses during boot to inform
116 # you of valid modes.
117 # CAUTION: On VirtualBox, and perhaps on some real computers, specifying
118 # a text mode and uncommenting the "textonly" option while NOT specifying
119 # a resolution can result in an unusable display in the booted OS.
120 # Default is 1024 (no change)
121 #
122 #textmode 2
123
124 # Set the screen's video resolution. Pass this option either:
125 # * two values, corresponding to the X and Y resolutions
126 # * one value, corresponding to a GOP (UEFI) video mode
127 # Note that not all resolutions are supported. On UEFI systems, passing
128 # an incorrect value results in a message being shown on the screen to
129 # that effect, along with a list of supported modes. On EFI 1.x systems
130 # (e.g., Macintoshes), setting an incorrect mode silently fails. On both
131 # types of systems, setting an incorrect resolution results in the default
132 # resolution being used. A resolution of 1024x768 usually works, but higher
133 # values often don't.
134 # Default is "0 0" (use the system default resolution, usually 800x600).
135 #
136 #resolution 1024 768
137 #resolution 3
138
139 # Launch specified OSes in graphics mode. By default, rEFInd switches
140 # to text mode and displays basic pre-launch information when launching
141 # all OSes except OS X. Using graphics mode can produce a more seamless
142 # transition, but displays no information, which can make matters
143 # difficult if you must debug a problem. Also, on at least one known
144 # computer, using graphics mode prevents a crash when using the Linux
145 # kernel's EFI stub loader. You can specify an empty list to boot all
146 # OSes in text mode.
147 # Valid options:
148 # osx - Mac OS X
149 # linux - A Linux kernel with EFI stub loader
150 # elilo - The ELILO boot loader
151 # grub - The GRUB (Legacy or 2) boot loader
152 # windows - Microsoft Windows
153 # Default value: osx
154 #
155 #use_graphics_for osx,linux
156
157 # Which non-bootloader tools to show on the tools line, and in what
158 # order to display them:
159 # shell - the EFI shell (requires external program; see rEFInd
160 # documentation for details)
161 # memtest - the memtest86 program, in EFI/tools, EFI/memtest86,
162 # EFI/memtest, EFI/tools/memtest86, or EFI/tools/memtest
163 # gptsync - the (dangerous) gptsync.efi utility (requires external
164 # program; see rEFInd documentation for details)
165 # gdisk - the gdisk partitioning program
166 # apple_recovery - boots the Apple Recovery HD partition, if present
167 # windows_recovery - boots an OEM Windows recovery tool, if present
168 # (see also the windows_recovery_files option)
169 # mok_tool - makes available the Machine Owner Key (MOK) maintenance
170 # tool, MokManager.efi, used on Secure Boot systems
171 # about - an "about this program" option
172 # exit - a tag to exit from rEFInd
173 # shutdown - shuts down the computer (a bug causes this to reboot
174 # many UEFI systems)
175 # reboot - a tag to reboot the computer
176 # firmware - a tag to reboot the computer into the firmware's
177 # user interface (ignored on older computers)
178 # netboot - launch the ipxe.efi tool for network (PXE) booting
179 # Default is shell,memtest,gdisk,apple_recovery,windows_recovery,mok_tool,about,shutdown,reboot,firmware
180 #
181 #showtools shell, gdisk, memtest, mok_tool, about, reboot, exit, firmware
182
183 # Boot loaders that can launch a Windows restore or emergency system.
184 # These tend to be OEM-specific.
185 # Default is LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
186 #
187 #windows_recovery_files LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
188
189 # Directories in which to search for EFI drivers. These drivers can
190 # provide filesystem support, give access to hard disks on plug-in
191 # controllers, etc. In most cases none are needed, but if you add
192 # EFI drivers and you want rEFInd to automatically load them, you
193 # should specify one or more paths here. rEFInd always scans the
194 # "drivers" and "drivers_{arch}" subdirectories of its own installation
195 # directory (where "{arch}" is your architecture code); this option
196 # specifies ADDITIONAL directories to scan.
197 # Default is to scan no additional directories for EFI drivers
198 #
199 #scan_driver_dirs EFI/tools/drivers,drivers
200
201 # Which types of boot loaders to search, and in what order to display them:
202 # internal - internal EFI disk-based boot loaders
203 # external - external EFI disk-based boot loaders
204 # optical - EFI optical discs (CD, DVD, etc.)
205 # netboot - EFI network (PXE) boot options
206 # hdbios - BIOS disk-based boot loaders
207 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.)
208 # cd - BIOS optical-disc boot loaders
209 # manual - use stanzas later in this configuration file
210 # Note that the legacy BIOS options require firmware support, which is
211 # not present on all computers.
212 # The netboot option is experimental and relies on the ipxe.efi and
213 # ipxe_discover.efi program files.
214 # On UEFI PCs, default is internal,external,optical,manual
215 # On Macs, default is internal,hdbios,external,biosexternal,optical,cd,manual
216 #
217 #scanfor internal,external,optical,manual
218
219 # By default, rEFInd relies on the UEFI firmware to detect BIOS-mode boot
220 # devices. This sometimes doesn't detect all the available devices, though.
221 # For these cases, uefi_deep_legacy_scan results in a forced scan and
222 # modification of NVRAM variables on each boot. Adding "0", "off", or
223 # "false" resets to the default value. This token has no effect on Macs or
224 # when no BIOS-mode options are set via scanfor.
225 # Default is unset (or "uefi_deep_legacy_scan false")
226 #
227 #uefi_deep_legacy_scan
228
229 # Delay for the specified number of seconds before scanning disks.
230 # This can help some users who find that some of their disks
231 # (usually external or optical discs) aren't detected initially,
232 # but are detected after pressing Esc.
233 # The default is 0.
234 #
235 #scan_delay 5
236
237 # When scanning volumes for EFI boot loaders, rEFInd always looks for
238 # Mac OS X's and Microsoft Windows' boot loaders in their normal locations,
239 # and scans the root directory and every subdirectory of the /EFI directory
240 # for additional boot loaders, but it doesn't recurse into these directories.
241 # The also_scan_dirs token adds more directories to the scan list.
242 # Directories are specified relative to the volume's root directory. This
243 # option applies to ALL the volumes that rEFInd scans UNLESS you include
244 # a volume name and colon before the directory name, as in "myvol:/somedir"
245 # to scan the somedir directory only on the filesystem named myvol. If a
246 # specified directory doesn't exist, it's ignored (no error condition
247 # results). The default is to scan the "boot" directory in addition to
248 # various hard-coded directories.
249 #
250 #also_scan_dirs boot,ESP2:EFI/linux/kernels
251
252 # Partitions (or whole disks, for legacy-mode boots) to omit from scans.
253 # For EFI-mode scans, you must specify a volume by its label, which you
254 # can obtain in an EFI shell by typing "vol", from Linux by typing
255 # "blkid /dev/{devicename}", or by examining the disk's label in various
256 # OSes' file browsers.
257 # For legacy-mode scans, you can specify any subset of the boot loader
258 # description shown when you highlight the option in rEFInd.
259 # The default is "LRS_ESP".
260 #
261 #dont_scan_volumes "Recovery HD"
262
263 # Directories that should NOT be scanned for boot loaders. By default,
264 # rEFInd doesn't scan its own directory, the EFI/tools directory, the
265 # EFI/memtest directory, the EFI/memtest86 directory, or the
266 # com.apple.recovery.boot directory. Using the dont_scan_dirs option
267 # enables you to "blacklist" other directories; but be sure to use "+"
268 # as the first element if you want to continue blacklisting existing
269 # directories. You might use this token to keep EFI/boot/bootx64.efi out
270 # of the menu if that's a duplicate of another boot loader or to exclude
271 # a directory that holds drivers or non-bootloader utilities provided by
272 # a hardware manufacturer. If a directory is listed both here and in
273 # also_scan_dirs, dont_scan_dirs takes precedence. Note that this
274 # blacklist applies to ALL the filesystems that rEFInd scans, not just
275 # the ESP, unless you precede the directory name by a filesystem name,
276 # as in "myvol:EFI/somedir" to exclude EFI/somedir from the scan on the
277 # myvol volume but not on other volumes.
278 #
279 #dont_scan_dirs ESP:/EFI/boot,EFI/Dell,EFI/memtest86
280
281 # Files that should NOT be included as EFI boot loaders (on the
282 # first line of the display). If you're using a boot loader that
283 # relies on support programs or drivers that are installed alongside
284 # the main binary or if you want to "blacklist" certain loaders by
285 # name rather than location, use this option. Note that this will
286 # NOT prevent certain binaries from showing up in the second-row
287 # set of tools. Most notably, various Secure Boot and recovery
288 # tools are present in this list, but may appear as second-row
289 # items.
290 # The file may be specified as a bare name (e.g., "notme.efi"), as
291 # a complete filename (e.g., "/EFI/somedir/notme.efi"), or as a
292 # complete filename with volume (e.g., "SOMEDISK:/EFI/somedir/notme.efi").
293 # The default is shim.efi,shim-fedora.efi,shimx64.efi,PreLoader.efi,
294 # TextMode.efi,ebounce.efi,GraphicsConsole.efi,MokManager.efi,HashTool.efi,
295 # HashTool-signed.efi,bootmgr.efi
296 #
297 #dont_scan_files shim.efi,MokManager.efi
298
299 # Scan for Linux kernels that lack a ".efi" filename extension. This is
300 # useful for better integration with Linux distributions that provide
301 # kernels with EFI stub loaders but that don't give those kernels filenames
302 # that end in ".efi", particularly if the kernels are stored on a
303 # filesystem that the EFI can read. When set to "1", "true", or "on", this
304 # option causes all files in scanned directories with names that begin with
305 # "vmlinuz" or "bzImage" to be included as loaders, even if they lack ".efi"
306 # extensions. Passing this option a "0", "false", or "off" value causes
307 # kernels without ".efi" extensions to NOT be scanned.
308 # Default is "true" -- to scan for kernels without ".efi" extensions.
309 #
310 #scan_all_linux_kernels false
311
312 # Set the maximum number of tags that can be displayed on the screen at
313 # any time. If more loaders are discovered than this value, rEFInd shows
314 # a subset in a scrolling list. If this value is set too high for the
315 # screen to handle, it's reduced to the value that the screen can manage.
316 # If this value is set to 0 (the default), it's adjusted to the number
317 # that the screen can handle.
318 #
319 #max_tags 0
320
321 # Set the default menu selection. The available arguments match the
322 # keyboard accelerators available within rEFInd. You may select the
323 # default loader using:
324 # - A digit between 1 and 9, in which case the Nth loader in the menu
325 # will be the default.
326 # - A "+" symbol at the start of the string, which refers to the most
327 # recently booted loader.
328 # - Any substring that corresponds to a portion of the loader's title
329 # (usually the OS's name or boot loader's path).
330 # You may also specify multiple selectors by separating them with commas
331 # and enclosing the list in quotes. (The "+" option is only meaningful in
332 # this context.)
333 # If you follow the selector(s) with two times, in 24-hour format, the
334 # default will apply only between those times. The times are in the
335 # motherboard's time standard, whether that's UTC or local time, so if
336 # you use UTC, you'll need to adjust this from local time manually.
337 # Times may span midnight as in "23:30 00:30", which applies to 11:30 PM
338 # to 12:30 AM. You may specify multiple default_selection lines, in which
339 # case the last one to match takes precedence. Thus, you can set a main
340 # option without a time followed by one or more that include times to
341 # set different defaults for different times of day.
342 # The default behavior is to boot the previously-booted OS.
343 #
344 #default_selection 1
345 #default_selection Microsoft
346 #default_selection "+,bzImage,vmlinuz"
347 #default_selection Maintenance 23:30 2:00
348 #default_selection "Maintenance,OS X" 1:00 2:30
349
350 # Enable VMX bit and lock the CPU MSR if unlocked.
351 # On some Intel Apple computers, the firmware does not lock the MSR 0x3A.
352 # The symptom on Windows is Hyper-V not working even if the CPU
353 # meets the minimum requirements (HW assisted virtualization and SLAT)
354 # DO NOT SET THIS EXCEPT ON INTEL CPUs THAT SUPPORT VMX! See
355 # http://www.thomas-krenn.com/en/wiki/Activating_the_Intel_VT_Virtualization_Feature!
356 # for more on this subject.
357 # The default is false: Don't try to enable and lock the MSR.
358 #
359 #enable_and_lock_vmx false
360
361 # Include a secondary configuration file within this one. This secondary
362 # file is loaded as if its options appeared at the point of the "include"
363 # token itself, so if you want to override a setting in the main file,
364 # the secondary file must be referenced AFTER the setting you want to
365 # override. Note that the secondary file may NOT load a tertiary file.
366 #
367 #include manual.conf
368
369 # Sample manual configuration stanzas. Each begins with the "menuentry"
370 # keyword followed by a name that's to appear in the menu (use quotes
371 # if you want the name to contain a space) and an open curly brace
372 # ("{"). Each entry ends with a close curly brace ("}"). Common
373 # keywords within each stanza include:
374 #
375 # volume - identifies the filesystem from which subsequent files
376 # are loaded. You can specify the volume by label or by
377 # a number followed by a colon (as in "0:" for the first
378 # filesystem or "1:" for the second).
379 # loader - identifies the boot loader file
380 # initrd - Specifies an initial RAM disk file
381 # icon - specifies a custom boot loader icon
382 # ostype - OS type code to determine boot options available by
383 # pressing Insert. Valid values are "MacOS", "Linux",
384 # "Windows", and "XOM". Case-sensitive.
385 # graphics - set to "on" to enable graphics-mode boot (useful
386 # mainly for MacOS) or "off" for text-mode boot.
387 # Default is auto-detected from loader filename.
388 # options - sets options to be passed to the boot loader; use
389 # quotes if more than one option should be passed or
390 # if any options use characters that might be changed
391 # by rEFInd parsing procedures (=, /, #, or tab).
392 # disabled - use alone or set to "yes" to disable this entry.
393 #
394 # Note that you can use either DOS/Windows/EFI-style backslashes (\)
395 # or Unix-style forward slashes (/) as directory separators. Either
396 # way, all file references are on the ESP from which rEFInd was
397 # launched.
398 # Use of quotes around parameters causes them to be interpreted as
399 # one keyword, and for parsing of special characters (spaces, =, /,
400 # and #) to be disabled. This is useful mainly with the "options"
401 # keyword. Use of quotes around parameters that specify filenames is
402 # permissible, but you must then use backslashes instead of slashes,
403 # except when you must pass a forward slash to the loader, as when
404 # passing a root= option to a Linux kernel.
405
406 # Below are several sample boot stanzas. All are disabled by default.
407 # Find one similar to what you need, copy it, remove the "disabled" line,
408 # and adjust the entries to suit your needs.
409
410 # A sample entry for a Linux 3.3 kernel with its new EFI boot stub
411 # support on a filesystem called "KERNELS". This entry includes
412 # Linux-specific boot options and specification of an initial RAM disk.
413 # Note uses of Linux-style forward slashes, even in the initrd
414 # specification. Also note that a leading slash is optional in file
415 # specifications.
416 menuentry Linux {
417 icon EFI/refind/icons/os_linux.png
418 volume KERNELS
419 loader bzImage-3.3.0-rc7
420 initrd initrd-3.3.0.img
421 options "ro root=UUID=5f96cafa-e0a7-4057-b18f-fa709db5b837"
422 disabled
423 }
424
425 # A sample entry for loading Ubuntu using its standard name for
426 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
427 menuentry Ubuntu {
428 loader /EFI/ubuntu/grubx64.efi
429 icon /EFI/refind/icons/os_linux.png
430 disabled
431 }
432
433 # A minimal ELILO entry, which probably offers nothing that
434 # auto-detection can't accomplish.
435 menuentry "ELILO" {
436 loader \EFI\elilo\elilo.efi
437 disabled
438 }
439
440 # Like the ELILO entry, this one offers nothing that auto-detection
441 # can't do; but you might use it if you want to disable auto-detection
442 # but still boot Windows....
443 menuentry "Windows 7" {
444 loader \EFI\Microsoft\Boot\bootmgfw.efi
445 disabled
446 }
447
448 # EFI shells are programs just like boot loaders, and can be
449 # launched in the same way. You can pass a shell the name of a
450 # script that it's to run on the "options" line. The script
451 # could initialize hardware and then launch an OS, or it could
452 # do something entirely different.
453 menuentry "Windows via shell script" {
454 icon \EFI\refind\icons\os_win.png
455 loader \EFI\tools\shell.efi
456 options "fs0:\EFI\tools\launch_windows.nsh"
457 disabled
458 }
459
460 # Mac OS is normally detected and run automatically; however,
461 # if you want to do something unusual, a manual boot stanza may
462 # be the way to do it. This one does nothing very unusual, but
463 # it may serve as a starting point. Note that you'll almost
464 # certainly need to change the "volume" line for this example
465 # to work.
466 menuentry "My Mac OS X" {
467 icon \EFI\refind\icons\os_mac.png
468 volume "OS X boot"
469 loader \System\Library\CoreServices\boot.efi
470 disabled
471 }