From 3fa5e6ca47e1ca496b9691671cc4728ff0017aed Mon Sep 17 00:00:00 2001
From: Jake Hunsaker <jhunsake@redhat.com>
Date: Thu, 15 Nov 2018 13:40:00 -0500
Subject: [man] Update manpage for presets

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>
---
 man/en/sosreport.1 | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'man/en')

diff --git a/man/en/sosreport.1 b/man/en/sosreport.1
index 014d01a3..2fca3146 100644
--- a/man/en/sosreport.1
+++ b/man/en/sosreport.1
@@ -10,6 +10,8 @@ sosreport \- Collect and package diagnostic and support data
           [-a|--alloptions] [-v|--verbose]\fR
           [-k plug.opt|--plugin-option plug.opt]\fR
           [--no-report] [--config-file conf]\fR
+          [--preset preset] [--add-preset add_preset]\fR
+          [--del-preset del_preset] [--desc description]\fR
           [--batch] [--build] [--debug]\fR
           [--label label] [--case-id id] [--ticket-number nr]
           [--threads threads]
@@ -78,6 +80,37 @@ Disable HTML/XML report writing.
 .B \--config-file CONFIG
 Specify alternate configuration file.
 .TP
+.B \--preset PRESET
+Specify an existing preset to use for sos options.
+
+Presets are pre-configured sets of options for both sos and sos plugins. For
+example a preset may enable a certain set of plugins, disable others, or enable
+specific plugin options. They may also specify sos options such as log-size or
+package verification.
+
+User defined presets are saved under /var/lib/sos/presets as JSON-formatted files.
+.TP
+.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
+50 and disables the logs plugin.
+
+Note: to set a description for the preset that is displayed with \fB--list-presets\fR
+use the \fB--desc\fR option.
+.TP
+.B \--del-preset DEL_PRESET
+Deletes the preset with name DEL_PRESET from the filesystem so that it can no
+longer be used.
+.TP
+.B \--list-presets
+Display a list of available presets and what options they carry.
+.TP
+.B \--desc DESCRIPTION
+When using \fB--add-preset\fR use this option to add a description of the preset
+that will be displayed when using \fB--list-presets\fR.
+.TP
 .B \-s, \--sysroot SYSROOT
 Specify an alternate root file system path. Useful for collecting
 reports from containers and images.
-- 
cgit