docs: Update man page from output of --help

cleanup-cruft
Sebastian Pipping 14 years ago
parent f7b9189d2a
commit 56e84886c6

@ -5,6 +5,9 @@
# Distributed under the GPL v2 # Distributed under the GPL v2
# $Id$ # $Id$
13 Dec 2010; <sping@gentoo.org> doc/genkernel.8.txt:
docs: Update man page from output of --help
13 Dec 2010; <sping@gentoo.org> doc/genkernel.8.txt: 13 Dec 2010; <sping@gentoo.org> doc/genkernel.8.txt:
docs: Document keymap= and dokeymap (bug #346017) docs: Document keymap= and dokeymap (bug #346017)

@ -65,6 +65,12 @@ Certain options have *--no-* variants which do the opposite thing.
You can specify your options in any order. You can specify your options in any order.
CONFIGURATION OPTIONS
~~~~~~~~~~~~~~~~~~~~~
*--config*=<file>::
Genkernel configuration file to use
DEBUGGING OPTIONS DEBUGGING OPTIONS
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
*--loglevel*=<0-5>:: *--loglevel*=<0-5>::
@ -128,16 +134,29 @@ KERNEL COMPILATION
NOTE: Specifying *--symlink* does nothing unless NOTE: Specifying *--symlink* does nothing unless
*--install* is also specified. *--install* is also specified.
*--oldconfig*::
Implies *--no-clean*, and thus *--no-mrproper*, running a "make oldconfig".
*--gensplash*::
Install framebuffer splash support into initramfs.
*--*[*no-*]*splash*::
Installs, or not, framebuffer splash support into initramfs.
*--no-ramdisk-modules*:: *--no-ramdisk-modules*::
Don't copy any modules to the ramdisk. Don't copy any modules to the ramdisk.
*--oldconfig*:: *--all-ramdisk-modules*::
Implies *--no-clean*, and thus *--no-mrproper*, running a "make oldconfig". Copy all kernel modules to the initrd.
*--callback*=<...>:: *--callback*=<...>::
Run the specified arguments in the current environment after the Run the specified arguments in the current environment after the
kernel and modules have been compiled. kernel and modules have been compiled.
*--static*::
This builds a monolithic kernel without any modules on any
initial ramdisks.
KERNEL LOCATIONS KERNEL LOCATIONS
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -151,6 +170,10 @@ KERNEL LOCATIONS
build of the same kernel version or a default kernel config if build of the same kernel version or a default kernel config if
there isn't a previous config. there isn't a previous config.
*--module-prefix*=<dir>::
Prefix to kernel module destination, modules will be installed in
'<prefix>/lib/modules'.
LOW-LEVEL COMPILATION OPTIONS LOW-LEVEL COMPILATION OPTIONS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -163,6 +186,9 @@ LOW-LEVEL COMPILATION OPTIONS
*--kernel-ld*=<linker>:: *--kernel-ld*=<linker>::
Linker to use for the kernel compilation. Linker to use for the kernel compilation.
*--kernel-cross-compile*=<cross var>::
CROSS_COMPILE kernel variable.
*--kernel-make*=<makeprg>:: *--kernel-make*=<makeprg>::
GNU Make to use for the kernel compilation. GNU Make to use for the kernel compilation.
@ -178,12 +204,30 @@ LOW-LEVEL COMPILATION OPTIONS
*--utils-make*=<makeprog>:: *--utils-make*=<makeprog>::
GNU Make to use for utilities. GNU Make to use for utilities.
*--utils-cross-compile*=<cross var>::
CROSS_COMPILE utils variable.
*--utils-arch*=<arch>::
Force to arch for utils only instead of autodetect.
*--*[*no-*]*mountboot*::
Mount, or not, BOOTDIR automatically if mountable.
*--bootdir*=<dir>::
Set the location of the boot-directory, default is '/boot'.
*--makeopts*=<makeopts>:: *--makeopts*=<makeopts>::
GNU Make options such as -j2, etc. GNU Make options such as -j2, etc.
INITIALIZATION INITIALIZATION
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
*--gensplash*=<theme>::
Enable framebuffer splash using <theme>.
*--gensplash-res*=<resolutions>::
Select gensplash resolutions to include.
*--*[*no-*]*splash*=<theme>:: *--*[*no-*]*splash*=<theme>::
If the extra argument is specified, splash is forced using If the extra argument is specified, splash is forced using
<theme> rather than the default theme specified in your splash <theme> rather than the default theme specified in your splash
@ -195,28 +239,62 @@ INITIALIZATION
*--do-keymap-auto*:: *--do-keymap-auto*::
Force keymap selection at boot. Force keymap selection at boot.
*--dmraid*:: *--no-keymap*::
Add DMRAID support. Disables keymap selection at boot.
*--evms*:: *--evms*::
Add in EVMS support from static binaries if they exist on the *--evms2*::
system: you should run "emerge evms" first. Add in EVMS support from static binaries if they exist on the system:
you should run "emerge evms" first (in the host system).
*--lvm*:: *--lvm*::
*--lvm2*::
Add in LVM support from static binaries if they exist on the Add in LVM support from static binaries if they exist on the
system, or compile static LVM binaries if static ones do not system, or compile static LVM binaries if static ones do not
exist. exist.
*--mdadm*::
Copy '/etc/mdadm.conf' to initramfs.
*--dmraid*::
Add DMRAID support.
*--multipath*::
Include Multipath support
*--iscsi*::
Include iSCSI support
*--slowusb*::
Enables extra pauses for slow USB CD boots.
*--bootloader*=*grub*::
Add new kernel to GRUB configuration.
*--linuxrc*=<file>::
Use <file> for the linuxrc instead of the genkernel linuxrc.
*--busybox-config*=<file>::
Specifies a user created busybox config.
*--disklabel*::
Include disk label and uuid support in your initrd.
*--luks*:: *--luks*::
Add in Luks support from static binaries if they exist on the Add in Luks support from static binaries if they exist on the
system. system.
*--static*:: *--no-busybox*::
This builds a monolithic kernel without any modules on any Do not include busybox in the initrd or initramfs.
initial ramdisks.
*--linuxrc*=<file>:: *--unionfs*::
Use <file> for the linuxrc instead of the genkernel linuxrc. Include support for unionfs
*--netboot*::
Create a self-contained env in the initramfs
*--real-root*=<foo>::
Specify a default for *real_root*= kernel option.
INTERNALS INTERNALS
@ -225,9 +303,15 @@ INTERNALS
Force the architecture settings described by the <arch> profile Force the architecture settings described by the <arch> profile
instead of autodetecting the running architecture. instead of autodetecting the running architecture.
*--cachedir*=<dir>::
Override the default cache location.
*--tempdir*=<dir>:: *--tempdir*=<dir>::
Sets genkernel's temporary working directory to <dir>. Sets genkernel's temporary working directory to <dir>.
*--postclear*::
Clear all tmp files and caches after genkernel has run.
OUTPUT SETTINGS OUTPUT SETTINGS
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -256,6 +340,19 @@ OUTPUT SETTINGS
Directory structure to include in the initramfs, only available Directory structure to include in the initramfs, only available
on 2.6 kernels on 2.6 kernels
*--firmware*::
Enable copying of firmware into initramfs.
*--firmware-dir*=<dir>::
Specify directory to copy firmware from (defaults to '/lib/firmware').
*--firmware-files*=<files>::
Specifies specific firmware files to copy. This overrides *--firmware-dir*.
For multiple files, separate the filenames with a comma.
*--integrated-initramfs*::
Build the generated initramfs into the kernel instead of keeping it as a separate file.
RAMDISK OPTIONS RAMDISK OPTIONS
--------------- ---------------

Loading…
Cancel
Save