code.delx.au - refind/blob - docs/man/mkrlconf.8

   1 .\" Copyright 2015 Roderick W. Smith (rodsmith@rodsbooks.com)
   2 .\" May be distributed under the GNU Free Documentation License version 1.3 or
   3 any later version
   4 .TH "MKRLCONF" "8" "0.10.1" "Roderick W. Smith" "rEFInd Manual"
   5 .SH "NAME"
   6 mkrlconf \- Create a Linux kernel configuration file for rEFInd
   7 .SH "SYNOPSIS"
   8 .BI "mkrlconf "
   9 [ \-\-force ]
  10
  11 .SH "DESCRIPTION"
  12
  13 To boot a Linux kernel directly, rEFInd must normally pass system-specific
  14 parameters to help the kernel locate its initial RAM disk (initrd) file,
  15 the installation's root filesystem, and so on. rEFInd stores this
  16 information in a file called \fIrefind_linux.conf\fR, which is stored in
  17 the same directory as the kernel(s) to which it applies. The \fImkrlconf\fR
  18 script creates this configuration file in \fI/boot\fR, using the current
  19 boot options (from \fI/proc/cmdline\fR) to populate
  20 \fI/boot/refind_linux.conf\fR with boot options that are probably (but not
  21 certainly) correct.
  22
  23 The file created in this way has three lines, which correspond to three
  24 entries on the rEFInd suboptions menu. The first entry boots using the
  25 options found in \fI/proc/cmdline\fR. The second entry boots using the same
  26 options as the first, but with \fBsingle\fR added. The third entry boots
  27 with minimal options of \fBro root={CURRENT_ROOT_DEVICE}\fR, where
  28 \fB{CURRENT_ROOT_DEVICE}\fR identifies the current root (\fI/\fR)
  29 filesystem. Users may manually edit the \fIrefind_linux.conf\fR file to
  30 suit their needs, of course.
  31
  32 .SH "OPTIONS"
  33
  34 .TP
  35 .B \-\-force
  36 Ordinarily, if \fImkrlconf\fR finds an existing
  37 \fI/boot/refind_linux.conf\fR file, it refuses to replace it. The
  38 \fB\-\-force\fR option causes \fImkrlconf\fR to replace the existing file
  39 in favor of one it generates.
  40
  41 .SH "AUTHORS"
  42 Primary author: Roderick W. Smith (rodsmith@rodsbooks.com)
  43
  44 .SH "SEE ALSO"
  45 \fBmvrefind (8)\fR,
  46 \fBrefind-install (8)\fR
  47
  48 \fIhttp://www.rodsbooks.com/refind/\fR
  49
  50 .SH "AVAILABILITY"
  51 The \fBmkrlconf\fR command is part of the \fIrEFInd\fR package and is
  52 available from Roderick W. Smith.