aboutsummaryrefslogtreecommitdiffstats
path: root/man/en
Commit message (Collapse)AuthorAgeFilesLines
* [collector] Passthru --threads, replace with --jobs for collectJake Hunsaker2020-04-221-6/+15
| | | | | | | | | | Replaces the previous `--threads` option in collect with a `--jobs` option to determine the number of concurrent collections to run. Uses `--threads` as a passthru option now if the node supports it (sos-3.6+), in an effort to unify option meanings between components. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [options] Rename insecure-sudo to nopasswd-sudoJake Hunsaker2020-04-221-2/+2
| | | | Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Add general sos manpage, rename sosreport.1, add symlinksJake Hunsaker2020-04-224-334/+418
| | | | | | | | | | | | Adds a general manpage for the sos command that then points to the available components. Renames sosreport.1 to sos-report.1 to match the component style, and then symlinks sosreport.1 to it. Adds a symlink from sos-collector.1 to sos-collect.1. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Add manpage for sos collectJake Hunsaker2020-04-221-0/+312
| | | | | | | | | | Adds the manpage from sos-collector to the tree as 'sos-collect', and updates the instances of 'sos-collector' to 'sos collect' within the manpage. Additionally updates the man page to include newly available options. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Update manpage for --upload and related optionsJake Hunsaker2020-02-141-0/+56
| | | | | | | Adds manage entries for the various --upload options added as part of the previous patches adding upload functionality. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [Plugin] Allow selectively disabling postprocessingJake Hunsaker2020-01-281-0/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds two mechanisms by which users can choose to disable postprocessing of collected information. First, is a global method exposed via the `--no-postproc` option. Using this option will skip postprocessing for all plugins. Second, is a per-plugin option exposed via a new 'postproc' plugin option. This is set to _True_ by default (meaning yes, perform postprocessing), which users can set to False or off to disable postprocessing for that plugin only; e.g. `-k podman.postproc=off` Closes: #286 Resolves: #1862 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
| * [Plugin] Allow selectively disabling postprocessingJake Hunsaker2019-11-191-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds two mechanisms by which users can choose to disable postprocessing of collected information. First, is a global method exposed via the `--no-postproc` option. Using this option will skip postprocessing for all plugins. Second, is a per-plugin option exposed via a new 'postproc' plugin option. This is set to _True_ by default (meaning yes, perform postprocessing), which users can set to False or off to disable postprocessing for that plugin only; e.g. `-k podman.postproc=off` Closes: #286 Resolves: #1862 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* | [plugins] improve heuristic for applying --since to logarchivesPavel Moravec2019-12-111-2/+5
|/ | | | | | | | | | | | logarchive_pattern treats some configs (e.g. /etc/dbus-1) as log archives, causing --since option will skip collecting them. This patch just improves the heuristic by claiming nothing under /etc is a logarchive, and adds a warning to sosreport help. Improves: #1847 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [man] describe --allow-system-changes (#1850)Pavel Moravec2019-11-121-0/+4
| | | | | | | | | In #1435, --allow-system-changes option was added that is documented in sosreport --help but not in manpages. Resolves: #1850 Signed-off-by: Pavel Moravec <pmoravec@redhat.com> Signed-off-by: Bryan Quigley <bryan.quigley@canonical.com>
* [man] remove obolete references to XML reportsPavel Moravec2019-08-251-3/+3
| | | | | | | | | As XML reports were removed from sos, manpages should not refer to them further. Resolves: #1669 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [manpages] describe --note optionPavel Moravec2019-08-251-1/+3
| | | | | | Resolves: #1724 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [sosreport] grab logs since datePavel Moravec2019-08-251-0/+5
| | | | | | | | | | | | Adds a --since switch that takes a date as an argument. This switch will skip the archive files with a mtime older than the date. Also, --since affects journalctl execution for --all. Resolves: #1678 Signed-off-by: David Vallee Delisle <dvd@redhat.com> Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [sosreport] update sos.conf manpages by [general] section descriptionPavel Moravec2019-04-301-4/+34
| | | | | | | | | Since PR #1530, sosreport supports all command line options. Man pages should document the enhancement. Resolves: #1652 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [man] add --dry-run to sosreport.1Bryn M. Reeves2019-03-221-3/+9
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [manpages] Fix path for docs in /usr/share/docJose Castillo2019-03-191-1/+1
| | | | | | | | | | | | | | | | In the Makefile we have specified the path for sosreport docs as: install -m644 AUTHORS README.md $(DESTDIR)/usr/share/$(NAME)/. And NAME is 'sos'. But in the manpage we have the path as /usr/share/doc/sosreport. This fix removes the path and directs to the package documentation. Fixes: #1531 Resolves: #1532 Signed-off-by: Jose Castillo <jose.mfcastillo@gmail.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [man] Update manpage for presetsJake Hunsaker2019-03-191-0/+33
| | | | | | | | | | | | | The manpage for sosreport was previously missing documentation for the new preset feature in 3.6. This updates the manpage to include entries for add-preset, del-preset, list-presets, and the --desc options. Resolves: #1479 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Allow user-controllable plugin timeoutsJake Hunsaker2019-03-121-0/+13
| | | | | | | | | | | | | | | | | | | | Allows users to specify a timeout for each plugin using the '-k plugin.timeout=value' syntax by adding the 'timeout' option to every plugin. Additionally, adds the --plugin-timeout option to set a timeout for _all_ plugins. If --plugin-timeout and a specific -k timeout option is provided, the -k timeout option will be applied for those specific plugins, with --plugin-timeout being applied to all others. In either case, specifying a timeout of 0 seconds results in no timeout being applied. In the event that an invalid timeout is set, the timeout will be set to the default value for the plugin. Resolves: #1499 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Add mechanism to encrypt final archiveJake Hunsaker2018-07-121-0/+28
| | | | | | | | | | | | | | | | | | | | | Adds an option to encrypt the resulting archive that sos generates. There are two methods for doing so: --encrypt-key Uses a key-pair for asymmetric encryption --encrypt-pass Uses a password for symmetric encryption For key-pair encryption, the key-to-be-used must be imported into the root user's keyring, as gpg does not allow for the use of keyfiles. If the encryption process fails, sos will not abort as the unencrypted archive will have already been created. The assumption being that the archive is still of use and/or the user has another means of encrypting it. Resolves: #1320 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Concurrently run pluginsJake Hunsaker2018-06-061-0/+4
| | | | | | | | | | | | | | | | | | | | | Changes sos to run plugins concurrently. By default sos will now use four (4) threads to run plugins, allowing for faster overall execution of sosreport. The number of threads can be changed using the --threads commandline option. Plugins now also have a timeout applied to them as a whole to avoid situations where sosreport appears to be hung. If a plugin exceeds the timeout threshold, the plugin will be terminated immediately. - this allows sos to not only continue running normally, but should still allow for collection of commands run by the plugin up until it was terminated. The timeout is plugin controlled, and defaults to 300 seconds if not set. Note that for python2 environments, this adds a dependency on python-futures. The futures module is present in the standard library for python3 environments. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [sosreport] Allow policies to change report name generationJake Hunsaker2018-04-171-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This changes the way sos generates the name for the final archive. Policies may now control the naming pattern by changing the new 'name_pattern' attribute. By default, this is set to 'legacy' for all policies, and maintains the naming pattern that sos has used up until this point. A policy may also set name_pattern to 'friendly' which will result in a more user-friendly name for the archive. Additionally, a policy may set name_pattern to a format() parsable string to explicitly set how the tarball should be named. Additionally, this removes the prompt for a 'customer name' on the report when running interactively. Instead, the short hostname of the system is now always used in place of the 'customer name'. A new option, --label, has been added (and which --name will now map to) which if provided will append a user-given string to the archive name after the hostname. This also sets the Red Hat policy to use the new 'friendly' pattern. Closes: #469 Resolves: #1175 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [man/sosreport] fix typo in chroot description (#1036)Adam Stokes2017-06-291-1/+1
| | | | | | | Fix small typo in the chroot section of the man page (alwyas -> always) Fixes #1035 Signed-off-by: Adam Stokes <battlemidget@users.noreply.github.com>
* [sosreport] clarify in man and help that --logsize is in MiBPavel Moravec2017-02-201-1/+1
| | | | | | | | | Neither sosreport --help or man pages specify the units of --logsize parameter. Let it clarify. Resolves: #916 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [docs] fix documentation of --sysroot parameterBryn M. Reeves2015-07-081-1/+1
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add --chroot to sosreport.1Bryn M. Reeves2015-07-081-0/+8
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add -s/--sysroot to sosreport.1Bryn M. Reeves2015-07-071-0/+5
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add --experimental to sosreport.1Bryn M. Reeves2015-02-111-0/+5
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update man page for new optionsBryn M. Reeves2014-12-171-4/+25
| | | | | | | | | | | | | The man page was missing: --verify --all-logs --log-size --plugin-option And listed the old '--ticket' (now --ticket-number). Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update references to report optionsBryn M. Reeves2014-09-171-3/+3
| | | | | | | | | The --report switch was changed to --no-report a while back. Update the docs to reflect the new option. Fixes #396. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] initial profiles supportBryn M. Reeves2014-09-161-6/+18
| | | | | | | | | | | | | | | | | | | Add simple profile support. Plugins can define a 'profiles' attribute that contains a list of profile names that this plugin belongs to. If a profile is given on the command line only plugins belonging to that profile will run. Two new command-line options are introduced in thie commit: --list-profiles --profile=NAME Profiles can be combined with -l/--list-plugins in order to see the effect of the profile on the set of enabled plugins. Fixes #247. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] improve man page descriptions of --ticket and --case-idBryn M. Reeves2014-09-161-4/+12
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* sosreport: Accept commas, period and alphas in the case idAruna Balakrishnaiah2014-09-161-3/+3
| | | | | | | | | | | | sosreport does not accept commas, period and alphas in the case id, the patch fixes the same. Change the ticket number field to case id as it now accepts alpha numerals as well but maintain the '--ticket-number' option for compatibility. Signed-off-by: Aruna Balakrishnaiah <aruna@linux.vnet.ibm.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] document -z, --compression-type in sosreport(1)Bryn M. Reeves2014-07-101-0/+5
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Remove --profile supportBryn M. Reeves2014-03-251-4/+1
| | | | | | | | | | | | | The handrolled profile logging support in sos hasn't been widely used in a long time and is a problem better solved with external profiling and coverage tools. Rip out all the support and documentation. This shortens and simplifies numerous Plugin class methods. Fixes Issue #244. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Remove --upload optionBryn M. Reeves2014-01-242-22/+24
| | | | | | | | | | | | The --upload option has a lot of limitations and has not been widely used. Recent trends are to handle uploading data in higher-level tools (e.g. redhat-support-tool or web based management UIs) and the python ftp library does not support modern requirements like HTTP proxy traversal or encryption. Fixes Issue #217 Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Point sosreport manpage to see the AUTHORS file for updated contributorsAdam Stokes2013-04-231-21/+1
| | | | | | | - Include AUTHORS file in the tarball. - Consolidated where list of Authors may be found. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* Update man page date to reflect recent changes to the informationAdam Stokes2013-03-251-1/+1
| | | | Signed-off-by: Adam Stokes <hackr@cypherbook.com>
* Man page updatesBryn M. Reeves2013-03-251-26/+64
|
* Rename --silent to --quietBryn M. Reeves2013-03-251-0/+3
| | | | | | | | | | | | | | | 'silent' is a poort name for an option that admits to not being silent: --silent Only display FATAL errors on stdout Rename the option to '--quiet' instead and document it in the man page. It's probably also worth either documenting the fact that UI text is still printed when --quiet is given in non-batch mode or changing interactive mode to only print essential prompts when run with --quiet. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Delete vestigial coloured output codeBryn M. Reeves2012-12-131-6/+2
| | | | | | Colour output was removed from sos a long time ago. Kill off the remaining opts variable, command line option and documentation references for increased sanity.
* Remove analyze() wiringBryn M. Reeves2012-12-111-5/+1
| | | | | | | The analyze() methods haven't been used since commit 6ea48cb and their functonality has now been moved or removed in all modules. Delete the last bits of wiring and docs references.
* Remove diagnose() wiringBryn M. Reeves2012-12-111-4/+1
| | | | | | Complete the removal of the diagnose functionality by removing the methods in the Plugin class and sosreport module, command line options and documentation.
* Make sure compressed archive is stored where tmp-dir is set to otherwiseastokes2010-04-221-5/+2
| | | | | | | it defaults to /tmp git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@933 ef72aa8b-4018-0410-8976-d6e080ef94d8
* updated man page to describe debug option and added new switchastokes2010-04-221-9/+15
| | | | | | | during plugin exception attempt to print to stdout the issue and also to a log file git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@932 ef72aa8b-4018-0410-8976-d6e080ef94d8
* updating sos.conf manualastokes2010-04-082-1/+35
| | | | git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@913 ef72aa8b-4018-0410-8976-d6e080ef94d8
* placeholder for sos.conf man pageastokes2010-03-311-0/+0
| | | | git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@902 ef72aa8b-4018-0410-8976-d6e080ef94d8
* build updatesastokes2010-03-261-0/+93
git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@870 ef72aa8b-4018-0410-8976-d6e080ef94d8
generated by cgit (git 2.34.1) at 2024-11-11 08:31:40 +0000