aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorPavel Moravec <pmoravec@redhat.com>2021-06-13 19:16:47 +0200
committerJake Hunsaker <jhunsake@redhat.com>2021-06-14 09:24:03 -0400
commit34d997ebaea769b31e577526613e3e9ccb0893f8 (patch)
treec0cd777dcb7470dce990e400fb4d7e5aad50a95d /man
parent8ed7f525ef3b603f901f5d0aa1285bb3f6fd66a8 (diff)
downloadsos-34d997ebaea769b31e577526613e3e9ccb0893f8.tar.gz
[man] unify some syntax in manpages
Unify capitalisation of name and synopsis. Add references to sos.conf to SEE ALSO of all binaries. Resolves: #2581 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-clean.11
-rw-r--r--man/en/sos-collect.13
-rw-r--r--man/en/sos-report.17
-rw-r--r--man/en/sos.12
4 files changed, 9 insertions, 4 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
index d64a0ec7..4856b43b 100644
--- a/man/en/sos-clean.1
+++ b/man/en/sos-clean.1
@@ -81,6 +81,7 @@ Do not write the mapping file contents to /etc/sos/cleaner/default_mapping
.BR sos (1)
.BR sos-report (1)
.BR sos-collect (1)
+.BR sos.conf (5)
.SH MAINTAINER
.nf
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index cdbc3257..e0e23504 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -1,4 +1,4 @@
-.TH sos collect 1 "April 2020"
+.TH SOS COLLECT 1 "April 2020"
.SH NAME
sos collect \- Collect sosreports from multiple (cluster) nodes
@@ -374,6 +374,7 @@ Sosreport option. Override the default compression type.
.BR sos (1)
.BR sos-report (1)
.BR sos-clean (1)
+.BR sos.conf (5)
.SH MAINTAINER
Jake Hunsaker <jhunsake@redhat.com>
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
index 799defaf..f6bd6c6a 100644
--- a/man/en/sos-report.1
+++ b/man/en/sos-report.1
@@ -1,8 +1,8 @@
-.TH SOSREPORT 1 "Mon Mar 25 2013"
+.TH SOS REPORT 1 "Mon Mar 25 2013"
.SH NAME
-sosreport \- Collect and package diagnostic and support data
+sos report \- Collect and package diagnostic and support data
.SH SYNOPSIS
-.B sosreport
+.B sos report
[-l|--list-plugins]\fR
[-n|--skip-plugins plugin-names]\fR
[-e|--enable-plugins plugin-names]\fR
@@ -409,6 +409,7 @@ Display usage message.
.BR sos (1)
.BR sos-clean (1)
.BR sos-collect (1)
+.BR sos.conf (5)
.SH MAINTAINER
.nf
diff --git a/man/en/sos.1 b/man/en/sos.1
index 473c0551..79f9a130 100644
--- a/man/en/sos.1
+++ b/man/en/sos.1
@@ -133,6 +133,8 @@ Compression type to use when compression the final archive output
.TP
.B \--help
Display usage message.
+.SH SEE ALSO
+.BR sos.conf (5)
.SH MAINTAINER
.nf
Jake Hunsaker <jhunsake@redhat.com>