]> code.delx.au - refind/blob - refind.conf-sample
TianoCore build support; new use_graphics_for refind.conf token
[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).
8 #
9 timeout 20
10
11 # Hide user interface elements for personal preference or to increase
12 # security:
13 # banner - the rEFInd title banner
14 # label - text label in the menu
15 # singleuser - remove the submenu options to boot Mac OS X in single-user
16 # or verbose modes; affects ONLY MacOS X
17 # hwtest - the submenu option to run Apple's hardware test
18 # arrows - scroll arrows on the OS selection tag line
19 # all - all of the above
20 #
21 #hideui singleuser
22 #hideui all
23
24 # Set the name of a subdirectory in which icons are stored. Icons must
25 # have the same names they have in the standard directory. The directory
26 # name is specified relative to the main rEFInd binary's directory. If
27 # an icon can't be found in the specified directory, an attempt is made
28 # to load it from the default directory; thus, you can replace just some
29 # icons in your own directory and rely on the default for others.
30 # Default is "icons".
31 #
32 #icons_dir myicons
33
34 # Use a custom title banner instead of the rEFInd icon and name. The file
35 # path is relative to the directory where refind.efi is located. The color
36 # in the top left corner of the image is used as the background color
37 # for the menu screens. Currently uncompressed BMP images with color
38 # depths of 24, 8, 4 or 1 bits are supported.
39 #
40 #banner hostname.bmp
41
42 # Custom images for the selection background. There is a big one (144 x 144)
43 # for the OS icons, and a small one (64 x 64) for the function icons in the
44 # second row. If only a small image is given, that one is also used for
45 # the big icons by stretching it in the middle. If only a big one is given,
46 # the built-in default will be used for the small icons.
47 #
48 # Like the banner option above, these options take a filename of
49 # an uncompressed BMP image file.
50 #
51 #selection_big selection-big.bmp
52 #selection_small selection-small.bmp
53
54 # Use text mode only. When enabled, this option forces rEFInd into text mode.
55 #
56 #textonly
57
58 # Set the screen's video resolution. Pass this option two values,
59 # corresponding to the X and Y resolutions. Note that not all resolutions
60 # are supported. On UEFI systems, passing an incorrect value results in a
61 # message being shown on the screen to that effect, along with a list of
62 # supported modes. On EFI 1.x systems (e.g., Macintoshes), setting an
63 # incorrect mode silently fails. On both types of systems, setting an
64 # incorrect resolution results in the default resolution being used.
65 # A resolution of 1024x768 usually works, but higher values often don't.
66 # Default is "0 0" (use the system default resolution, usually 800x600).
67 #
68 #resolution 1024 768
69
70 # Launch specified OSes in graphics mode. By default, rEFInd switches
71 # to text mode and displays basic pre-launch information when launching
72 # all OSes except OS X. Using graphics mode can produce a more seamless
73 # transition, but displays no information, which can make matters
74 # difficult if you must debug a problem. Also, on at least one known
75 # computer, using graphics mode prevents a crash when using the Linux
76 # kernel's EFI stub loader. You can specify an empty list to boot all
77 # OSes in text mode.
78 # Valid options:
79 # osx - Mac OS X
80 # linux - A Linux kernel with EFI stub loader
81 # elilo - The ELILO boot loader
82 # grub - The GRUB (Legacy or 2) boot loader
83 # windows - Microsoft Windows
84 # Default value: osx
85 #
86 #use_graphics_for osx,linux
87
88 # Which non-bootloader tools to show on the tools line, and in what
89 # order to display them:
90 # shell - the EFI shell
91 # gptsync - the (dangerous) gptsync.efi utility
92 # about - an "about this program" option
93 # exit - a tag to exit from rEFInd
94 # shutdown - shuts down the computer (a bug causes this to reboot EFI
95 # systems)
96 # reboot - a tag to reboot the computer
97 # Default is shell,about,shutdown,reboot
98 #
99 #showtools shell, about, reboot
100
101 # Directories in which to search for EFI drivers. These drivers can
102 # provide filesystem support, give access to hard disks on plug-in
103 # controllers, etc. In most cases none are needed, but if you add
104 # EFI drivers and you want rEFInd to automatically load them, you
105 # should specify one or more paths here. rEFInd always scans the
106 # "drivers" subdirectory of its own installation directory; this
107 # option specifies ADDITIONAL directories to scan.
108 # Default is to scan no additional directories for EFI drivers
109 #
110 #scan_driver_dirs EFI/tools/drivers,drivers
111
112 # Which types of boot loaders to search, and in what order to display them:
113 # internal - internal EFI disk-based boot loaders
114 # external - external EFI disk-based boot loaders
115 # optical - EFI optical discs (CD, DVD, etc.)
116 # hdbios - BIOS disk-based boot loaders
117 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.)
118 # cd - BIOS optical-disc boot loaders
119 # manual - use stanzas later in this configuration file
120 # Default is internal,external,optical
121 #
122 #scanfor internal,external,optical
123
124 # When scanning volumes for EFI boot loaders, rEFInd always looks for
125 # Mac OS X's and Microsoft Windows' boot loaders in their normal locations,
126 # and scans the root directory and every subdirectory of the /EFI directory
127 # for additional boot loaders, but it doesn't recurse into these directories.
128 # The also_scan_dirs token adds more directories to the scan list.
129 # Directories are specified relative to the volume's root directory. This
130 # option applies to ALL the volumes that rEFInd scans. If a specified
131 # directory doesn't exist, it's ignored (no error condition results).
132 # The default is to scan no additional directories.
133 #
134 #also_scan_dirs boot,EFI/linux/kernels
135
136 # Directories that should NOT be scanned for boot loaders. By default,
137 # rEFInd doesn't scan its own directory or the EFI/tools directory.
138 # You can "blacklist" additional directories with this option, which
139 # takes a list of directory names as options. You might do this to
140 # keep EFI/boot/bootx64.efi out of the menu if that's a duplicate of
141 # another boot loader or to exclude a directory that holds drivers
142 # or non-bootloader utilities provided by a hardware manufacturer. If
143 # a directory is listed both here and in also_scan_dirs, dont_scan_dirs
144 # takes precedence.
145 #
146 #dont_scan_dirs EFI/boot,EFI/Dell
147
148 # Scan for Linux kernels that lack a ".efi" filename extension. This is
149 # useful for better integration with Linux distributions that provide
150 # kernels with EFI stub loaders but that don't give those kernels filenames
151 # that end in ".efi", particularly if the kernels are stored on a
152 # filesystem that the EFI can read. When uncommented, this option causes
153 # all files in scanned directories with names that begin with "vmlinuz"
154 # or "bzImage" to be included as loaders, even if they lack ".efi"
155 # extensions. The drawback to this option is that it can pick up kernels
156 # that lack EFI stub loader support and other files. Most notably, if you
157 # want to give a kernel a custom icon by placing an icon with the kernel's
158 # filename but a ".icns" extension in the same directory as the kernel, this
159 # option will cause the icon file to show up as a non-functional loader tag.
160 # Default is to NOT scan for kernels without ".efi" extensions.
161 #
162 #scan_all_linux_kernels
163
164 # Set the maximum number of tags that can be displayed on the screen at
165 # any time. If more loaders are discovered than this value, rEFInd shows
166 # a subset in a scrolling list. If this value is set too high for the
167 # screen to handle, it's reduced to the value that the screen can manage.
168 # If this value is set to 0 (the default), it's adjusted to the number
169 # that the screen can handle.
170 #
171 #max_tags 0
172
173 # Set the default menu selection. The available arguments match the
174 # keyboard accelerators available within rEFInd. You may select the
175 # default loader using:
176 # - A digit between 1 and 9, in which case the Nth loader in the menu
177 # will be the default.
178 # - Any substring that corresponds to a portion of the loader's title
179 # (usually the OS's name or boot loader's path).
180 #
181 #default_selection 1
182
183 # Sample manual configuration stanzas. Each begins with the "menuentry"
184 # keyword followed by a name that's to appear in the menu (use quotes
185 # if you want the name to contain a space) and an open curly brace
186 # ("{"). Each entry ends with a close curly brace ("}"). Common
187 # keywords within each stanza include:
188 #
189 # volume - identifies the filesystem from which subsequent files
190 # are loaded. You can specify the volume by label or by
191 # a number followed by a colon (as in "0:" for the first
192 # filesystem or "1:" for the second).
193 # loader - identifies the boot loader file
194 # initrd - Specifies an initial RAM disk file
195 # icon - specifies a custom boot loader icon
196 # ostype - OS type code to determine boot options available by
197 # pressing Insert. Valid values are "MacOS", "Linux",
198 # "Windows", and "XOM". Case-sensitive.
199 # graphics - set to "on" to enable graphics-mode boot (useful
200 # mainly for MacOS) or "off" for text-mode boot.
201 # Default is auto-detected from loader filename.
202 # options - sets options to be passed to the boot loader; use
203 # quotes if more than one option should be passed or
204 # if any options use characters that might be changed
205 # by rEFInd parsing procedures (=, /, #, or tab).
206 # disabled - use alone or set to "yes" to disable this entry.
207 #
208 # Note that you can use either DOS/Windows/EFI-style backslashes (\)
209 # or Unix-style forward slashes (/) as directory separators. Either
210 # way, all file references are on the ESP from which rEFInd was
211 # launched.
212 # Use of quotes around parameters causes them to be interpreted as
213 # one keyword, and for parsing of special characters (spaces, =, /,
214 # and #) to be disabled. This is useful mainly with the "options"
215 # keyword. Use of quotes around parameters that specify filenames is
216 # permissible, but you must then use backslashes instead of slashes,
217 # except when you must pass a forward slash to the loader, as when
218 # passing a root= option to a Linux kernel.
219
220 # Below are several sample boot stanzas. All are disabled by default.
221 # Find one similar to what you need, copy it, remove the "disabled" line,
222 # and adjust the entries to suit your needs.
223
224 # A sample entry for a Linux 3.3 kernel with its new EFI boot stub
225 # support on a filesystem called "KERNELS". This entry includes
226 # Linux-specific boot options and specification of an initial RAM disk.
227 # Note uses of Linux-style forward slashes, even in the initrd
228 # specification. Also note that a leading slash is optional in file
229 # specifications.
230 menuentry Linux {
231 icon EFI/refind/icons/os_linux.icns
232 volume KERNELS
233 loader bzImage-3.3.0-rc7
234 initrd initrd-3.3.0.img
235 options "ro root=UUID=5f96cafa-e0a7-4057-b18f-fa709db5b837"
236 disabled
237 }
238
239 # A sample entry for loading Ubuntu using its standard name for
240 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
241 menuentry Ubuntu {
242 loader /EFI/ubuntu/grubx64.efi
243 icon /EFI/refined/icons/os_linux.icns
244 disabled
245 }
246
247 # A minimal ELILO entry, which probably offers nothing that
248 # auto-detection can't accomplish.
249 menuentry "ELILO" {
250 loader \EFI\elilo\elilo.efi
251 disabled
252 }
253
254 # Like the ELILO entry, this one offers nothing that auto-detection
255 # can't do; but you might use it if you want to disable auto-detection
256 # but still boot Windows....
257 menuentry "Windows 7" {
258 loader \EFI\Microsoft\Boot\bootmgfw.efi
259 disabled
260 }
261
262 # EFI shells are programs just like boot loaders, and can be
263 # launched in the same way. You can pass a shell the name of a
264 # script that it's to run on the "options" line. The script
265 # could initialize hardware and then launch an OS, or it could
266 # do something entirely different.
267 menuentry "Windows via shell script" {
268 icon \EFI\refind\icons\os_win.icns
269 loader \EFI\tools\shell.efi
270 options "fs0:\EFI\tools\launch_windows.nsh"
271 disabled
272 }