aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorBryn M. Reeves <bmr@redhat.com>2014-09-16 11:02:52 +0100
committerBryn M. Reeves <bmr@redhat.com>2014-09-16 11:02:52 +0100
commit8674efc6516fab907af3dafafc6a55683190349e (patch)
treefe8737fb2f018c3ef6b73b66f9a648a0f8c443d0 /man
parentf627328a6594de60402589c21fb7aefabef9ab3a (diff)
downloadsos-8674efc6516fab907af3dafafc6a55683190349e.tar.gz
[docs] improve man page descriptions of --ticket and --case-id
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sosreport.116
1 files changed, 12 insertions, 4 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1
index 3714da06..df4f1cd3 100644
--- a/man/en/sosreport.1
+++ b/man/en/sosreport.1
@@ -8,9 +8,10 @@ sosreport \- Collect and package diagnostic and support data
[-e|--enable-plugins plugin-names]\fR
[-o|--only-plugins plugin-names]\fR
[-a|--alloptions] [-v|--verbose]\fR
- [--report] [--config-file conf] [--batch]\fR
- [--build] [--name name] [--case-id id]
- [--debug] [--tmp-dir directory]\fR
+ [--report] [--config-file conf]\fR
+ [--batch] [--build] [--debug]\fR
+ [--name name] [--case-id id] [--ticket-number nr]
+ [--tmp-dir directory]\fR
[-z|--compression-type method]\fR
[--help]\fR
.SH DESCRIPTION
@@ -79,7 +80,14 @@ Generate archive without prompting for interactive input.
Specify a name to be used for the archive.
.TP
.B \--case-id NUMBER
-Specify a case id to be used for archive
+Specify a case identifier to associate with the archive.
+Identifiers may include alphanumeric characters, commas and periods ('.').
+Synonymous with \--ticket, \--ticket-number.
+.TP
+.B \--ticket, \--ticket-number NUMBER
+Specify a ticket number or other identifier to associate with the archive.
+Identifiers may include alphanumeric characters, commas and periods ('.').
+Synonymous with \--case-id.
.TP
.B \--build
Do not archive copied data. Causes sosreport to leave an uncompressed