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