From e8ba2f592dc0b9d994d50da5b7b9bb2ce316fabf Mon Sep 17 00:00:00 2001 From: Neil Horman Date: Feb 09 2007 21:09:34 +0000 Subject: Adding man page for mkdumprd --- diff --git a/kexec-tools.spec b/kexec-tools.spec index 852489e..ec4a13f 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -1,6 +1,6 @@ Name: kexec-tools Version: 1.101 -Release: 58%{?dist} +Release: 59%{?dist} License: GPL Group: Applications/System Summary: The kexec/kdump userspace component. @@ -16,6 +16,7 @@ Source8: kdump.conf Source9: makedumpfile-1.0.7.tar.gz Source10: kexec-kdump-howto.txt Source11: firstboot_kdump.py +Source12: mkdumprd.8 BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) Requires(pre): coreutils chkconfig sed Requires: busybox >= 1.2.0 @@ -159,6 +160,7 @@ install -m 755 %{SOURCE7} $RPM_BUILD_ROOT/sbin/mkdumprd install -m 755 %{SOURCE8} $RPM_BUILD_ROOT%{_sysconfdir}/kdump.conf install -m 644 kexec/kexec.8 $RPM_BUILD_ROOT%{_mandir}/man8/kexec.8 install -m 755 %{SOURCE11} $RPM_BUILD_ROOT%{_datadir}/kdump/firstboot_kdump.py +install -m 644 %{SOURCE12} $RPM_BUILD_ROOT%{_mandir}/man8/mkdumprd.8 %ifarch %{ix86} x86_64 ia64 ppc64 install -m 755 makedumpfile/makedumpfile $RPM_BUILD_ROOT/sbin/makedumpfile %endif @@ -217,13 +219,16 @@ rm -f %{_datadir}/firstboot/modules/firstboot_kdump.py %ifarch %{ix86} x86_64 %{_libdir}/kexec-tools/kexec_test %endif -%{_mandir}/man8/kexec.8* +%{_mandir}/man8/* %doc News %doc COPYING %doc TODO %doc kexec-kdump-howto.txt %changelog +* Fri Feb 09 2007 Neil Horman - 1.101-59%{dist} +- Adding mkdumprd man page to build + * Wed Jan 25 2007 Neil Horman - 1.101-58%{dist} - Updating kdump.init and mkdumprd with most recent RHEL5 fixes - Fixing BuildReq to require elfutils-devel-static diff --git a/mkdumprd.8 b/mkdumprd.8 new file mode 100644 index 0000000..28b55d2 --- /dev/null +++ b/mkdumprd.8 @@ -0,0 +1,117 @@ +.TH MKDUMRD 8 "Fri Feb 9 2007" +.SH NAME +mkdumprd \- creates initial ramdisk images for kdump crash recovery +.SH SYNOPSIS +\fBmkdumprd\fR [--version] [-v] [-f] + [--preload=\fImodule\fR] [--omit-scsi-modules] + [--omit-raid-modules] [--omit-lvm-modules] + [--with=\fImodule\fR] [--image-version] + [--fstab=\fIfstab\fR] [--nocompress] + [--builtin=\fImodule\fR] [--nopivot] + \fIimage\fR \fIkernel-version\fR + +.SH DESCRIPTION +\fBmkdumprd\fR creates an initial ram file system for use in conjunction with +the booting of a kernel within the kdump framework for crash recovery. +\fBmkdumprds\fR purpose is to create an initial ram filesystem capable of copying +the crashed systems vmcore image to a location specified in \fI/etc/kdump.conf + +Any module options specified in \fI/etc/modprobe.conf\fR are passed +to the modules as they are loaded by the initial ramdisk. + +\fBmkdumprd\fR interrogates the running system to understand what modules need to +be loaded in the initramfs (based on configuration retrieved from +\fI/etc/kdump.conf)\fR + +\fBmkdumprd\fR was origionally derived from the \fBmkinitrd\fR utility (hence +the simmilarity in option sets), however mkdumprds purpose and mission is +significantly different than that of \fBmkinitrd\fR. As such, while most of the +options still exist, and may work, they are largely vestigual at this point. +\fBmkdumprd\fR was not intended for casual use outside of the service +initialization script for the kdump utility, and should not be run manually. If +you require a custom kdump initramfs image, it is suggested that you use the +kdump service infrastrucutre to create one, and then manually unpack, modify and +repack the image. + + +.SH OPTIONS +.TP +\fB-\-builtin=\fR\fImodule\fR +Act as if \fImodule\fR is built into the kernel being used. \fBmkdumprd\fR +will not look for this module, and will not emit an error if it does not +exist. This option may be used multiple times. + +.TP +\fB-f\fR +Allows \fBmkdumprd\fR to overwrite an existing image file. + +.TP +\fB-\-fstab=\fR\fIfstab\fR +Use \fIfstab\fR to automatically determine what type of filesystem the +root device is on. Normally, \fB/etc/fstab\fR is used. + +.TP +\fB-\-image-version +The kernel version number is appended to the initrd image path before the image +is created. + +.TP +\fB-\-nocompress +Normally the created initrd image is compressed with \fBgzip\fR. If this +option is specified, the compression is skipped. + +.TP +\fB-\-nopivot +Do not use the \fBpivot_root\fR system call as part of the initrd. This +lets \fBmkdumprd\fR build proper images for Linux 2.2 kernels at the expense +of some features. In particular, some filesystems (such as ext3) will not +work properly and filesystem options will not be used to mount root. This +option is not recommended, and will be removed in future versions. + +.TP +\fB-\-omit-lvm-modules +Do not load any lvm modules, even if /etc/fstab expects them. + +.TP +\fB-\-omit-raid-modules +Do not load any raid modules, even if /etc/fstab and /etc/raidtab expect them. + +.TP +\fB-\-omit-scsi-modules +Do not load any scsi modules, including 'scsi_mod' and 'sd_mod' +modules, even if they are present. + +.TP +\fB-\-preload=\fR\fImodule\fR +Load the module \fImodule\fR in the initial ramdisk image. The module gets +loaded before any SCSI modules which are specified in \fI/etc/modprobe.conf\fR. +This option may be used as many times as necessary. + +.TP +\fB-v\fR +Prints out verbose information while creating the image (normally +the \fBmkdumprd\fR runs silently). + +.TP +\fB-\-version\fR +Prints the version of \fBmkdumprd\fR that's being used and then exits. + +.TP +\fB-\-with=\fR\fImodule\fR +Load the modules \fImodule\fR in the initial ramdisk image. The module +gets loaded after any SCSI modules which are specified in +\fI/etc/modprobe.conf\fR. This option may be used as many times as +necessary. + +.SH FILES +.PD 0 + +.TP 20 +\fI/etc/modprobe.conf\fR +Specifies modules to be loaded and module options to be used. + +.PD +.SH "SEE ALSO" +.BR fstab (5), +.BR insmod (1) +.BR mkinitrd (8)