]> code.delx.au - refind/blobdiff - refind.conf-sample
Tweaks for OS X 10.10 (Yosemite) and new support to enable and lock
[refind] / refind.conf-sample
index 6cc17cd3f3053dbdc1b914251609c58f3d6efd7f..ab7cd665ab93e0ef1999591a1d816ad1fab2a505 100644 (file)
@@ -4,13 +4,24 @@
 #
 
 # Timeout in seconds for the main menu screen. Setting the timeout to 0
-# disables automatic booting (i.e., no timeout).
+# disables automatic booting (i.e., no timeout). Setting it to -1 causes
+# an immediate boot to the default OS *UNLESS* a keypress is in the buffer
+# when rEFInd launches, in which case that keypress is interpreted as a
+# shortcut key. If no matching shortcut is found, rEFInd displays its
+# menu with no timeout.
 #
 timeout 20
 
+# Screen saver timeout; the screen blanks after the specified number of
+# seconds with no keyboard input. The screen returns after most keypresses
+# (unfortunately, not including modifier keys such as Shift, Control, Alt,
+# or Option). Setting a value of "-1" causes rEFInd to start up with its
+# screen saver active. The default is 0, which disables the screen saver.
+#screensaver 300
+
 # Hide user interface elements for personal preference or to increase
 # security:
-#  banner      - the rEFInd title banner
+#  banner      - the rEFInd title banner (built-in or loaded via "banner")
 #  label       - boot option text label in the menu
 #  singleuser  - remove the submenu options to boot Mac OS X in single-user
 #                or verbose modes; affects ONLY MacOS X
@@ -44,6 +55,25 @@ timeout 20
 #banner hostname.bmp
 #banner mybanner.png
 
+# Specify how to handle banners that aren't exactly the same as the screen
+# size:
+#  noscale     - Crop if too big, show with border if too small
+#  fillscreen  - Fill the screen
+# Default is noscale
+#
+#banner_scale fillscreen
+
+# Icon sizes. All icons are square, so just one value is specified. The
+# big icons are used for OS selectors in the first row and the small
+# icons are used for tools on the second row. Drive-type badges are 1/4
+# the size of the big icons. Legal values are 32 and above. If the icon
+# files do not hold icons of the proper size, the icons are scaled to
+# the specified size. The default values are 48 and 128 for small and
+# big icons, respectively.
+#
+#small_icon_size 96
+#big_icon_size 256
+
 # Custom images for the selection background. There is a big one (144 x 144)
 # for the OS icons, and a small one (64 x 64) for the function icons in the
 # second row. If only a small image is given, that one is also used for
@@ -58,6 +88,17 @@ timeout 20
 #selection_big   selection-big.bmp
 #selection_small selection-small.bmp
 
+# Set the font to be used for all textual displays in graphics mode.
+# The font must be a PNG file with alpha channel transparency. It must
+# contain ASCII characters 32-126 (space through tilde), inclusive, plus
+# a glyph to be displayed in place of characters outside of this range,
+# for a total of 96 glyphs. Only monospaced fonts are supported. Fonts
+# may be of any size, although large fonts can produce display
+# irregularities.
+# The default is rEFInd's built-in font, Luxi Mono Regular 12 point.
+#
+#font myfont.png
+
 # Use text mode only. When enabled, this option forces rEFInd into text mode.
 # Passing this option a "0" value causes graphics mode to be used. Pasing
 # it no value or any non-0 value causes text mode to be used.
@@ -114,21 +155,34 @@ timeout 20
 
 # Which non-bootloader tools to show on the tools line, and in what
 # order to display them:
-#  shell           - the EFI shell (requires external program; see rEFInd
-#                    documentation for details)
-#  gptsync         - the (dangerous) gptsync.efi utility (requires external
-#                    program; see rEFInd documentation for details)
-#  apple_recovery  - boots the Apple Recovery HD partition, if present
-#  mok_tool        - makes available the Machine Owner Key (MOK) maintenance
-#                    tool, MokManager.efi, used on Secure Boot systems
-#  about           - an "about this program" option
-#  exit            - a tag to exit from rEFInd
-#  shutdown        - shuts down the computer (a bug causes this to reboot
-#                    EFI systems)
-#  reboot          - a tag to reboot the computer
-# Default is shell,apple_recovery,mok_tool,about,shutdown,reboot
-#
-#showtools shell, mok_tool, about, reboot, exit
+#  shell            - the EFI shell (requires external program; see rEFInd
+#                     documentation for details)
+#  memtest          - the memtest86 program, in EFI/tools, EFI/memtest86,
+#                     EFI/memtest, EFI/tools/memtest86, or EFI/tools/memtest
+#  gptsync          - the (dangerous) gptsync.efi utility (requires external
+#                     program; see rEFInd documentation for details)
+#  gdisk            - the gdisk partitioning program
+#  apple_recovery   - boots the Apple Recovery HD partition, if present
+#  windows_recovery - boots an OEM Windows recovery tool, if present
+#                     (see also the windows_recovery_files option)
+#  mok_tool         - makes available the Machine Owner Key (MOK) maintenance
+#                     tool, MokManager.efi, used on Secure Boot systems
+#  about            - an "about this program" option
+#  exit             - a tag to exit from rEFInd
+#  shutdown         - shuts down the computer (a bug causes this to reboot
+#                     many UEFI systems)
+#  reboot           - a tag to reboot the computer
+#  firmware         - a tag to reboot the computer into the firmware's
+#                     user interface (ignored on older computers)
+# Default is shell,memtest,gdisk,apple_recovery,windows_recovery,mok_tool,about,shutdown,reboot,firmware
+#
+#showtools shell, gdisk, memtest, mok_tool, about, reboot, exit, firmware
+
+# Boot loaders that can launch a Windows restore or emergency system.
+# These tend to be OEM-specific.
+# Default is LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
+#
+#windows_recovery_files LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
 
 # Directories in which to search for EFI drivers. These drivers can
 # provide filesystem support, give access to hard disks on plug-in
@@ -157,6 +211,16 @@ timeout 20
 #
 #scanfor internal,external,optical,manual
 
+# By default, rEFInd relies on the UEFI firmware to detect BIOS-mode boot
+# devices. This sometimes doesn't detect all the available devices, though.
+# For these cases, uefi_deep_legacy_scan results in a forced scan and
+# modification of NVRAM variables on each boot. Adding "0", "off", or
+# "false" resets to the default value. This token has no effect on Macs or
+# when no BIOS-mode options are set via scanfor.
+# Default is unset (or "uefi_deep_legacy_scan true")
+#
+#uefi_deep_legacy_scan
+
 # Delay for the specified number of seconds before scanning disks.
 # This can help some users who find that some of their disks
 # (usually external or optical discs) aren't detected initially,
@@ -180,29 +244,34 @@ timeout 20
 #
 #also_scan_dirs boot,ESP2:EFI/linux/kernels
 
-# Partitions to omit from scans. You must specify a volume by its
-# label, which you can obtain in an EFI shell by typing "vol", from
-# Linux by typing "blkid /dev/{devicename}", or by examining the
-# disk's label in various OSes' file browsers.
-# The default is an empty list (all volumes are scanned).
+# Partitions (or whole disks, for legacy-mode boots) to omit from scans.
+# For EFI-mode scans, you must specify a volume by its label, which you
+# can obtain in an EFI shell by typing "vol", from Linux by typing
+# "blkid /dev/{devicename}", or by examining the disk's label in various
+# OSes' file browsers.
+# For legacy-mode scans, you can specify any subset of the boot loader
+# description shown when you highlight the option in rEFInd.
+# The default is "LRS_ESP".
 #
 #dont_scan_volumes "Recovery HD"
 
 # Directories that should NOT be scanned for boot loaders. By default,
-# rEFInd doesn't scan its own directory or the EFI/tools directory.
-# You can "blacklist" additional directories with this option, which
-# takes a list of directory names as options. You might do this to
-# keep EFI/boot/bootx64.efi out of the menu if that's a duplicate of
-# another boot loader or to exclude a directory that holds drivers
-# or non-bootloader utilities provided by a hardware manufacturer. If
-# a directory is listed both here and in also_scan_dirs, dont_scan_dirs
-# takes precedence. Note that this blacklist applies to ALL the
-# filesystems that rEFInd scans, not just the ESP, unless you precede
-# the directory name by a filesystem name, as in "myvol:EFI/somedir"
-# to exclude EFI/somedir from the scan on the myvol volume but not on
-# other volumes.
-#
-#dont_scan_dirs ESP:/EFI/boot,EFI/Dell
+# rEFInd doesn't scan its own directory, the EFI/tools directory, the
+# EFI/memtest directory, the EFI/memtest86 directory, or the
+# com.apple.recovery.boot directory. Using the dont_scan_dirs option
+# enables you to "blacklist" other directories; but be sure to use "+"
+# as the first element if you want to continue blacklisting existing
+# directories. You might use this token to keep EFI/boot/bootx64.efi out
+# of the menu if that's a duplicate of another boot loader or to exclude
+# a directory that holds drivers or non-bootloader utilities provided by
+# a hardware manufacturer. If a directory is listed both here and in
+# also_scan_dirs, dont_scan_dirs takes precedence. Note that this
+# blacklist applies to ALL the filesystems that rEFInd scans, not just
+# the ESP, unless you precede the directory name by a filesystem name,
+# as in "myvol:EFI/somedir" to exclude EFI/somedir from the scan on the
+# myvol volume but not on other volumes.
+#
+#dont_scan_dirs ESP:/EFI/boot,EFI/Dell,EFI/memtest86
 
 # Files that should NOT be included as EFI boot loaders (on the
 # first line of the display). If you're using a boot loader that
@@ -210,10 +279,15 @@ timeout 20
 # the main binary or if you want to "blacklist" certain loaders by
 # name rather than location, use this option. Note that this will
 # NOT prevent certain binaries from showing up in the second-row
-# set of tools. Most notably, MokManager.efi is in this blacklist,
-# but will show up as a tool if present in certain directories. You
-# can control the tools row with the showtools token.
-# The default is shim.efi,MokManager.efi,TextMode.efi,ebounce.efi,GraphicsConsole.efi
+# set of tools. Most notably, various Secure Boot and recovery
+# tools are present in this list, but may appear as second-row
+# items.
+# The file may be specified as a bare name (e.g., "notme.efi"), as
+# a complete filename (e.g., "/EFI/somedir/notme.efi"), or as a
+# complete filename with volume (e.g., "SOMEDISK:/EFI/somedir/notme.efi").
+# The default is shim.efi,shim-fedora.efi,shimx64.efi,PreLoader.efi,
+# TextMode.efi,ebounce.efi,GraphicsConsole.efi,MokManager.efi,HashTool.efi,
+# HashTool-signed.efi,bootmgr.efi
 #
 #dont_scan_files shim.efi,MokManager.efi
 
@@ -221,16 +295,14 @@ timeout 20
 # useful for better integration with Linux distributions that provide
 # kernels with EFI stub loaders but that don't give those kernels filenames
 # that end in ".efi", particularly if the kernels are stored on a
-# filesystem that the EFI can read. When uncommented, this option causes
-# all files in scanned directories with names that begin with "vmlinuz"
-# or "bzImage" to be included as loaders, even if they lack ".efi"
-# extensions. The drawback to this option is that it can pick up kernels
-# that lack EFI stub loader support and other files. Passing this option
-# a "0" value causes kernels without ".efi" extensions to NOT be scanned;
-# passing it alone or with any other value causes all kernels to be scanned.
-# Default is to NOT scan for kernels without ".efi" extensions.
+# filesystem that the EFI can read. When set to "1", "true", or "on", this
+# option causes all files in scanned directories with names that begin with
+# "vmlinuz" or "bzImage" to be included as loaders, even if they lack ".efi"
+# extensions. Passing this option a "0", "false", or "off" value causes
+# kernels without ".efi" extensions to NOT be scanned.
+# Default is "true" -- to scan for kernels without ".efi" extensions.
 #
-scan_all_linux_kernels
+#scan_all_linux_kernels false
 
 # Set the maximum number of tags that can be displayed on the screen at
 # any time. If more loaders are discovered than this value, rEFInd shows
@@ -246,10 +318,40 @@ scan_all_linux_kernels
 # default loader using:
 #  - A digit between 1 and 9, in which case the Nth loader in the menu
 #    will be the default. 
+#  - A "+" symbol at the start of the string, which refers to the most
+#    recently booted loader.
 #  - Any substring that corresponds to a portion of the loader's title
 #    (usually the OS's name or boot loader's path).
+# You may also specify multiple selectors by separating them with commas
+# and enclosing the list in quotes. (The "+" option is only meaningful in
+# this context.)
+# If you follow the selector(s) with two times, in 24-hour format, the
+# default will apply only between those times. The times are in the
+# motherboard's time standard, whether that's UTC or local time, so if
+# you use UTC, you'll need to adjust this from local time manually.
+# Times may span midnight as in "23:30 00:30", which applies to 11:30 PM
+# to 12:30 AM. You may specify multiple default_selection lines, in which
+# case the last one to match takes precedence. Thus, you can set a main
+# option without a time followed by one or more that include times to
+# set different defaults for different times of day.
+# The default behavior is to boot the previously-booted OS.
 #
 #default_selection 1
+#default_selection Microsoft
+#default_selection "+,bzImage,vmlinuz"
+#default_selection Maintenance 23:30 2:00
+#default_selection "Maintenance,OS X" 1:00 2:30
+
+# Enable VMX bit and lock the CPU MSR if unlocked.
+# On some Intel Apple computers, the firmware does not lock the MSR 0x3A.
+# The symptom on Windows is Hyper-V not working even if the CPU
+# meets the minimum requirements (HW assisted virtualization and SLAT)
+# DO NOT SET THIS EXCEPT ON INTEL CPUs THAT SUPPORT VMX! See
+# http://www.thomas-krenn.com/en/wiki/Activating_the_Intel_VT_Virtualization_Feature!
+# for more on this subject.
+# The default is false: Don't try to enable and lock the MSR.
+#
+#enable_and_lock_vmx false
 
 # Include a secondary configuration file within this one. This secondary
 # file is loaded as if its options appeared at the point of the "include"
@@ -307,7 +409,7 @@ scan_all_linux_kernels
 # specification. Also note that a leading slash is optional in file
 # specifications.
 menuentry Linux {
-       icon EFI/refind/icons/os_linux.icns
+       icon EFI/refind/icons/os_linux.png
        volume KERNELS
        loader bzImage-3.3.0-rc7
        initrd initrd-3.3.0.img
@@ -319,7 +421,7 @@ menuentry Linux {
 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
 menuentry Ubuntu {
        loader /EFI/ubuntu/grubx64.efi
-       icon /EFI/refined/icons/os_linux.icns
+       icon /EFI/refind/icons/os_linux.png
        disabled
 }
 
@@ -344,7 +446,7 @@ menuentry "Windows 7" {
 # could initialize hardware and then launch an OS, or it could
 # do something entirely different.
 menuentry "Windows via shell script" {
-       icon \EFI\refind\icons\os_win.icns
+       icon \EFI\refind\icons\os_win.png
        loader \EFI\tools\shell.efi
        options "fs0:\EFI\tools\launch_windows.nsh"
        disabled
@@ -357,7 +459,7 @@ menuentry "Windows via shell script" {
 # certainly need to change the "volume" line for this example
 # to work.
 menuentry "My Mac OS X" {
-       icon \EFI\refind\icons\os_mac.icns
+       icon \EFI\refind\icons\os_mac.png
        volume "OS X boot"
        loader \System\Library\CoreServices\boot.efi
        disabled