3 :man source: genkernel {genkernelversion}
4 :man manual: genkernel {genkernelversion}
9 genkernel - the Gentoo Linux automatic kernel compiler.
14 *genkernel* [options...] action
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.
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
32 All that is needed to run genkernel is just `genkernel` with an
33 action and any flags you might need:
35 ------------------------------------------
36 # genkernel --menuconfig --no-clean --no-install all
37 ------------------------------------------
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
46 An action tells genkernel what you want it to do - the following
47 actions are supported:
50 Build all steps - the kernel, modules, and the ramdisk.
52 Build only the kernel.
54 Build only the ramdisk/initramfs.
56 Build only the kernel and the modules.
58 Build only the ramdisk/initramfs.
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.
71 Genkernel configuration file to use
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.
81 *--logfile*=<outfile>::
82 This outputs debugging data to the file <outfile>. By default
83 this is '/var/log/genkernel.log'.
86 Turns on, or off, output in color using escape sequences.
91 *--*[*no-*]*menuconfig*::
92 Runs, or does not run "make menuconfig" after running "make oldconfig".
94 *--*[*no-*]*save-config*::
95 Saves, or does not save the kernel configuration to '/etc/kernels'
96 if the kernel is successfully compiled.
98 *--*[*no-*]*gconfig*::
99 Runs, or does not run "make gconfig" after "make oldconfig".
101 *--*[*no-*]*xconfig*::
102 Runs, or does not run "make xconfig" after "make oldconfig".
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*.
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.
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
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.
138 Implies *--no-clean*, and thus *--no-mrproper*, running a "make oldconfig".
140 *--*[*no-*]*splash*::
141 Installs, or not, framebuffer splash support into initramfs.
143 *--*[*no-*]*ramdisk-modules*::
144 Copies or does not copy configured modules to the ramdisk.
146 *--*[*no-*]*all-ramdisk-modules*::
147 Copies or does not copy all kernel modules to the initrd.
150 Run the specified arguments in the current environment after the
151 kernel and modules have been compiled.
153 *--*[*no-*]*static*::
154 Builds, or does not build a monolithic kernel without any modules on any
160 *--kerneldir*=<dir>::
161 This specifies the location of the kernel sources; the default
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.
170 *--module-prefix*=<dir>::
171 Prefix to kernel module destination, modules will be installed in
172 '<prefix>/lib/modules'.
175 LOW-LEVEL COMPILATION OPTIONS
176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177 *--kernel-cc*=<compiler>::
178 Compiler to use for the kernel compilation (e.g. distcc).
180 *--kernel-as*=<assembler>::
181 Assembler to use for the kernel compilation.
183 *--kernel-ld*=<linker>::
184 Linker to use for the kernel compilation.
186 *--kernel-cross-compile*=<cross var>::
187 CROSS_COMPILE kernel variable.
189 *--kernel-make*=<makeprg>::
190 GNU Make to use for the kernel compilation.
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)
197 *--kernel-binary*=<path>::
198 Override default kernel binary path (arch/foo/boot/bar)
200 *--utils-cc*=<compiler>::
201 Compiler to use for utilities.
203 *--utils-as*=<assembler>::
204 Assembler to use for utilities.
206 *--utils-ld*=<linker>::
207 Linker to use for utilities.
209 *--utils-make*=<makeprog>::
210 GNU Make to use for utilities.
212 *--utils-cross-compile*=<cross var>::
213 CROSS_COMPILE utils variable.
215 *--utils-arch*=<arch>::
216 Force to arch for utils only instead of autodetect.
218 *--*[*no-*]*mountboot*::
219 Mount, or not, BOOTDIR automatically if mountable.
222 Set the location of the boot-directory, default is '/boot'.
224 *--modprobedir*=<dir>::
225 Set the location of the modprobe.d-directory, default is '/etc/modprobe.d'.
227 *--makeopts*=<makeopts>::
228 GNU Make options such as -j2, etc.
234 Enable framebuffer splash using <theme>.
236 *--splash-res*=<resolutions>::
237 Select gensplash resolutions to include.
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.
245 Force keymap selection at boot.
247 *--*[*no-*]*keymap*::
248 Enables or disables keymap selection at boot.
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.
255 Includes or excludes mdadm/mdmon support.
256 Without sys-fs/mdadm[static] installed, this will compile mdadm for you.
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.
263 *--*[*no-*]*dmraid*::
264 Includes or excludes DMRAID support.
266 *--*[*no-*]*e2fsprogs*::
267 Includes or excludes e2fsprogs.
270 Includes or excludes ZFS support.
272 *--*[*no-*]*multipath*::
273 Includes or excludes Multipath support
276 Includes or excludes iSCSI support
278 *--bootloader*=*grub*::
279 Add new kernel to GRUB configuration.
282 Use <file> for the linuxrc instead of the genkernel linuxrc.
284 *--busybox-config*=<file>::
285 Specifies a user created busybox config.
288 Make and install kernelz image from 'arch/powerpc/boot/zImage.initrd'.
290 *--*[*no-*]*disklabel*::
291 Includes or excludes disk label and uuid support in your initrd.
294 Includes or excludes Luks support from static binaries if they exist on
298 Includes or excludes support for GnuPG 1.x, the portable standalone branch
299 of GnuPG. A key can be made from
300 `gpg --symmetric -o /path/to/LUKS-key.gpg /path/to/LUKS-key` .
301 After that, re-point the *root_key* argument to the new .gpg file.
303 *--*[*no-*]*busybox*::
304 Includes or excludes busybox in the initrd or initramfs.
306 *--*[*no-*]*unionfs*::
307 Includes or excludes support for unionfs
309 *--*[*no-*]*netboot*::
310 Creates or does not create a self-contained env in the initramfs
312 *--real-root*=<foo>::
313 Specify a default for *real_root*= kernel option.
318 *--arch-override*=<arch>::
319 Force the architecture settings described by the <arch> profile
320 instead of autodetecting the running architecture.
323 Override the default cache location.
326 Sets genkernel's temporary working directory to <dir>.
328 *--*[*no-*]*postclear*::
329 Clears or skips clearing all tmp files and caches after genkernel has run.
335 Tag the kernel and initrd with a name, if not defined this
336 option defaults to genkernel
338 *--minkernpackage*=<tbz2>::
339 File to output a .tar.bz2'd kernel and initrd: no modules outside
340 of the initrd will be included...
342 *--modulespackage*=<tbz2>::
343 File to output a .tar.bz2'd modules after the callbacks have run
345 *--kerncache*=<tbz2>::
346 File to output a .tar.bz2'd kernel, contents of '/lib/modules/'
347 and the kernel config. NOTE: This is created before the callbacks
350 *--*[*no-*]*kernel-sources*::
351 This option is only valid if kerncache is defined If there is a
352 valid kerncache no checks will be made against a kernel source
355 *--initramfs-overlay*=<dir>::
356 Directory structure to include in the initramfs, only available
359 *--*[*no-*]*firmware*::
360 Enable or disables copying of firmware into initramfs.
362 *--firmware-dir*=<dir>::
363 Specify directory to copy firmware from (defaults to '/lib/firmware').
365 *--firmware-files*=<files>::
366 Specifies specific firmware files to copy. This overrides *--firmware-dir*.
367 For multiple files, separate the filenames with a comma.
369 *--*[*no-*]*integrated-initramfs*::
370 Builds or does not build the generated initramfs into the kernel instead
371 of keeping it as a separate file.
373 *--*[*no-*]*compress-initramfs*, *--*[*no-*]*compress-initrd*::
374 Compresses or does not compress the generated initramfs.
376 *--compress-initramfs-type*=<arg>::
377 Compression type for initramfs (best, xz, lzma, bzip2, gzip, lzop).
378 "Best" causes selection of the best available algorithm that is selected
379 in your kernel configuration.
384 The following options can be passed as kernel parameters from the bootloader,
385 which the ramdisk scripts would recognize.
388 Specifies the device node of the root filesystem to mount.
391 This specifies the device encrypted by Luks, which contains the
392 root filesystem to mount.
395 This specifies the swap device encrypted by Luks.
398 In case your root is encrypted with a key, you can use a device
399 like a usb pen to store the key. This value should be the key
400 path relative to the mount point.
402 *root_keydev*=<...>::
403 If necessary provide the name of the device that carries the
404 root_key. If unset while using root_key, it will automatically
405 look for the device in every boot.
407 *root_trim*=(yes|no)::
408 Enables TRIM support for a Luks-based root device. Only useful
409 with SSD setups. Have a look at 'http://en.wikipedia.org/wiki/TRIM'
410 for more information.
413 Same as root_key for swap.
415 *swap_keydev*=<...>::
416 Same as root_keydev for swap.
419 Set this to silent all the output related to the cryptographic
420 software, and in case your encrypted device isn't open with the
421 key, it opens a shell in the initrd quietly.
424 Activate Device-Mapper RAID and (optionally) pass arguments to it.
427 Override location of init script, default is "/sbin/init".
430 Passes arguments to init on bootup.
432 *scandelay*[=<...>]::
433 Pauses for 10 seconds before running devfsd if no argument is
434 specified; otherwise pauses for the number of specified seconds.
437 Normally used to tell the kernel that it should start a network
438 interface. If present, the initrd will try to mount a livecd
442 If present, the initrd will try to mount a livecd from that
443 location. Otherwise the location will be deduced from the DCHP
444 request (option root-path)
447 Activate LVM volumes on bootup
450 Specify RAID devices to set up before the activation of LVM volumes.
451 Implies option *dolvm*.
454 Scan for RAID arrays on bootup
457 Scan for bootable ZFS pools on bootup. Optionally force import if
461 Activate SCSI devices on bootup, necessary when SCSI support is
462 compiled as modules and you're using SCSI or SATA devices.
465 By default genkernel pause for 10 seconds if it finds a attached
466 usb-storage device to give them time to initiate.
467 This option skips that pause.
470 Set keymap to 'MAP', e.g. *keymap*=de.
471 For valid values of 'MAP' please see
472 '/usr/share/genkernel/defaults/keymaps/'.
475 Use keymap. Usage of *keymap*= implies this option, already.
478 Specify the file system type to mount the real root filesystem as.
479 This can be useful when support for ext2/ext3/ext4 are
480 in competition. Default is "auto".
484 Enables/disables caching of CD contents in RAM.
487 Omit or specify as "/dev/ram0".
488 For other values be sure to know what you're doing.
491 switch_root into "<CHROOT>/<SUBDIR>" instead of "<CHROOT>/".
492 <CHROOT> is "/newroot" (or "/union") usually.
495 Drop into a debug shell early in the process.
498 List of modules to skip loading.
499 Separate using commas or spaces.
502 Skipping scanning modules using "modprobe <MODULE> -n".
503 Use *doload=* for specifying a whitelist of exceptions.
506 List of modules to load despite *nodetect*.
510 Enables/disables loading of modules in general.
514 Override location of console, default is "/dev/console".
517 Specify part for mdadm to start. This is the relevant code in mdstart:
518 ------------------------------------------
519 fd = open("/dev/md<MD_NUMBER>", 0, 0);
520 ioctl(fd, RAID_AUTORUN, <MDPART>);
521 ------------------------------------------
523 *iscsi_initiatorname*=<...>::
524 *iscsi_target*=<...>::
526 *iscsi_address*=<...>::
528 *iscsi_username*=<...>::
529 *iscsi_password*=<...>::
530 *iscsi_username_in*=<...>::
531 *iscsi_password_in*=<...>::
532 *iscsi_debug*=<...>::
534 Specify iSCSI parameters.
538 Enables/disables UnionFS.
541 Enables support for AUFS2 (if available in the kernel).
543 *real_rootflags*=<...>::
544 Additional flags to mount the real root system with.
545 For example *real_rootflags*=noatime would make "-o ro,noatime".
547 *real_resume*=<...>::
553 *cdroot_type*=<...>::
561 Loop-mount an ISO file from the boot device to get the filesystem image.
562 Useful with chain-loading environments and USB keys.
567 The initrd scripts have limited support for network booting. This is
568 activated if the *ip*=<...> kernel parameter was given. Please refer to
569 the genkernel guide at 'http://www.gentoo.org/doc/en/genkernel.xml' for
572 The initrd scripts will extract any *.tar.gz files found in the '/add'
573 directory of the livecd into the root filesystem during boot. This way
574 it is easy to extend a netbooted LiveCD i.e. add custom tools, or other
580 If you believe you have found a bug in the genkernel scripts, then
581 please file a bug on the Gentoo Linux Bugzilla against product
582 "Gentoo Hosted Projects" component "genkernel", i.e. at
583 'https://bugs.gentoo.org/enter_bug.cgi?product=Gentoo%20Hosted%20Projects&component=genkernel'.
585 If you're somewhat unsure if you hit a bug or not, file a bug an we'll find out together.
586 For general questions the is the gentoo-genkernel mailing list. You can join the list
587 by sending empty mail to 'gentoo-genkernel+subscribe@lists.gentoo.org'.
589 We cannot assist you with
590 kernel compilation failures unless they are caused by a genkernel bug.
592 Kernel issues for Gentoo-supported kernels, including compilation failures
593 should go to 'https://bugs.gentoo.org/' and should be assigned to 'kernel@gentoo.org'.
594 Please check if an existing bug documents the same
595 issue before opening a new bug. Issues for kernel sources not supported
596 by Gentoo should go to their relevant authors.
601 - Tim Yamin <plasmaroo@gentoo.org>
602 - Eric Edgar <rocket@gentoo.org>
603 - Chris Gianelloni <wolf31o2@gentoo.org>
604 - Sebastian Pipping <sebastian@pipping.org>
605 - NFS Support by Thomas Seiler <thseiler@gmail.com>
606 - GnuPG 1.x integration by dacook <schism@subverted.org>
607 - MDADM integration by Matthias Dahl <ua_bugz_gentoo@mortal-soul.de>
608 - ZFS integration by Richard Yao <ryao@cs.stonybrook.edu>
613 /etc/genkernel.conf - genkernel configuration file