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