[PATCH v3] kdumpctl: Add man page for kdumpctl

Dangyi Liu dliu at redhat.com
Tue Aug 18 04:59:32 UTC 2015


kdumpctl is useful sometimes when users want to debug or setup ssh key
authentication. So add a man page for it.

Signed-off-by: Dangyi Liu <dliu at redhat.com>
---
v2->v3:
	Trivial grammar fix

v1->v2:
	Suggestion to use systemctl instead of kdumpctl
	Add mkdumprd to "SEE ALSO"

 kdumpctl.8       | 41 +++++++++++++++++++++++++++++++++++++++++
 kexec-tools.spec |  2 ++
 2 files changed, 43 insertions(+)
 create mode 100644 kdumpctl.8

diff --git a/kdumpctl.8 b/kdumpctl.8
new file mode 100644
index 0000000..b446b81
--- /dev/null
+++ b/kdumpctl.8
@@ -0,0 +1,41 @@
+.TH KDUMPCTL 8 2015-07-13 kexec-tools
+
+.SH NAME
+kdumpctl \- control interface for kdump
+
+.SH SYNOPSIS
+.B kdumpctl
+.I COMMAND
+
+.SH DESCRIPTION
+.B kdumpctl
+is used to check or control the kdump service.
+In most cases, you should use
+.B systemctl
+to start / stop / enable kdump service instead. However,
+.B kdumpctl
+provides more details for debug and a helper to setup ssh key authentication.
+
+.SH COMMANDS
+.TP
+.I start
+Start the service.
+.TP
+.I stop
+Stop the service.
+.TP
+.I status
+Prints the current status of kdump service.
+It returns non-zero value if kdump is not operational.
+.TP
+.I restart
+Is equal to
+.I start; stop
+.TP
+.I propagate
+Helps to setup key authentication for ssh storage since it's
+impossible to use password authentication during kdump.
+
+.SH "SEE ALSO"
+.BR kdump.conf (5),
+.BR mkdumprd (8)
diff --git a/kexec-tools.spec b/kexec-tools.spec
index a2e39f8..5b99c83 100644
--- a/kexec-tools.spec
+++ b/kexec-tools.spec
@@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh
 Source23: kdump-anaconda-addon-005-12-g60fa4c1.tar.gz
 Source24: kdump-lib-initramfs.sh
 Source25: kdump.sysconfig.ppc64le
+Source26: kdumpctl.8
 
 #######################################
 # These are sources for mkdumpramfs
@@ -159,6 +160,7 @@ install -m 755 %{SOURCE7} $RPM_BUILD_ROOT/sbin/mkdumprd
 install -m 644 %{SOURCE8} $RPM_BUILD_ROOT%{_sysconfdir}/kdump.conf
 install -m 644 kexec/kexec.8 $RPM_BUILD_ROOT%{_mandir}/man8/kexec.8
 install -m 644 %{SOURCE12} $RPM_BUILD_ROOT%{_mandir}/man8/mkdumprd.8
+install -m 644 %{SOURCE26} $RPM_BUILD_ROOT%{_mandir}/man8/kdumpctl.8
 install -m 755 %{SOURCE20} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib.sh
 install -m 755 %{SOURCE24} $RPM_BUILD_ROOT%{_prefix}/lib/kdump/kdump-lib-initramfs.sh
 %ifnarch s390x
-- 
2.4.3



More information about the kexec mailing list