]> code.delx.au - refind/blob - README.txt
Documentation update
[refind] / README.txt
1 Brief Installation Instructions (Binary Package)
2 ================================================
3
4 This is rEFInd, an EFI boot manager. The binary package includes the
5 following files and subdirectories:
6
7 File Description
8 ----------------------------- -----------------------------
9 refind/refind_ia32.efi The main IA32 rEFInd binary
10 refind/refind_x64.efi The main x86-64 rEFInd binary
11 refind/refind.conf-sample A sample configuration file
12 refind/icons/ Subdirectory containing icons
13 refind/drivers_ia32/ Subdirectory containing IA32 drivers
14 refind/drivers_x64/ Subdirectory containing x86-64 drivers
15 keys/ Subdirectory containing MOKs
16 refind-install Linux/MacOS installation script
17 mkrlconf A script to create refind_linux.conf
18 mvrefind A script to move a rEFInd installation
19 README.txt This file
20 NEWS.txt A summary of program changes
21 LICENSE.txt The original rEFIt license
22 COPYING.txt The rEFInd license
23 CREDITS.txt Acknowledgments of code sources
24 docs/ Documentation in HTML format
25
26 The easiest way of installing rEFInd is generally to use the refind-install
27 script; however, you must be running under Linux or OS X to do this. If
28 you're using either of those OSes, simply typing "./refind-install" will
29 generally install rEFInd. If you have problems with this method, though,
30 you'll have to do a manual installation. The refind-install script supports
31 a number of options that you might want to use; consult the
32 docs/refind/installing.html file for details.
33
34 To install the binary package manually, you must first access your EFI
35 System Partition (ESP). You can then place the files from the refind
36 subdirectory in a subdirectory of the ESP's EFI directory. You may omit the
37 .efi binary for the type of computer you're NOT using, and you may
38 optionally rename the .efi file for the binary you are using. If this is an
39 initial installation, you should rename refind.conf-sample to refind.conf;
40 but if you're replacing an existing installation, you should leave your
41 existing refind.conf intact. The end result might include the following
42 files on the ESP:
43
44 EFI/refind/refind_x64.efi
45 EFI/refind/refind.conf
46 EFI/refind/icons/
47
48 Unfortunately, dropping the files in the ESP is not sufficient; as
49 described in the docs/refind/installing.html file, you must also tell your
50 EFI about rEFInd. Precisely how to do this varies with your OS or, if you
51 choose to do it through the EFI, your EFI implementation. In some cases you
52 may need to rename the EFI/refind directory as EFI/boot, and rename
53 refind_x86.efi to bootx64.efi (or refind_ia32.efi to bootia32.efi on 32-bit
54 systems). Consult the installing.html file for full details.
55
56 If you want to use any of the filesystem drivers, you must install them,
57 too. Creating a subdirectory of the rEFInd binary directory called
58 drivers_x64 (for x86-64 systems), drivers_ia32 (for x86 systems), or
59 drivers (for any architecture) and copying the drivers you want to this
60 location should do the trick. When you next launch it, rEFInd should load
61 the drivers, giving you access to the relevant filesystems.
62
63 Brief Installation Instructions (Source Package)
64 ================================================
65
66 rEFInd source code can be obtained from
67 https://sourceforge.net/projects/refind/. Consult the BUILDING.txt file in
68 the source code package for build instructions. Once you've built the
69 source code, you can use the refind-install script to install the binaries
70 you've built. Alternatively, you can duplicate the directory tree described
71 above by copying the individual files and the icons directory to the ESP.