rpms/kexec-tools
7
0
Fork 0
Code Issues Pull Requests Releases Activity

add man documentation for kdumpctl get-default-crashkernel

Browse Source 
A few typos and grammar issues are fixed as well.

Philipp Rudo <prudo@redhat.com>

Signed-off-by: Coiby Xu <coxu@redhat.com>
This commit is contained in:
Coiby Xu 2022-03-01 17:35:39 +08:00
parent 3d4cb38d96
commit a1c63fa644
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
kdumpctl.8
View File

@ -14,7 +14,7 @@ In most cases, you should use
.B systemctl .B systemctl
to start / stop / enable kdump service instead. However, to start / stop / enable kdump service instead. However,
.B kdumpctl .B kdumpctl
provides more details for debug and a helper to setup ssh key authentication. provides more details for debugging and a helper to set up ssh key authentication.
.SH COMMANDS .SH COMMANDS
.TP .TP
@ -26,14 +26,14 @@ Stop the service.
.TP .TP
.I status .I status
Prints the current status of kdump service. Prints the current status of kdump service.
It returns non-zero value if kdump is not operational. It returns a non-zero value if kdump is not operational.
.TP .TP
.I restart .I restart
Is equal to Is equal to
.I start; stop .I start; stop
.TP .TP
.I reload .I reload
reload crash kernel image and initramfs without triggering a rebuild. reload the crash kernel image and initramfs without triggering a rebuild.
.TP .TP
.I rebuild .I rebuild
rebuild the crash kernel initramfs. rebuild the crash kernel initramfs.
@ -43,20 +43,23 @@ Helps to setup key authentication for ssh storage since it's
impossible to use password authentication during kdump. impossible to use password authentication during kdump.
.TP .TP
.I showmem .I showmem
Prints the size of reserved memory for crash kernel in megabytes. Prints the size of reserved memory for the crash kernel in megabytes.
.TP .TP
.I estimate .I estimate
Estimate a suitable crashkernel value for current machine. This is a Estimate a suitable crashkernel value for the current machine. This is a
best-effort estimate. It will print a recommanded crashkernel value best-effort estimate. It will print a recommended crashkernel value
based on current kdump setup, and list some details of memory usage. based on the current kdump setup, and list some details of memory usage.
.TP
.I get-default-crashkernel
Return the default crashkernel value provided by kexec-tools.
.TP .TP
.I reset-crashkernel [--kernel=path_to_kernel] [--reboot] .I reset-crashkernel [--kernel=path_to_kernel] [--reboot]
Reset crashkernel to default value recommended by kexec-tools. If no kernel Reset crashkernel to default value recommended by kexec-tools. If no kernel
is specified, will reset KDUMP_KERNELVER if it's defined in /etc/sysconfig/kdump is specified, will reset KDUMP_KERNELVER if it's defined in /etc/sysconfig/kdump
or current running kernel's crashkernel value if KDUMP_KERNELVER is empty. You can or the current running kernel's crashkernel value if KDUMP_KERNELVER is empty. You can
also specify --kernel=ALL and --kernel=DEFAULT which have the same meaning as also specify --kernel=ALL and --kernel=DEFAULT which have the same meaning as
grubby's kernel-path=ALL and kernel-path=DEFAULT. ppc64le supports FADump and grubby's kernel-path=ALL and kernel-path=DEFAULT. ppc64le supports FADump and
supports an additonal [--fadump=[on|off|nocma]] parameter to toggle FADump supports an additional [--fadump=[on|off|nocma]] parameter to toggle FADump
on/off. on/off.
Note: The memory requirements for kdump varies heavily depending on the Note: The memory requirements for kdump varies heavily depending on the