doc/genkernel.8.txt

   1 GENKERNEL(8)
   2 ============
   3 :man source:   genkernel {genkernelversion}
   4 :man manual:   genkernel {genkernelversion}
   5
   6
   7 NAME
   8 ----
   9 genkernel - the Gentoo Linux automatic kernel compiler.
  10
  11
  12 SYNOPSIS
  13 --------
  14 *genkernel* [options...] action
  15
  16
  17 INTRODUCTION
  18 ------------
  19 Genkernel is designed to allow users who are not previously used to
  20 compiling a kernel to use a similar setup to that one that is used on
  21 the Gentoo LiveCDs which auto-detects your hardware.
  22
  23 Some users may also be interested in using genkernel for hardware which
  24 requires initialization and a working kernel before it can be booted
  25 because genkernel also automatically compiles your kernel modules,
  26 allowing hardware which needs to be loaded with module parameters to be
  27 used.
  28
  29
  30 USAGE
  31 -----
  32 All that is needed to run genkernel is just `genkernel` with an
  33 action and any flags you might need:
  34
  35 ------------------------------------------
  36 # genkernel --menuconfig --no-clean --no-install all
  37 ------------------------------------------
  38
  39 This would produce a kernel, asking you what how to configure it to
  40 your desire, leaving alone any existing compiled object files, but not
  41 installing anything.
  42
  43
  44 ACTIONS
  45 -------
  46 An action tells genkernel what you want it to do  -  the following
  47 actions are supported:
  48
  49 *all*::
  50     Build all steps - the kernel, modules, and the ramdisk.
  51 *bzImage*::
  52     Build only the kernel.
  53 *initramfs*::
  54     Build only the ramdisk/initramfs.
  55 *kernel*::
  56     Build only the kernel and the modules.
  57 *ramdisk*::
  58     Build only the ramdisk/initramfs.
  59
  60
  61 OPTIONS
  62 -------
  63 Genkernel supports the following options which alter its behaviour.
  64 Certain options have *--no-* variants which do the opposite thing.
  65 You can specify your options in any order.
  66
  67
  68 CONFIGURATION OPTIONS
  69 ~~~~~~~~~~~~~~~~~~~~~
  70 *--config*=<file>::
  71     Genkernel configuration file to use
  72
  73
  74 DEBUGGING OPTIONS
  75 ~~~~~~~~~~~~~~~~~
  76 *--loglevel*=<0-5>::
  77     This controls the out verbosity level of genkernel output - if
  78     this is set to 0, minimal debugging is done; if this is set to 5
  79     as much output as possible is given.
  80
  81 *--logfile*=<outfile>::
  82     This outputs debugging data to the file <outfile>. By default
  83     this is '/var/log/genkernel.log'.
  84
  85 *--*[*no-*]*color*::
  86     Turns on, or off, output in color using escape sequences.
  87
  88
  89 KERNEL CONFIGURATION
  90 ~~~~~~~~~~~~~~~~~~~~
  91 *--*[*no-*]*menuconfig*::
  92     Runs, or does not run "make menuconfig" after running "make oldconfig".
  93
  94 *--*[*no-*]*save-config*::
  95     Saves, or does not save the kernel configuration to '/etc/kernels'
  96     if the kernel is successfully compiled.
  97
  98 *--*[*no-*]*gconfig*::
  99     Runs, or does not run "make gconfig" after "make oldconfig".
 100
 101 *--*[*no-*]*xconfig*::
 102     Runs, or does not run "make xconfig" after "make oldconfig".
 103
 104
 105 KERNEL COMPILATION
 106 ~~~~~~~~~~~~~~~~~~
 107 *--*[*no-*]*clean*::
 108     Runs, or does not run, "make clean" before compilation  -  this
 109     erases any compiled object files in the kernel source tree but
 110     does not have an impact on the kernel configuration.  Specifying
 111     *--no-clean* implies *--no-mrproper*.
 112
 113 *--*[*no-*]*mrproper*::
 114     Runs, or does not run, "make mrproper" before compilation - this
 115     erases both any compiled object files in the kernel source tree
 116     as well as the kernel configuration.
 117
 118 *--*[*no-*]*install*::
 119     Installs,  or does not install the kernel to '/boot' after building.
 120     The default is  *--install*.   If MOUNTBOOT is set in
 121     '/etc/genkernel.conf'  then '/boot' will be automatically mounted if
 122     it is not already mounted before the ramdisk and kernel images
 123     are copied over.
 124
 125 *--*[*no-*]*symlink*::
 126     Manages,  or does not manage, symlinks in '/boot' like the manual
 127     kernel "make install" process does. A kernel (or,  depending on
 128     options,  kernelz)  symlink will link to the most recently built
 129     kernel image and a kernel.old (or kernelz.old) symlink will link
 130     to the second most recently built image, if one exists.  Similar
 131     symlinks (both * and *.old) are managed for initramfs and System.map.
 132     The corresponding work products (i.e., the actual kernel
 133     and initramfs images, and System.map) are also managed accordingly.
 134     NOTE: Specifying   *--symlink*  does nothing unless
 135     *--install* is also specified.
 136
 137 *--oldconfig*::
 138     Implies *--no-clean*, and thus *--no-mrproper*, running a "make oldconfig".
 139
 140 *--*[*no-*]*splash*::
 141     Installs, or not, framebuffer splash support into initramfs.
 142
 143 *--*[*no-*]*ramdisk-modules*::
 144     Copies or does not copy configured modules to the ramdisk.
 145
 146 *--*[*no-*]*all-ramdisk-modules*::
 147     Copies or does not copy all kernel modules to the initrd.
 148
 149 *--callback*=<...>::
 150     Run the specified arguments in the current environment after the
 151     kernel and modules have been compiled.
 152
 153 *--*[*no-*]*static*::
 154         Builds, or does not build a monolithic kernel without any modules on any
 155         initial ramdisks.
 156
 157
 158 KERNEL LOCATIONS
 159 ~~~~~~~~~~~~~~~~
 160 *--kerneldir*=<dir>::
 161     This specifies the location of the kernel sources;  the default
 162     is '/usr/src/linux'.
 163
 164 *--kernel-config*=<file>::
 165     This specifies a kernel configuration file to use for compilation;
 166     by default genkernel uses the config from the previous
 167     build of the same kernel version or a default kernel config if
 168     there isn't a previous config.
 169
 170 *--module-prefix*=<dir>::
 171     Prefix to kernel module destination, modules will be installed in
 172     '<prefix>/lib/modules'.
 173
 174
 175 LOW-LEVEL COMPILATION OPTIONS
 176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 177 *--kernel-cc*=<compiler>::
 178     Compiler to use for the kernel compilation (e.g. distcc).
 179
 180 *--kernel-as*=<assembler>::
 181     Assembler to use for the kernel compilation.
 182
 183 *--kernel-ld*=<linker>::
 184     Linker to use for the kernel compilation.
 185
 186 *--kernel-cross-compile*=<cross var>::
 187     CROSS_COMPILE kernel variable.
 188
 189 *--kernel-make*=<makeprg>::
 190     GNU Make to use for the kernel compilation.
 191
 192 *--kernel-target*=<t>::
 193     Override default make target (bzImage), note that values
 194     like *--kernel-target=* are also valid (useful for Xen
 195     based kernel sources)
 196
 197 *--kernel-binary*=<path>::
 198     Override default kernel binary path (arch/foo/boot/bar)
 199
 200 *--utils-cc*=<compiler>::
 201     Compiler to use for utilities.
 202
 203 *--utils-as*=<assembler>::
 204     Assembler to use for utilities.
 205
 206 *--utils-ld*=<linker>::
 207     Linker to use for utilities.
 208
 209 *--utils-make*=<makeprog>::
 210     GNU Make to use for utilities.
 211
 212 *--utils-cross-compile*=<cross var>::
 213     CROSS_COMPILE utils variable.
 214
 215 *--utils-arch*=<arch>::
 216     Force to arch for utils only instead of autodetect.
 217
 218 *--*[*no-*]*mountboot*::
 219     Mount, or not, BOOTDIR automatically if mountable.
 220
 221 *--bootdir*=<dir>::
 222     Set the location of the boot-directory, default is '/boot'.
 223
 224 *--modprobedir*=<dir>::
 225     Set the location of the modprobe.d-directory, default is '/etc/modprobe.d'.
 226
 227 *--makeopts*=<makeopts>::
 228     GNU Make options such as -j2, etc.
 229
 230
 231 INITIALIZATION
 232 ~~~~~~~~~~~~~~
 233 *--splash*=<theme>::
 234     Enable framebuffer splash using <theme>.
 235
 236 *--splash-res*=<resolutions>::
 237     Select gensplash resolutions to include.
 238
 239 *--*[*no-*]*splash*=<theme>::
 240     If the extra argument is specified,  splash is forced using
 241     <theme>  rather than the default theme specified in your splash
 242     configuration. If *--no-splash* is specified, then splash is disabled.
 243
 244 *--do-keymap-auto*::
 245     Force keymap selection at boot.
 246
 247 *--*[*no-*]*keymap*::
 248     Enables or disables keymap selection at boot.
 249
 250 *--*[*no-*]*lvm*::
 251         Adds or skips in LVM support from static binaries if they exist on the
 252         system,  or compile static LVM binaries if static ones do not exist.
 253
 254 *--*[*no-*]*mdadm*::
 255     Includes or excludes mdadm/mdmon support.
 256     Without sys-fs/mdadm[static] installed, this will compile mdadm for you.
 257
 258 *--mdadm-config*=<file>::
 259     Use <file> as configfile for MDADM.
 260     By default the ramdisk will be built *without* an mdadm.conf and
 261     will auto-detect arrays during boot-up.
 262
 263 *--*[*no-*]*dmraid*::
 264     Includes or excludes DMRAID support.
 265
 266 *--*[*no-*]*zfs*::
 267     Includes or excludes ZFS support.
 268
 269 *--*[*no-*]*multipath*::
 270     Includes or excludes Multipath support
 271
 272 *--*[*no-*]*iscsi*::
 273     Includes or excludes iSCSI support
 274
 275 *--bootloader*=*grub*::
 276     Add new kernel to GRUB configuration.
 277
 278 *--linuxrc*=<file>::
 279     Use <file> for the linuxrc instead of the genkernel linuxrc.
 280
 281 *--busybox-config*=<file>::
 282     Specifies a user created busybox config.
 283
 284 *--genzimage*::
 285         Make and install kernelz image from 'arch/powerpc/boot/zImage.initrd'.
 286
 287 *--*[*no-*]*disklabel*::
 288     Includes or excludes disk label and uuid support in your initrd.
 289
 290 *--*[*no-*]*luks*::
 291         Includes or excludes Luks support from static binaries if they exist on
 292         the system.
 293
 294 *--*[*no-*]*gpg*::
 295         Includes or excludes support for GnuPG 1.x, the portable standalone branch
 296         of GnuPG. A key can be made from
 297     `gpg --symmetric -o /path/to/LUKS-key.gpg /path/to/LUKS-key` .
 298     After that, re-point the *root_key* argument to the new .gpg file.
 299
 300 *--*[*no-*]*busybox*::
 301     Includes or excludes busybox in the initrd or initramfs.
 302
 303 *--*[*no-*]*unionfs*::
 304     Includes or excludes support for unionfs
 305
 306 *--*[*no-*]*netboot*::
 307     Creates or does not create a self-contained env in the initramfs
 308
 309 *--real-root*=<foo>::
 310     Specify a default for *real_root*= kernel option.
 311
 312
 313 INTERNALS
 314 ~~~~~~~~~
 315 *--arch-override*=<arch>::
 316     Force the architecture settings described by the <arch>  profile
 317     instead of autodetecting the running architecture.
 318
 319 *--cachedir*=<dir>::
 320     Override the default cache location.
 321
 322 *--tempdir*=<dir>::
 323     Sets genkernel's temporary working directory to <dir>.
 324
 325 *--*[*no-*]*postclear*::
 326         Clears or skips clearing all tmp files and caches after genkernel has run.
 327
 328
 329 OUTPUT SETTINGS
 330 ~~~~~~~~~~~~~~~
 331 *--kernname*=<...>::
 332     Tag the kernel and initrd with a name, if not defined this
 333     option defaults to genkernel
 334
 335 *--minkernpackage*=<tbz2>::
 336     File to output a .tar.bz2'd kernel and initrd: no modules outside
 337     of the initrd will be included...
 338
 339 *--modulespackage*=<tbz2>::
 340     File to output a .tar.bz2'd modules after the callbacks have run
 341
 342 *--kerncache*=<tbz2>::
 343     File to output a .tar.bz2'd kernel, contents of '/lib/modules/'
 344     and the kernel config.  NOTE: This is created before the callbacks
 345     are run.
 346
 347 *--*[*no-*]*kernel-sources*::
 348     This option is only valid if kerncache is defined If there is a
 349     valid kerncache no checks will be made against a kernel source
 350     tree.
 351
 352 *--initramfs-overlay*=<dir>::
 353     Directory structure to include in the initramfs, only available
 354     on >=2.6 kernels
 355
 356 *--*[*no-*]*firmware*::
 357     Enable or disables copying of firmware into initramfs.
 358
 359 *--firmware-dir*=<dir>::
 360     Specify directory to copy firmware from (defaults to '/lib/firmware').
 361
 362 *--firmware-files*=<files>::
 363     Specifies specific firmware files to copy. This overrides *--firmware-dir*.
 364     For multiple files, separate the filenames with a comma.
 365
 366 *--*[*no-*]*integrated-initramfs*::
 367         Builds or does not build the generated initramfs into the kernel instead
 368         of keeping it as a separate file.
 369
 370 *--*[*no-*]*compress-initramfs*, *--*[*no-*]*compress-initrd*::
 371         Compresses or does not compress the generated initramfs.
 372
 373 *--compress-initramfs-type*=<arg>::
 374         Compression type for initramfs (best, xz, lzma, bzip2, gzip, lzop).
 375         "Best" causes selection of the best available algorithm that is selected
 376         in your kernel configuration.
 377
 378
 379 RAMDISK OPTIONS
 380 ---------------
 381 The following options can be passed as kernel parameters from the bootloader,
 382 which the ramdisk scripts would recognize.
 383
 384 *real_root*=<...>::
 385     Specifies the device node of the root filesystem to mount.
 386
 387 *crypt_root*=<...>::
 388     This specifies the device encrypted by Luks, which contains the
 389     root filesystem to mount.
 390
 391 *crypt_swap*=<...>::
 392     This specifies the swap device encrypted by Luks.
 393
 394 *root_key*=<...>::
 395     In case your root is encrypted with a key, you can use a device
 396     like a  usb pen to store the key.  This value should be the key
 397     path relative to the mount point.
 398
 399 *root_keydev*=<...>::
 400     If necessary provide the name of the device that carries the
 401     root_key.   If unset while using root_key, it will automatically
 402     look for the device in every boot.
 403
 404 *root_trim*=(yes|no)::
 405     Enables TRIM support for a Luks-based root device.  Only useful
 406     with SSD setups.  Have a look at 'http://en.wikipedia.org/wiki/TRIM'
 407     for more information.
 408
 409 *swap_key*=<...>::
 410     Same as root_key for swap.
 411
 412 *swap_keydev*=<...>::
 413     Same as root_keydev for swap.
 414
 415 *crypt_silent*::
 416     Set this to silent all the output related to the cryptographic
 417     software,  and in case your encrypted device isn't open with the
 418     key, it opens a shell in the initrd quietly.
 419
 420 *dodmraid*[=<...>]::
 421     Activate Device-Mapper RAID and (optionally) pass arguments to it.
 422
 423 *real_init*=<...>::
 424     Override location of init script, default is "/sbin/init".
 425
 426 *init_opts*=<...>::
 427     Passes arguments to init on bootup.
 428
 429 *scandelay*[=<...>]::
 430     Pauses for 10 seconds before running devfsd if no argument is
 431     specified; otherwise pauses for the number of specified seconds.
 432
 433 *ip*=<...>::
 434     Normally used to tell the kernel that it should start a network
 435     interface. If present, the initrd will try to mount a  livecd
 436     over NFS.
 437
 438 *nfsroot*=<...>::
 439     If present,  the initrd will try to mount a livecd from that
 440     location. Otherwise the location will be deduced from the DCHP
 441     request (option root-path)
 442
 443 *dolvm*::
 444     Activate LVM volumes on bootup
 445
 446 *lvmraid*=<...>::
 447     Specify RAID devices to set up before the activation of LVM volumes.
 448     Implies option *dolvm*.
 449
 450 *domdadm*::
 451     Scan for RAID arrays on bootup
 452
 453 *dozfs*[=force]::
 454     Scan for bootable ZFS pools on bootup. Optionally force import if
 455     necessary.
 456
 457 *doscsi*::
 458     Activate SCSI devices on bootup, necessary when SCSI support is
 459     compiled as modules and you're using SCSI or SATA devices.
 460
 461 *noslowusb*::
 462     By default genkernel pause for 10 seconds if it finds a attached
 463     usb-storage device to give them time to initiate.
 464     This option skips that pause.
 465
 466 *keymap*='MAP'::
 467     Set keymap to 'MAP', e.g. *keymap*=de.
 468     For valid values of 'MAP' please see
 469     '/usr/share/genkernel/defaults/keymaps/'.
 470
 471 *dokeymap*::
 472     Use keymap.  Usage of *keymap*= implies this option, already.
 473
 474 *rootfstype*=<...>::
 475     Specify the file system type to mount the real root filesystem as.
 476     This can be useful when support for ext2/ext3/ext4 are
 477     in competition.  Default is "auto".
 478
 479 *docache*::
 480 *nocache*::
 481     Enables/disables caching of CD contents in RAM.
 482
 483 *root*=<...>::
 484     Omit or specify as "/dev/ram0".
 485     For other values be sure to know what you're doing.
 486
 487 *subdir*=<...>::
 488     switch_root into "<CHROOT>/<SUBDIR>" instead of "<CHROOT>/".
 489     <CHROOT> is "/newroot" (or "/union") usually.
 490
 491 *debug*::
 492     Drop into a debug shell early in the process.
 493
 494 *noload*=<...>::
 495     List of modules to skip loading.
 496     Separate using commas or spaces.
 497
 498 *nodetect*::
 499     Skipping scanning modules using "modprobe <MODULE> -n".
 500     Use *doload=* for specifying a whitelist of exceptions.
 501
 502 *doload*=<...>::
 503     List of modules to load despite *nodetect*.
 504
 505 *domodules*::
 506 *nomodules*::
 507     Enables/disables loading of modules in general.
 508
 509 *CONSOLE*=<...>::
 510 *console*=<...>::
 511     Override location of console, default is "/dev/console".
 512
 513 *part*=<...>::
 514     Specify part for mdadm to start.  This is the relevant code in mdstart:
 515 ------------------------------------------
 516     fd = open("/dev/md<MD_NUMBER>", 0, 0);
 517     ioctl(fd, RAID_AUTORUN, <MDPART>);
 518 ------------------------------------------
 519
 520 *iscsi_initiatorname*=<...>::
 521 *iscsi_target*=<...>::
 522 *iscsi_tgpt*=<...>::
 523 *iscsi_address*=<...>::
 524 *iscsi_port*=<...>::
 525 *iscsi_username*=<...>::
 526 *iscsi_password*=<...>::
 527 *iscsi_username_in*=<...>::
 528 *iscsi_password_in*=<...>::
 529 *iscsi_debug*=<...>::
 530 *iscsi_noibft*::
 531     Specify iSCSI parameters.
 532
 533 *unionfs*::
 534 *nounionfs*::
 535     Enables/disables UnionFS.
 536
 537 *aufs*::
 538     Enables support for AUFS2 (if available in the kernel).
 539
 540 *real_rootflags*=<...>::
 541     Additional flags to mount the real root system with.
 542     For example *real_rootflags*=noatime would make "-o ro,noatime".
 543
 544 *real_resume*=<...>::
 545 *resume*=<...>::
 546 *noresume*::
 547     TO BE DOCUMENTED
 548
 549 *cdroot*[=<...>]::
 550 *cdroot_type*=<...>::
 551     TO BE DOCUMENTED
 552
 553 *loop*=<...>::
 554 *looptype*=<...>::
 555     TO BE DOCUMENTED
 556
 557 *isoboot*=<...>::
 558     Loop-mount an ISO file from the boot device to get the filesystem image.
 559     Useful with chain-loading environments and USB keys.
 560
 561
 562 NETBOOTING
 563 ----------
 564 The initrd scripts have limited support for network booting.   This is
 565 activated if the *ip*=<...> kernel parameter was given. Please refer to
 566 the genkernel guide at 'http://www.gentoo.org/doc/en/genkernel.xml' for
 567 more information.
 568
 569 The initrd scripts will extract any *.tar.gz files found in the '/add'
 570 directory of the livecd into the root filesystem during boot. This way
 571 it is easy to extend a netbooted LiveCD i.e. add custom tools, or other
 572 kernel modules.
 573
 574
 575 REPORTING BUGS
 576 --------------
 577 If you believe you have found a bug in the genkernel scripts,  then
 578 please file a bug on the Gentoo Linux Bugzilla against product
 579 "Gentoo Hosted Projects" component "genkernel", i.e. at
 580 'https://bugs.gentoo.org/enter_bug.cgi?product=Gentoo%20Hosted%20Projects&component=genkernel'.
 581
 582 If you're somewhat unsure if you hit a bug or not, file a bug an we'll find out together.
 583 For general questions the is the gentoo-genkernel mailing list.  You can join the list
 584 by sending empty mail to 'gentoo-genkernel+subscribe@lists.gentoo.org'.
 585
 586 We cannot assist you with
 587 kernel compilation failures unless they are caused by a genkernel bug.
 588
 589 Kernel issues for Gentoo-supported kernels, including compilation failures
 590 should go to 'https://bugs.gentoo.org/' and should be assigned to 'kernel@gentoo.org'.
 591 Please check if an existing bug documents the same
 592 issue before opening a new bug. Issues for kernel sources not supported
 593 by Gentoo should go to their relevant authors.
 594
 595
 596 AUTHORS
 597 -------
 598 - Tim Yamin <plasmaroo@gentoo.org>
 599 - Eric Edgar <rocket@gentoo.org>
 600 - Chris Gianelloni <wolf31o2@gentoo.org>
 601 - Sebastian Pipping <sebastian@pipping.org>
 602 - NFS Support by Thomas Seiler <thseiler@gmail.com>
 603 - GnuPG 1.x integration by dacook <schism@subverted.org>
 604 - MDADM integration by Matthias Dahl <ua_bugz_gentoo@mortal-soul.de>
 605 - ZFS integration by Richard Yao <ryao@cs.stonybrook.edu>
 606
 607
 608 SEE ALSO
 609 --------
 610 /etc/genkernel.conf - genkernel configuration file