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