From 3b439fb64d8d65b0c09aa8452bf0181ec20f8bcf Mon Sep 17 00:00:00 2001 From: Jose Castillo Date: Wed, 3 Mar 2021 13:03:16 +0100 Subject: [PATCH] [man] Multiple fixes in man pages This patch fixes references to sosreport, to the preferred 'sos report'. Also adds "SEE ALSO" consistently for all man pages, and fixes a MAINTAINER line. Resolves: #2432 Signed-off-by: Jose Castillo Signed-off-by: Jake Hunsaker --- man/en/sos-clean.1 | 5 +++++ man/en/sos-collect.1 | 1 + man/en/sos-report.1 | 22 ++++++++++++++-------- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1 index 0c62ed07..d64a0ec7 100644 --- a/man/en/sos-clean.1 +++ b/man/en/sos-clean.1 @@ -77,6 +77,11 @@ Default: 4 .TP .B \-\-no-update Do not write the mapping file contents to /etc/sos/cleaner/default_mapping +.SH SEE ALSO +.BR sos (1) +.BR sos-report (1) +.BR sos-collect (1) + .SH MAINTAINER .nf Jake Hunsaker diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1 index d4e5e648..da36542d 100644 --- a/man/en/sos-collect.1 +++ b/man/en/sos-collect.1 @@ -330,6 +330,7 @@ Sosreport option. Override the default compression type. .SH SEE ALSO .BR sos (1) .BR sos-report (1) +.BR sos-clean (1) .SH MAINTAINER Jake Hunsaker diff --git a/man/en/sos-report.1 b/man/en/sos-report.1 index e7fae97b..81005959 100644 --- a/man/en/sos-report.1 +++ b/man/en/sos-report.1 @@ -38,11 +38,12 @@ sosreport \- Collect and package diagnostic and support data [-h|--help]\fR .SH DESCRIPTION -\fBsosreport\fR generates an archive of configuration and diagnostic -information from the running system. The archive may be stored locally -or centrally for recording or tracking purposes or may be sent to -technical support representatives, developers or system administrators -to assist with technical fault-finding and debugging. +\fBreport\fR is an sos subcommand that generates an archive of +configuration and diagnostic information from the running system. +The archive may be stored locally or centrally for recording or +tracking purposes or may be sent to technical support representatives, +developers or system administrators to assist with technical +fault-finding and debugging. .LP Sos is modular in design and is able to collect data from a wide range of subsystems and packages that may be installed. An @@ -110,8 +111,8 @@ User defined presets are saved under /var/lib/sos/presets as JSON-formatted file .B \--add-preset ADD_PRESET [options] Add a preset with name ADD_PRESET that enables [options] when called. -For example, 'sosreport --add-preset mypreset --log-size=50 -n logs' will enable -a user to run 'sosreport --preset mypreset' that sets the maximum log size to +For example, 'sos report --add-preset mypreset --log-size=50 -n logs' will enable +a user to run 'sos report --preset mypreset' that sets the maximum log size to 50 and disables the logs plugin. Note: to set a description for the preset that is displayed with \fB--list-presets\fR, @@ -343,9 +344,14 @@ been tested for this port or may still be under active development. .TP .B \--help Display usage message. +.SH SEE ALSO +.BR sos (1) +.BR sos-clean (1) +.BR sos-collect (1) + .SH MAINTAINER .nf -Bryn M. Reeves +Jake Hunsaker .fi .SH AUTHORS & CONTRIBUTORS See \fBAUTHORS\fR file in the package documentation. -- 2.26.3