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