]> code.delx.au - refind/blob - refind.conf-sample
Version supports Secure Boot/MOK verification of binaries.
[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 an
49 # uncompressed BMP image file with a color depth of 24, 8, 4, or 1 bits.
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 (requires external program; see rEFInd
91 # documentation for details)
92 # gptsync - the (dangerous) gptsync.efi utility (requires external
93 # program; see rEFInd documentation for details)
94 # apple_recovery - boots the Apple Recovery HD partition, if present
95 # mok_tool - makes available the Machine Owner Key (MOK) maintenance
96 # tool, MokManager.efi, used on Secure Boot systems
97 # about - an "about this program" option
98 # exit - a tag to exit from rEFInd
99 # shutdown - shuts down the computer (a bug causes this to reboot
100 # EFI systems)
101 # reboot - a tag to reboot the computer
102 # Default is shell,apple_recovery,mok_tool,about,shutdown,reboot
103 #
104 #showtools shell, about, reboot
105
106 # Directories in which to search for EFI drivers. These drivers can
107 # provide filesystem support, give access to hard disks on plug-in
108 # controllers, etc. In most cases none are needed, but if you add
109 # EFI drivers and you want rEFInd to automatically load them, you
110 # should specify one or more paths here. rEFInd always scans the
111 # "drivers" and "drivers_{arch}" subdirectories of its own installation
112 # directory (where "{arch}" is your architecture code); this option
113 # specifies ADDITIONAL directories to scan.
114 # Default is to scan no additional directories for EFI drivers
115 #
116 #scan_driver_dirs EFI/tools/drivers,drivers
117
118 # Which types of boot loaders to search, and in what order to display them:
119 # internal - internal EFI disk-based boot loaders
120 # external - external EFI disk-based boot loaders
121 # optical - EFI optical discs (CD, DVD, etc.)
122 # hdbios - BIOS disk-based boot loaders
123 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.)
124 # cd - BIOS optical-disc boot loaders
125 # manual - use stanzas later in this configuration file
126 # Note that the legacy BIOS options require firmware support, which is
127 # not present on all computers.
128 # On UEFI PCs, default is internal,external,optical,manual
129 # On Macs, default is internal,hdbios,external,biosexternal,optical,cd,manual
130 #
131 #scanfor internal,external,optical,manual
132
133 # Delay for the specified number of seconds before scanning disks.
134 # This can help some users who find that some of their disks
135 # (usually external or optical discs) aren't detected initially,
136 # but are detected after pressing Esc.
137 #
138 #scan_delay 5
139
140 # When scanning volumes for EFI boot loaders, rEFInd always looks for
141 # Mac OS X's and Microsoft Windows' boot loaders in their normal locations,
142 # and scans the root directory and every subdirectory of the /EFI directory
143 # for additional boot loaders, but it doesn't recurse into these directories.
144 # The also_scan_dirs token adds more directories to the scan list.
145 # Directories are specified relative to the volume's root directory. This
146 # option applies to ALL the volumes that rEFInd scans. If a specified
147 # directory doesn't exist, it's ignored (no error condition results).
148 # The default is to scan no additional directories.
149 #
150 #also_scan_dirs boot,EFI/linux/kernels
151
152 # Directories that should NOT be scanned for boot loaders. By default,
153 # rEFInd doesn't scan its own directory or the EFI/tools directory.
154 # You can "blacklist" additional directories with this option, which
155 # takes a list of directory names as options. You might do this to
156 # keep EFI/boot/bootx64.efi out of the menu if that's a duplicate of
157 # another boot loader or to exclude a directory that holds drivers
158 # or non-bootloader utilities provided by a hardware manufacturer. If
159 # a directory is listed both here and in also_scan_dirs, dont_scan_dirs
160 # takes precedence. Note that this blacklist applies to ALL the
161 # filesystems that rEFInd scans, not just the ESP.
162 #
163 #dont_scan_dirs EFI/boot,EFI/Dell
164
165 # Scan for Linux kernels that lack a ".efi" filename extension. This is
166 # useful for better integration with Linux distributions that provide
167 # kernels with EFI stub loaders but that don't give those kernels filenames
168 # that end in ".efi", particularly if the kernels are stored on a
169 # filesystem that the EFI can read. When uncommented, this option causes
170 # all files in scanned directories with names that begin with "vmlinuz"
171 # or "bzImage" to be included as loaders, even if they lack ".efi"
172 # extensions. The drawback to this option is that it can pick up kernels
173 # that lack EFI stub loader support and other files. Most notably, if you
174 # want to give a kernel a custom icon by placing an icon with the kernel's
175 # filename but a ".icns" extension in the same directory as the kernel, this
176 # option will cause the icon file to show up as a non-functional loader tag.
177 # Default is to NOT scan for kernels without ".efi" extensions.
178 #
179 #scan_all_linux_kernels
180
181 # Set the maximum number of tags that can be displayed on the screen at
182 # any time. If more loaders are discovered than this value, rEFInd shows
183 # a subset in a scrolling list. If this value is set too high for the
184 # screen to handle, it's reduced to the value that the screen can manage.
185 # If this value is set to 0 (the default), it's adjusted to the number
186 # that the screen can handle.
187 #
188 #max_tags 0
189
190 # Set the default menu selection. The available arguments match the
191 # keyboard accelerators available within rEFInd. You may select the
192 # default loader using:
193 # - A digit between 1 and 9, in which case the Nth loader in the menu
194 # will be the default.
195 # - Any substring that corresponds to a portion of the loader's title
196 # (usually the OS's name or boot loader's path).
197 #
198 #default_selection 1
199
200 # Sample manual configuration stanzas. Each begins with the "menuentry"
201 # keyword followed by a name that's to appear in the menu (use quotes
202 # if you want the name to contain a space) and an open curly brace
203 # ("{"). Each entry ends with a close curly brace ("}"). Common
204 # keywords within each stanza include:
205 #
206 # volume - identifies the filesystem from which subsequent files
207 # are loaded. You can specify the volume by label or by
208 # a number followed by a colon (as in "0:" for the first
209 # filesystem or "1:" for the second).
210 # loader - identifies the boot loader file
211 # initrd - Specifies an initial RAM disk file
212 # icon - specifies a custom boot loader icon
213 # ostype - OS type code to determine boot options available by
214 # pressing Insert. Valid values are "MacOS", "Linux",
215 # "Windows", and "XOM". Case-sensitive.
216 # graphics - set to "on" to enable graphics-mode boot (useful
217 # mainly for MacOS) or "off" for text-mode boot.
218 # Default is auto-detected from loader filename.
219 # options - sets options to be passed to the boot loader; use
220 # quotes if more than one option should be passed or
221 # if any options use characters that might be changed
222 # by rEFInd parsing procedures (=, /, #, or tab).
223 # disabled - use alone or set to "yes" to disable this entry.
224 #
225 # Note that you can use either DOS/Windows/EFI-style backslashes (\)
226 # or Unix-style forward slashes (/) as directory separators. Either
227 # way, all file references are on the ESP from which rEFInd was
228 # launched.
229 # Use of quotes around parameters causes them to be interpreted as
230 # one keyword, and for parsing of special characters (spaces, =, /,
231 # and #) to be disabled. This is useful mainly with the "options"
232 # keyword. Use of quotes around parameters that specify filenames is
233 # permissible, but you must then use backslashes instead of slashes,
234 # except when you must pass a forward slash to the loader, as when
235 # passing a root= option to a Linux kernel.
236
237 # Below are several sample boot stanzas. All are disabled by default.
238 # Find one similar to what you need, copy it, remove the "disabled" line,
239 # and adjust the entries to suit your needs.
240
241 # A sample entry for a Linux 3.3 kernel with its new EFI boot stub
242 # support on a filesystem called "KERNELS". This entry includes
243 # Linux-specific boot options and specification of an initial RAM disk.
244 # Note uses of Linux-style forward slashes, even in the initrd
245 # specification. Also note that a leading slash is optional in file
246 # specifications.
247 menuentry Linux {
248 icon EFI/refind/icons/os_linux.icns
249 volume KERNELS
250 loader bzImage-3.3.0-rc7
251 initrd initrd-3.3.0.img
252 options "ro root=UUID=5f96cafa-e0a7-4057-b18f-fa709db5b837"
253 disabled
254 }
255
256 # A sample entry for loading Ubuntu using its standard name for
257 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
258 menuentry Ubuntu {
259 loader /EFI/ubuntu/grubx64.efi
260 icon /EFI/refined/icons/os_linux.icns
261 disabled
262 }
263
264 # A minimal ELILO entry, which probably offers nothing that
265 # auto-detection can't accomplish.
266 menuentry "ELILO" {
267 loader \EFI\elilo\elilo.efi
268 disabled
269 }
270
271 # Like the ELILO entry, this one offers nothing that auto-detection
272 # can't do; but you might use it if you want to disable auto-detection
273 # but still boot Windows....
274 menuentry "Windows 7" {
275 loader \EFI\Microsoft\Boot\bootmgfw.efi
276 disabled
277 }
278
279 # EFI shells are programs just like boot loaders, and can be
280 # launched in the same way. You can pass a shell the name of a
281 # script that it's to run on the "options" line. The script
282 # could initialize hardware and then launch an OS, or it could
283 # do something entirely different.
284 menuentry "Windows via shell script" {
285 icon \EFI\refind\icons\os_win.icns
286 loader \EFI\tools\shell.efi
287 options "fs0:\EFI\tools\launch_windows.nsh"
288 disabled
289 }
290
291 # Mac OS is normally detected and run automatically; however,
292 # if you want to do something unusual, a manual boot stanza may
293 # be the way to do it. This one does nothing very unusual, but
294 # it may serve as a starting point. Note that you'll almost
295 # certainly need to change the "volume" line for this example
296 # to work.
297 menuentry "My Mac OS X" {
298 icon \EFI\refind\icons\os_mac.icns
299 volume "OS X boot"
300 loader \System\Library\CoreServices\boot.efi
301 disabled
302 }