]> code.delx.au - refind/blob - refind.conf-sample
Significant improvements to legacy-mode boot support, particularly on
[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 # Screen saver timeout; the screen blanks after the specified number of
12 # seconds with no keyboard input. The screen returns after most keypresses
13 # (unfortunately, not including modifier keys such as Shift, Control, Alt,
14 # or Option). Setting a value of "-1" causes rEFInd to start up with its
15 # screen saver active. The default is 0, which disables the screen saver.
16 #screensaver 300
17
18 # Hide user interface elements for personal preference or to increase
19 # security:
20 # banner - the rEFInd title banner (built-in or loaded via "banner")
21 # label - boot option text label in the menu
22 # singleuser - remove the submenu options to boot Mac OS X in single-user
23 # or verbose modes; affects ONLY MacOS X
24 # safemode - remove the submenu option to boot Mac OS X in "safe mode"
25 # hwtest - the submenu option to run Apple's hardware test
26 # arrows - scroll arrows on the OS selection tag line
27 # hints - brief command summary in the menu
28 # editor - the options editor (+, F2, or Insert on boot options menu)
29 # all - all of the above
30 # Default is none of these (all elements active)
31 #
32 #hideui singleuser
33 #hideui all
34
35 # Set the name of a subdirectory in which icons are stored. Icons must
36 # have the same names they have in the standard directory. The directory
37 # name is specified relative to the main rEFInd binary's directory. If
38 # an icon can't be found in the specified directory, an attempt is made
39 # to load it from the default directory; thus, you can replace just some
40 # icons in your own directory and rely on the default for others.
41 # Default is "icons".
42 #
43 #icons_dir myicons
44
45 # Use a custom title banner instead of the rEFInd icon and name. The file
46 # path is relative to the directory where refind.efi is located. The color
47 # in the top left corner of the image is used as the background color
48 # for the menu screens. Currently uncompressed BMP images with color
49 # depths of 24, 8, 4 or 1 bits are supported, as well as PNG images.
50 #
51 #banner hostname.bmp
52 #banner mybanner.png
53
54 # Specify how to handle banners that aren't exactly the same as the screen
55 # size:
56 # noscale - Crop if too big, show with border if too small
57 # fillscreen - Fill the screen
58 # Default is noscale
59 #
60 #banner_scale fillscreen
61
62 # Icon sizes. All icons are square, so just one value is specified. The
63 # big icons are used for OS selectors in the first row and the small
64 # icons are used for tools on the second row. Drive-type badges are 1/4
65 # the size of the big icons. Legal values are 32 and above. If the icon
66 # files do not hold icons of the proper size, the icons are scaled to
67 # the specified size. The default values are 48 and 128 for small and
68 # big icons, respectively.
69 #
70 #small_icon_size 96
71 #big_icon_size 256
72
73 # Custom images for the selection background. There is a big one (144 x 144)
74 # for the OS icons, and a small one (64 x 64) for the function icons in the
75 # second row. If only a small image is given, that one is also used for
76 # the big icons by stretching it in the middle. If only a big one is given,
77 # the built-in default will be used for the small icons.
78 #
79 # Like the banner option above, these options take a filename of an
80 # uncompressed BMP image file with a color depth of 24, 8, 4, or 1 bits,
81 # or a PNG image. The PNG format is required if you need transparency
82 # support (to let you "see through" to a full-screen banner).
83 #
84 #selection_big selection-big.bmp
85 #selection_small selection-small.bmp
86
87 # Set the font to be used for all textual displays in graphics mode.
88 # The font must be a PNG file with alpha channel transparency. It must
89 # contain ASCII characters 32-126 (space through tilde), inclusive, plus
90 # a glyph to be displayed in place of characters outside of this range,
91 # for a total of 96 glyphs. Only monospaced fonts are supported. Fonts
92 # may be of any size, although large fonts can produce display
93 # irregularities.
94 # The default is rEFInd's built-in font, Luxi Mono Regular 12 point.
95 #
96 #font myfont.png
97
98 # Use text mode only. When enabled, this option forces rEFInd into text mode.
99 # Passing this option a "0" value causes graphics mode to be used. Pasing
100 # it no value or any non-0 value causes text mode to be used.
101 # Default is to use graphics mode.
102 #
103 #textonly
104
105 # Set the EFI text mode to be used for textual displays. This option
106 # takes a single digit that refers to a mode number. Mode 0 is normally
107 # 80x25, 1 is sometimes 80x50, and higher numbers are system-specific
108 # modes. Mode 1024 is a special code that tells rEFInd to not set the
109 # text mode; it uses whatever was in use when the program was launched.
110 # If you specify an invalid mode, rEFInd pauses during boot to inform
111 # you of valid modes.
112 # CAUTION: On VirtualBox, and perhaps on some real computers, specifying
113 # a text mode and uncommenting the "textonly" option while NOT specifying
114 # a resolution can result in an unusable display in the booted OS.
115 # Default is 1024 (no change)
116 #
117 #textmode 2
118
119 # Set the screen's video resolution. Pass this option either:
120 # * two values, corresponding to the X and Y resolutions
121 # * one value, corresponding to a GOP (UEFI) video mode
122 # Note that not all resolutions are supported. On UEFI systems, passing
123 # an incorrect value results in a message being shown on the screen to
124 # that effect, along with a list of supported modes. On EFI 1.x systems
125 # (e.g., Macintoshes), setting an incorrect mode silently fails. On both
126 # types of systems, setting an incorrect resolution results in the default
127 # resolution being used. A resolution of 1024x768 usually works, but higher
128 # values often don't.
129 # Default is "0 0" (use the system default resolution, usually 800x600).
130 #
131 #resolution 1024 768
132 #resolution 3
133
134 # Launch specified OSes in graphics mode. By default, rEFInd switches
135 # to text mode and displays basic pre-launch information when launching
136 # all OSes except OS X. Using graphics mode can produce a more seamless
137 # transition, but displays no information, which can make matters
138 # difficult if you must debug a problem. Also, on at least one known
139 # computer, using graphics mode prevents a crash when using the Linux
140 # kernel's EFI stub loader. You can specify an empty list to boot all
141 # OSes in text mode.
142 # Valid options:
143 # osx - Mac OS X
144 # linux - A Linux kernel with EFI stub loader
145 # elilo - The ELILO boot loader
146 # grub - The GRUB (Legacy or 2) boot loader
147 # windows - Microsoft Windows
148 # Default value: osx
149 #
150 #use_graphics_for osx,linux
151
152 # Which non-bootloader tools to show on the tools line, and in what
153 # order to display them:
154 # shell - the EFI shell (requires external program; see rEFInd
155 # documentation for details)
156 # memtest - the memtest86 program, in EFI/tools, EFI/memtest86,
157 # EFI/memtest, EFI/tools/memtest86, or EFI/tools/memtest
158 # gptsync - the (dangerous) gptsync.efi utility (requires external
159 # program; see rEFInd documentation for details)
160 # gdisk - the gdisk partitioning program
161 # apple_recovery - boots the Apple Recovery HD partition, if present
162 # windows_recovery - boots an OEM Windows recovery tool, if present
163 # (see also the windows_recovery_files option)
164 # mok_tool - makes available the Machine Owner Key (MOK) maintenance
165 # tool, MokManager.efi, used on Secure Boot systems
166 # about - an "about this program" option
167 # exit - a tag to exit from rEFInd
168 # shutdown - shuts down the computer (a bug causes this to reboot
169 # many UEFI systems)
170 # reboot - a tag to reboot the computer
171 # firmware - a tag to reboot the computer into the firmware's
172 # user interface (ignored on older computers)
173 # Default is shell,memtest,gdisk,apple_recovery,windows_recovery,mok_tool,about,shutdown,reboot,firmware
174 #
175 #showtools shell, gdisk, memtest, mok_tool, about, reboot, exit, firmware
176
177 # Boot loaders that can launch a Windows restore or emergency system.
178 # These tend to be OEM-specific.
179 # Default is LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
180 #
181 #windows_recovery_files LRS_ESP:/EFI/Microsoft/Boot/LrsBootmgr.efi
182
183 # Directories in which to search for EFI drivers. These drivers can
184 # provide filesystem support, give access to hard disks on plug-in
185 # controllers, etc. In most cases none are needed, but if you add
186 # EFI drivers and you want rEFInd to automatically load them, you
187 # should specify one or more paths here. rEFInd always scans the
188 # "drivers" and "drivers_{arch}" subdirectories of its own installation
189 # directory (where "{arch}" is your architecture code); this option
190 # specifies ADDITIONAL directories to scan.
191 # Default is to scan no additional directories for EFI drivers
192 #
193 #scan_driver_dirs EFI/tools/drivers,drivers
194
195 # Which types of boot loaders to search, and in what order to display them:
196 # internal - internal EFI disk-based boot loaders
197 # external - external EFI disk-based boot loaders
198 # optical - EFI optical discs (CD, DVD, etc.)
199 # hdbios - BIOS disk-based boot loaders
200 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.)
201 # cd - BIOS optical-disc boot loaders
202 # manual - use stanzas later in this configuration file
203 # Note that the legacy BIOS options require firmware support, which is
204 # not present on all computers.
205 # On UEFI PCs, default is internal,external,optical,manual
206 # On Macs, default is internal,hdbios,external,biosexternal,optical,cd,manual
207 #
208 #scanfor internal,external,optical,manual
209
210 # Delay for the specified number of seconds before scanning disks.
211 # This can help some users who find that some of their disks
212 # (usually external or optical discs) aren't detected initially,
213 # but are detected after pressing Esc.
214 # The default is 0.
215 #
216 #scan_delay 5
217
218 # When scanning volumes for EFI boot loaders, rEFInd always looks for
219 # Mac OS X's and Microsoft Windows' boot loaders in their normal locations,
220 # and scans the root directory and every subdirectory of the /EFI directory
221 # for additional boot loaders, but it doesn't recurse into these directories.
222 # The also_scan_dirs token adds more directories to the scan list.
223 # Directories are specified relative to the volume's root directory. This
224 # option applies to ALL the volumes that rEFInd scans UNLESS you include
225 # a volume name and colon before the directory name, as in "myvol:/somedir"
226 # to scan the somedir directory only on the filesystem named myvol. If a
227 # specified directory doesn't exist, it's ignored (no error condition
228 # results). The default is to scan the "boot" directory in addition to
229 # various hard-coded directories.
230 #
231 #also_scan_dirs boot,ESP2:EFI/linux/kernels
232
233 # Partitions (or whole disks, for legacy-mode boots) to omit from scans.
234 # For EFI-mode scans, you must specify a volume by its label, which you
235 # can obtain in an EFI shell by typing "vol", from Linux by typing
236 # "blkid /dev/{devicename}", or by examining the disk's label in various
237 # OSes' file browsers.
238 # For legacy-mode scans, you can specify any subset of the boot loader
239 # description shown when you highlight the option in rEFInd.
240 # The default is "Recovery HD,LRS_ESP".
241 #
242 #dont_scan_volumes "Recovery HD"
243
244 # Directories that should NOT be scanned for boot loaders. By default,
245 # rEFInd doesn't scan its own directory, the EFI/tools directory, the
246 # EFI/memtest directory, or the EFI/memtest86 directory. Using the
247 # dont_scan_dirs option enables you to "blacklist" other directories;
248 # but note that using this option removes the EFI/memtest and
249 # EFI/memtest86 directories, so if you don't want them scanned, be
250 # sure to include them in your new list. You might use this token to
251 # keep EFI/boot/bootx64.efi out of the menu if that's a duplicate of
252 # another boot loader or to exclude a directory that holds drivers
253 # or non-bootloader utilities provided by a hardware manufacturer. If
254 # a directory is listed both here and in also_scan_dirs, dont_scan_dirs
255 # takes precedence. Note that this blacklist applies to ALL the
256 # filesystems that rEFInd scans, not just the ESP, unless you precede
257 # the directory name by a filesystem name, as in "myvol:EFI/somedir"
258 # to exclude EFI/somedir from the scan on the myvol volume but not on
259 # other volumes.
260 #
261 #dont_scan_dirs ESP:/EFI/boot,EFI/Dell,EFI/memtest86
262
263 # Files that should NOT be included as EFI boot loaders (on the
264 # first line of the display). If you're using a boot loader that
265 # relies on support programs or drivers that are installed alongside
266 # the main binary or if you want to "blacklist" certain loaders by
267 # name rather than location, use this option. Note that this will
268 # NOT prevent certain binaries from showing up in the second-row
269 # set of tools. Most notably, various Secure Boot and recovery
270 # tools are present in this list, but may appear as second-row
271 # items.
272 # The file may be specified as a bare name (e.g., "notme.efi"), as
273 # a complete filename (e.g., "/EFI/somedir/notme.efi"), or as a
274 # complete filename with volume (e.g., "SOMEDISK:/EFI/somedir/notme.efi").
275 # The default is shim.efi,shim-fedora.efi,shimx64.efi,PreLoader.efi,
276 # TextMode.efi,ebounce.efi,GraphicsConsole.efi,MokManager.efi,HashTool.efi,
277 # HashTool-signed.efi,bootmgr.efi
278 #
279 #dont_scan_files shim.efi,MokManager.efi
280
281 # Scan for Linux kernels that lack a ".efi" filename extension. This is
282 # useful for better integration with Linux distributions that provide
283 # kernels with EFI stub loaders but that don't give those kernels filenames
284 # that end in ".efi", particularly if the kernels are stored on a
285 # filesystem that the EFI can read. When uncommented, this option causes
286 # all files in scanned directories with names that begin with "vmlinuz"
287 # or "bzImage" to be included as loaders, even if they lack ".efi"
288 # extensions. The drawback to this option is that it can pick up kernels
289 # that lack EFI stub loader support and other files. Passing this option
290 # a "0" value causes kernels without ".efi" extensions to NOT be scanned;
291 # passing it alone or with any other value causes all kernels to be scanned.
292 # Default is to NOT scan for kernels without ".efi" extensions.
293 #
294 scan_all_linux_kernels
295
296 # Set the maximum number of tags that can be displayed on the screen at
297 # any time. If more loaders are discovered than this value, rEFInd shows
298 # a subset in a scrolling list. If this value is set too high for the
299 # screen to handle, it's reduced to the value that the screen can manage.
300 # If this value is set to 0 (the default), it's adjusted to the number
301 # that the screen can handle.
302 #
303 #max_tags 0
304
305 # Set the default menu selection. The available arguments match the
306 # keyboard accelerators available within rEFInd. You may select the
307 # default loader using:
308 # - A digit between 1 and 9, in which case the Nth loader in the menu
309 # will be the default.
310 # - Any substring that corresponds to a portion of the loader's title
311 # (usually the OS's name or boot loader's path).
312 # You may also specify multiple selectors by separating them with commas
313 # and enclosing the list in quotes.
314 # If you follow the selector(s) with two times, in 24-hour format, the
315 # default will apply only between those times. The times are in the
316 # motherboard's time standard, whether that's UTC or local time, so if
317 # you use UTC, you'll need to adjust this from local time manually.
318 # Times may span midnight as in "23:30 00:30", which applies to 11:30 PM
319 # to 12:30 AM. You may specify multiple default_selection lines, in which
320 # case the last one to match takes precedence. Thus, you can set a main
321 # option without a time followed by one or more that include times to
322 # set different defaults for different times of day.
323 #
324 #default_selection 1
325 #default_selection Microsoft
326 #default_selection "bzImage,vmlinuz"
327 #default_selection Maintenance 23:30 2:00
328 #default_selection "Maintenance,OS X" 1:00 2:30
329
330 # Include a secondary configuration file within this one. This secondary
331 # file is loaded as if its options appeared at the point of the "include"
332 # token itself, so if you want to override a setting in the main file,
333 # the secondary file must be referenced AFTER the setting you want to
334 # override. Note that the secondary file may NOT load a tertiary file.
335 #
336 #include manual.conf
337
338 # Sample manual configuration stanzas. Each begins with the "menuentry"
339 # keyword followed by a name that's to appear in the menu (use quotes
340 # if you want the name to contain a space) and an open curly brace
341 # ("{"). Each entry ends with a close curly brace ("}"). Common
342 # keywords within each stanza include:
343 #
344 # volume - identifies the filesystem from which subsequent files
345 # are loaded. You can specify the volume by label or by
346 # a number followed by a colon (as in "0:" for the first
347 # filesystem or "1:" for the second).
348 # loader - identifies the boot loader file
349 # initrd - Specifies an initial RAM disk file
350 # icon - specifies a custom boot loader icon
351 # ostype - OS type code to determine boot options available by
352 # pressing Insert. Valid values are "MacOS", "Linux",
353 # "Windows", and "XOM". Case-sensitive.
354 # graphics - set to "on" to enable graphics-mode boot (useful
355 # mainly for MacOS) or "off" for text-mode boot.
356 # Default is auto-detected from loader filename.
357 # options - sets options to be passed to the boot loader; use
358 # quotes if more than one option should be passed or
359 # if any options use characters that might be changed
360 # by rEFInd parsing procedures (=, /, #, or tab).
361 # disabled - use alone or set to "yes" to disable this entry.
362 #
363 # Note that you can use either DOS/Windows/EFI-style backslashes (\)
364 # or Unix-style forward slashes (/) as directory separators. Either
365 # way, all file references are on the ESP from which rEFInd was
366 # launched.
367 # Use of quotes around parameters causes them to be interpreted as
368 # one keyword, and for parsing of special characters (spaces, =, /,
369 # and #) to be disabled. This is useful mainly with the "options"
370 # keyword. Use of quotes around parameters that specify filenames is
371 # permissible, but you must then use backslashes instead of slashes,
372 # except when you must pass a forward slash to the loader, as when
373 # passing a root= option to a Linux kernel.
374
375 # Below are several sample boot stanzas. All are disabled by default.
376 # Find one similar to what you need, copy it, remove the "disabled" line,
377 # and adjust the entries to suit your needs.
378
379 # A sample entry for a Linux 3.3 kernel with its new EFI boot stub
380 # support on a filesystem called "KERNELS". This entry includes
381 # Linux-specific boot options and specification of an initial RAM disk.
382 # Note uses of Linux-style forward slashes, even in the initrd
383 # specification. Also note that a leading slash is optional in file
384 # specifications.
385 menuentry Linux {
386 icon EFI/refind/icons/os_linux.icns
387 volume KERNELS
388 loader bzImage-3.3.0-rc7
389 initrd initrd-3.3.0.img
390 options "ro root=UUID=5f96cafa-e0a7-4057-b18f-fa709db5b837"
391 disabled
392 }
393
394 # A sample entry for loading Ubuntu using its standard name for
395 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
396 menuentry Ubuntu {
397 loader /EFI/ubuntu/grubx64.efi
398 icon /EFI/refined/icons/os_linux.icns
399 disabled
400 }
401
402 # A minimal ELILO entry, which probably offers nothing that
403 # auto-detection can't accomplish.
404 menuentry "ELILO" {
405 loader \EFI\elilo\elilo.efi
406 disabled
407 }
408
409 # Like the ELILO entry, this one offers nothing that auto-detection
410 # can't do; but you might use it if you want to disable auto-detection
411 # but still boot Windows....
412 menuentry "Windows 7" {
413 loader \EFI\Microsoft\Boot\bootmgfw.efi
414 disabled
415 }
416
417 # EFI shells are programs just like boot loaders, and can be
418 # launched in the same way. You can pass a shell the name of a
419 # script that it's to run on the "options" line. The script
420 # could initialize hardware and then launch an OS, or it could
421 # do something entirely different.
422 menuentry "Windows via shell script" {
423 icon \EFI\refind\icons\os_win.icns
424 loader \EFI\tools\shell.efi
425 options "fs0:\EFI\tools\launch_windows.nsh"
426 disabled
427 }
428
429 # Mac OS is normally detected and run automatically; however,
430 # if you want to do something unusual, a manual boot stanza may
431 # be the way to do it. This one does nothing very unusual, but
432 # it may serve as a starting point. Note that you'll almost
433 # certainly need to change the "volume" line for this example
434 # to work.
435 menuentry "My Mac OS X" {
436 icon \EFI\refind\icons\os_mac.icns
437 volume "OS X boot"
438 loader \System\Library\CoreServices\boot.efi
439 disabled
440 }