summaryrefslogtreecommitdiffstats
path: root/mkinitcpio.5.txt
diff options
context:
space:
mode:
authorDave Reisner <dreisner@archlinux.org>2011-07-03 19:03:11 +0200
committerDave Reisner <dreisner@archlinux.org>2011-07-04 22:11:57 +0200
commitb8b732767c7ab18cbf041c61726d2c3c180f62ea (patch)
treed50452a40cf303604fc8c30ba435ceca74e45e8a /mkinitcpio.5.txt
parent9f52967775555a4bdae74db0918c929eb50ad5fe (diff)
downloadmkinitcpio-b8b732767c7ab18cbf041c61726d2c3c180f62ea.tar.gz
mkinitcpio-b8b732767c7ab18cbf041c61726d2c3c180f62ea.tar.xz
manpage: clarify behaviors, add example, fix typos
I've neglected to do this along the way and some options, such as -k or -p now have additional behaviors that should be made known. Now that basedir support is legit, add an example showing a possible invocation. Signed-off-by: Dave Reisner <dreisner@archlinux.org>
Diffstat (limited to 'mkinitcpio.5.txt')
-rw-r--r--mkinitcpio.5.txt18
1 files changed, 13 insertions, 5 deletions
diff --git a/mkinitcpio.5.txt b/mkinitcpio.5.txt
index bfa1c9f..f963dac 100644
--- a/mkinitcpio.5.txt
+++ b/mkinitcpio.5.txt
@@ -36,13 +36,15 @@ Options
written to the filesystem unless this option is specified.
*-H* 'hookname'::
- Output help for hookname 'hookname'
+ Output help for hookname 'hookname'.
*-h*::
Output a short overview of available command-line switches.
*-k* 'kernelversion'::
- Use 'kernelversion'. Default is the current running kernel.
+ Use 'kernelversion', instead of the current running kernel. This may be a
+ path to a kernel image or a specific kernel version. If specified as a path to
+ an image, this will always be prefixed by the 'basedir'.
*-L*::
List all available hooks.
@@ -56,8 +58,9 @@ Options
Disable color output.
*-p* 'preset'::
- Build initial ramdisk according to specified 'preset'. Presets are found in
- /etc/mkinitcpio.d
+ Build initramfs image(s) according to specified 'preset'. This may be a file in
+ /etc/mkinitcpio.d (without the .preset extension) or a full, absolute path to a
+ file.
*-S* 'hooks'::
Skip 'hooks' when generating the image. Several hooks should be comma-separated.
@@ -113,6 +116,11 @@ Examples
*mkinitcpio -p kernel26*::
Create an initial ramdisk based on the 'kernel26' preset.
+*mkinitcpio -b /mnt -g /mnt/boot/kernel26.img -k /boot/vmlinuz26*::
+ Create an initial ramdisk for the root at /mnt, with the kernel at
+ /mnt/boot/vmlinuz26. The resulting image will be written to
+ /mnt/boot/kernel26.img.
+
See also
--------
A more thorough article on configuring mkinitcpio:
@@ -127,7 +135,7 @@ Upon writing this manpage, there were no noticeable bugs present. Please visit
Authors
-------
-mkinitcpio created by the Arch Linux Developer community.
+mkinitcpio is created by the Arch Linux Developer community.
Manpage written by:::
* Glenn 'RedShift' Matthys <glenn@opengate.be>