From b5389aa195675f473acdd22f20017a8854ff82d0 Mon Sep 17 00:00:00 2001 From: Pavel Moravec Date: Wed, 16 Feb 2022 08:43:32 +0100 Subject: [PATCH] [man] Mention sos-help in main sos manpage Related to #2860 Signed-off-by: Pavel Moravec --- man/en/sos.1 | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/man/en/sos.1 b/man/en/sos.1 index ce4918f99..c335b7e10 100644 --- a/man/en/sos.1 +++ b/man/en/sos.1 @@ -67,6 +67,14 @@ May be invoked via either \fBsos clean\fR, \fBsos cleaner\fR, \fBsos mask\fR, or via the \fB--clean\fR, \fB--cleaner\fR or \fB --mask\fR options for \fBreport\fR and \fBcollect\fR. +.TP +.B help +This subcommand is used to retrieve more detailed information on the various SoS +commands and components than is directly available in either other manpages or +--help output. + +See \fB sos help --help\fR and \fB man sos-help\fR for more information. + .SH GLOBAL OPTIONS sos components provide their own set of options, however the following are available to be set across all components. From ac4eb48fa35c13b99ada41540831412480babf8d Mon Sep 17 00:00:00 2001 From: Pavel Moravec Date: Wed, 16 Feb 2022 08:44:16 +0100 Subject: [PATCH] [setup] Add sos-help to build process Resolves: #2860 Closes: #2861 Signed-off-by: Pavel Moravec --- setup.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 25e87a71b..8db8641f0 100644 --- a/setup.py +++ b/setup.py @@ -90,7 +90,7 @@ def copy_file (self, filename, dirname): ('share/man/man1', ['man/en/sosreport.1', 'man/en/sos-report.1', 'man/en/sos.1', 'man/en/sos-collect.1', 'man/en/sos-collector.1', 'man/en/sos-clean.1', - 'man/en/sos-mask.1']), + 'man/en/sos-mask.1', 'man/en/sos-help.1']), ('share/man/man5', ['man/en/sos.conf.5']), ('share/licenses/sos', ['LICENSE']), ('share/doc/sos', ['AUTHORS', 'README.md']), @@ -102,7 +102,8 @@ def copy_file (self, filename, dirname): 'sos.policies.package_managers', 'sos.policies.init_systems', 'sos.report', 'sos.report.plugins', 'sos.collector', 'sos.collector.clusters', 'sos.collector.transports', 'sos.cleaner', - 'sos.cleaner.mappings', 'sos.cleaner.parsers', 'sos.cleaner.archives' + 'sos.cleaner.mappings', 'sos.cleaner.parsers', 'sos.cleaner.archives', + 'sos.help' ], cmdclass=cmdclass, command_options=command_options,