It has been complained that kdumpctl does not have a documentation. This patch adds a simple man page for kdumpctl.
Signed-off-by: Dangyi Liu dliu@redhat.com --- kdumpctl.8 | 35 +++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 kdumpctl.8
diff --git a/kdumpctl.8 b/kdumpctl.8 new file mode 100644 index 0000000..2c30b7c --- /dev/null +++ b/kdumpctl.8 @@ -0,0 +1,35 @@ +.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. + +Available commands are +.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" +kdump.conf(5) diff --git a/kexec-tools.spec b/kexec-tools.spec index cf37727..f7dc2b4 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh Source23: kdump-anaconda-addon-005-10-gd16915f.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
Ccing Dave and Vivek, see if they have any comments about patch especially english language problem.
On 07/13/15 at 04:28pm, Dangyi Liu wrote:
It has been complained that kdumpctl does not have a documentation. This patch adds a simple man page for kdumpctl.
Signed-off-by: Dangyi Liu dliu@redhat.com
kdumpctl.8 | 35 +++++++++++++++++++++++++++++++++++ kexec-tools.spec | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 kdumpctl.8
diff --git a/kdumpctl.8 b/kdumpctl.8 new file mode 100644 index 0000000..2c30b7c --- /dev/null +++ b/kdumpctl.8 @@ -0,0 +1,35 @@ +.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.
+Available commands are +.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" +kdump.conf(5)
Add a mkdumprd in "SEE ALSO" should be good.
BTW, could you add notes that systemd service will call kdumpctl automaticlly in case the service is enabled. and one can use systemctl starti/stop kdump as well. But systemctl only know start/stop/restart, it does not recogonize propagate etc.
diff --git a/kexec-tools.spec b/kexec-tools.spec index cf37727..f7dc2b4 100644 --- a/kexec-tools.spec +++ b/kexec-tools.spec @@ -27,6 +27,7 @@ Source22: kdump-dep-generator.sh Source23: kdump-anaconda-addon-005-10-gd16915f.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
kexec mailing list kexec@lists.fedoraproject.org https://lists.fedoraproject.org/mailman/listinfo/kexec
-
Dangyi Liu -
Dave Young