X-Git-Url: https://code.delx.au/refind/blobdiff_plain/293749865fc028016e6896402afd37d7021a5e48..2f941c1b8c2d841cc62de2ef00108278cee7f280:/refind.conf-sample

diff --git a/refind.conf-sample b/refind.conf-sample
index 42c73fc..424b8c4 100644
--- a/refind.conf-sample
+++ b/refind.conf-sample
@@ -11,12 +11,15 @@ timeout 20
 # Hide user interface elements for personal preference or to increase
 # security:
 #  banner      - the rEFInd title banner
-#  label       - text label in the menu
+#  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
 #  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
@@ -52,20 +55,40 @@ timeout 20
 #selection_small selection-small.bmp
 
 # 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
@@ -144,11 +167,22 @@ timeout 20
 # 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,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).
 #
-#also_scan_dirs boot,EFI/linux/kernels
+#dont_scan_volumes
 
 # Directories that should NOT be scanned for boot loaders. By default,
 # rEFInd doesn't scan its own directory or the EFI/tools directory.
@@ -159,9 +193,12 @@ timeout 20
 # 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
 
 # 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
@@ -188,6 +225,9 @@ timeout 20
 # 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.
+# 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
@@ -211,6 +251,14 @@ scan_all_linux_kernels
 #
 #default_selection 1
 
+# 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
 # if you want the name to contain a space) and an open curly brace