]> code.delx.au - refind/blobdiff - refind.conf-sample
Documentation changes; minor code cleanups.
[refind] / refind.conf-sample
index 1dc58a93e3f57b4e5d3ce100574106583407818d..736afa08ab0e20f54a7b100e3ea27065d1a27e9a 100644 (file)
@@ -21,6 +21,16 @@ timeout 20
 #hideui singleuser
 #hideui all
 
+# Set the name of a subdirectory in which icons are stored. Icons must
+# have the same names they have in the standard directory. The directory
+# name is specified relative to the main rEFInd binary's directory. If
+# an icon can't be found in the specified directory, an attempt is made
+# to load it from the default directory; thus, you can replace just some
+# icons in your own directory and rely on the default for others.
+# Default is "icons".
+#
+#icons_dir myicons
+
 # Use a custom title banner instead of the rEFInd icon and name. The file
 # 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
@@ -35,8 +45,8 @@ 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.
 #
 #selection_big   selection-big.bmp
 #selection_small selection-small.bmp
@@ -45,16 +55,51 @@ timeout 20
 #
 #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.
+# Default is "0 0" (use the system default resolution, usually 800x600).
+#
+#resolution 1024 768
+
+# Launch specified OSes in graphics mode. By default, rEFInd switches
+# to text mode and displays basic pre-launch information when launching
+# all OSes except OS X. Using graphics mode can produce a more seamless
+# transition, but displays no information, which can make matters
+# difficult if you must debug a problem. Also, on at least one known
+# computer, using graphics mode prevents a crash when using the Linux
+# kernel's EFI stub loader. You can specify an empty list to boot all
+# OSes in text mode.
+# Valid options:
+#   osx     - Mac OS X
+#   linux   - A Linux kernel with EFI stub loader
+#   elilo   - The ELILO boot loader
+#   grub    - The GRUB (Legacy or 2) boot loader
+#   windows - Microsoft Windows
+# Default value: osx
+#
+#use_graphics_for osx,linux
+
 # Which non-bootloader tools to show on the tools line, and in what
 # order to display them:
-#  shell     - the EFI shell
-#  gptsync   - the (dangerous) gptsync.efi utility
-#  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)
+#  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, about, reboot
 
@@ -63,8 +108,9 @@ timeout 20
 # 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
@@ -77,9 +123,20 @@ 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
+# 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.
 #
-#scanfor internal,external,optical
+#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,
@@ -93,6 +150,48 @@ timeout 20
 #
 #also_scan_dirs boot,EFI/linux/kernels
 
+# 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.
+#
+#dont_scan_dirs EFI/boot,EFI/Dell
+
+# 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,MokManager.efi,TextMode.efi,ebounce.efi,GraphicsConsole.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
+# 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. 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.
+# Default is to NOT scan for kernels without ".efi" extensions.
+#
+#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
 # a subset in a scrolling list. If this value is set too high for the
@@ -191,3 +290,27 @@ menuentry "Windows 7" {
        disabled
 }
 
+# EFI shells are programs just like boot loaders, and can be
+# launched in the same way. You can pass a shell the name of a
+# script that it's to run on the "options" line. The script
+# 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
+       loader \EFI\tools\shell.efi
+       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
+}