X-Git-Url: https://code.delx.au/refind/blobdiff_plain/118f257faaeeebd8c0b56821d70fcfe8f36289a6..cf8cab562126ea992bfca093829fd2832cf1414b:/refind.conf-sample diff --git a/refind.conf-sample b/refind.conf-sample index 7a5b9e7..15beb1f 100644 --- a/refind.conf-sample +++ b/refind.conf-sample @@ -8,15 +8,26 @@ # 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 -# label - text label in the menu +# 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 +# safemode - remove the submenu option to boot Mac OS X in "safe mode" # hwtest - the submenu option to run Apple's hardware test # arrows - scroll arrows on the OS selection tag line +# hints - brief command summary in the menu +# editor - the options editor (+, F2, or Insert on boot options menu) # all - all of the above +# Default is none of these (all elements active) # #hideui singleuser #hideui all @@ -35,9 +46,10 @@ timeout 20 # path is relative to the directory where refind.efi is located. The color # in the top left corner of the image is used as the background color # for the menu screens. Currently uncompressed BMP images with color -# depths of 24, 8, 4 or 1 bits are supported. +# depths of 24, 8, 4 or 1 bits are supported, as well as PNG images. # #banner hostname.bmp +#banner mybanner.png # 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 @@ -45,27 +57,60 @@ timeout 20 # the big icons by stretching it in the middle. If only a big one is given, # the built-in default will be used for the small icons. # -# Like the banner option above, these options take a filename of -# an uncompressed BMP image file. +# Like the banner option above, these options take a filename of an +# uncompressed BMP image file with a color depth of 24, 8, 4, or 1 bits, +# or a PNG image. The PNG format is required if you need transparency +# support (to let you "see through" to a full-screen banner). # #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. +# Default is to use graphics mode. # #textonly -# Set the screen's video resolution. Pass this option two values, -# corresponding to the X and Y resolutions. Note that not all resolutions -# are supported. On UEFI systems, passing an incorrect value results in a -# message being shown on the screen to that effect, along with a list of -# supported modes. On EFI 1.x systems (e.g., Macintoshes), setting an -# incorrect mode silently fails. On both types of systems, setting an -# incorrect resolution results in the default resolution being used. -# A resolution of 1024x768 usually works, but higher values often don't. +# Set the EFI text mode to be used for textual displays. This option +# takes a single digit that refers to a mode number. Mode 0 is normally +# 80x25, 1 is sometimes 80x50, and higher numbers are system-specific +# modes. Mode 1024 is a special code that tells rEFInd to not set the +# text mode; it uses whatever was in use when the program was launched. +# If you specify an invalid mode, rEFInd pauses during boot to inform +# you of valid modes. +# CAUTION: On VirtualBox, and perhaps on some real computers, specifying +# a text mode and uncommenting the "textonly" option while NOT specifying +# a resolution can result in an unusable display in the booted OS. +# Default is 1024 (no change) +# +#textmode 2 + +# Set the screen's video resolution. Pass this option either: +# * two values, corresponding to the X and Y resolutions +# * one value, corresponding to a GOP (UEFI) video mode +# Note that not all resolutions are supported. On UEFI systems, passing +# an incorrect value results in a message being shown on the screen to +# that effect, along with a list of supported modes. On EFI 1.x systems +# (e.g., Macintoshes), setting an incorrect mode silently fails. On both +# types of systems, setting an incorrect resolution results in the default +# resolution being used. A resolution of 1024x768 usually works, but higher +# values often don't. # Default is "0 0" (use the system default resolution, usually 800x600). # #resolution 1024 768 +#resolution 3 # Launch specified OSes in graphics mode. By default, rEFInd switches # to text mode and displays basic pre-launch information when launching @@ -87,26 +132,41 @@ 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) -# 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,about,shutdown,reboot +# 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) +# 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,apple_recovery,mok_tool,about,shutdown,reboot,firmware # -#showtools shell, about, reboot +#showtools shell, memtest, mok_tool, about, reboot, exit, firmware + +# Boot loaders that can launch a Windows restore or emergency system. +# These tend to be OEM-specific. +# +#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 # controllers, etc. In most cases none are needed, but if you add # EFI drivers and you want rEFInd to automatically load them, you # should specify one or more paths here. rEFInd always scans the -# "drivers" subdirectory of its own installation directory; this -# option specifies ADDITIONAL directories to scan. +# "drivers" and "drivers_{arch}" subdirectories of its own installation +# directory (where "{arch}" is your architecture code); this option +# specifies ADDITIONAL directories to scan. # Default is to scan no additional directories for EFI drivers # #scan_driver_dirs EFI/tools/drivers,drivers @@ -119,34 +179,77 @@ timeout 20 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.) # cd - BIOS optical-disc boot loaders # manual - use stanzas later in this configuration file -# Default is internal,external,optical,manual +# Note that the legacy BIOS options require firmware support, which is +# not present on all computers. +# On UEFI PCs, default is internal,external,optical,manual +# On Macs, default is internal,hdbios,external,biosexternal,optical,cd,manual # #scanfor internal,external,optical,manual +# 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, +# but are detected after pressing Esc. +# The default is 0. +# +#scan_delay 5 + # When scanning volumes for EFI boot loaders, rEFInd always looks for # Mac OS X's and Microsoft Windows' boot loaders in their normal locations, # and scans the root directory and every subdirectory of the /EFI directory # for additional boot loaders, but it doesn't recurse into these directories. # The also_scan_dirs token adds more directories to the scan list. # Directories are specified relative to the volume's root directory. This -# option applies to ALL the volumes that rEFInd scans. If a specified -# directory doesn't exist, it's ignored (no error condition results). -# The default is to scan no additional directories. +# option applies to ALL the volumes that rEFInd scans UNLESS you include +# a volume name and colon before the directory name, as in "myvol:/somedir" +# to scan the somedir directory only on the filesystem named myvol. If a +# specified directory doesn't exist, it's ignored (no error condition +# results). The default is to scan the "boot" directory in addition to +# various hard-coded directories. # -#also_scan_dirs boot,EFI/linux/kernels +#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 "Recovery HD,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 +# rEFInd doesn't scan its own directory, the EFI/tools directory, the +# EFI/memtest directory, or the EFI/memtest86 directory. Using the +# dont_scan_dirs option enables you to "blacklist" other directories; +# but note that using this option removes the EFI/memtest and +# EFI/memtest86 directories, so if you don't want them scanned, be +# sure to include them in your new list. 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. +# 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 EFI/boot,EFI/Dell +#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 +# relies on support programs or drivers that are installed alongside +# 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,PreLoader.efi,TextMode.efi,ebounce.efi, +# GraphicsConsole.efi,MokManager.efi,HashTool.efi,HashTool-signed.efi, +# bootmgr.efi +# +#dont_scan_files shim.efi,MokManager.efi # Scan for Linux kernels that lack a ".efi" filename extension. This is # useful for better integration with Linux distributions that provide @@ -156,13 +259,12 @@ timeout 20 # 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. Most notably, if you -# want to give a kernel a custom icon by placing an icon with the kernel's -# filename but a ".icns" extension in the same directory as the kernel, this -# option will cause the icon file to show up as a non-functional loader tag. +# 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. # -#scan_all_linux_kernels +scan_all_linux_kernels # 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 @@ -180,8 +282,31 @@ timeout 20 # will be the default. # - 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. +# 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. # #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 + +# Include a secondary configuration file within this one. This secondary +# file is loaded as if its options appeared at the point of the "include" +# token itself, so if you want to override a setting in the main file, +# the secondary file must be referenced AFTER the setting you want to +# override. Note that the secondary file may NOT load a tertiary file. +# +#include manual.conf # Sample manual configuration stanzas. Each begins with the "menuentry" # keyword followed by a name that's to appear in the menu (use quotes @@ -273,3 +398,16 @@ menuentry "Windows via shell script" { options "fs0:\EFI\tools\launch_windows.nsh" disabled } + +# Mac OS is normally detected and run automatically; however, +# if you want to do something unusual, a manual boot stanza may +# be the way to do it. This one does nothing very unusual, but +# it may serve as a starting point. Note that you'll almost +# certainly need to change the "volume" line for this example +# to work. +menuentry "My Mac OS X" { + icon \EFI\refind\icons\os_mac.icns + volume "OS X boot" + loader \System\Library\CoreServices\boot.efi + disabled +}