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