Skip to content

Commit

Permalink
Fix man page to be consistent
Browse files Browse the repository at this point in the history
- --output-type description didn't specify possible types
- examples used non-existing option --output-format
- use .nf/.fi for pre-formatted text
- use default healthcheck log location in the examples

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1809215
  • Loading branch information
abbra authored and rcritten committed Mar 3, 2020
1 parent d1640be commit 4defcc1
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions man/man8/ipa-healthcheck.8
Expand Up @@ -37,7 +37,7 @@ Execute one or more checks within this given source.
Execute this particular check within a source. A source must be supplied as well with this option.
.TP
\fB\-\-output\-type\fR=\fITYPE\fR
Set the output type. The default is JSON.
Set the output type. Supported variants are \fBhuman\fR and \fBjson\fR. The default is \fBjson\fR.
.TP
\fB\-\-failures\-only\fR
Exclude SUCCESS results on output.
Expand Down Expand Up @@ -70,28 +70,28 @@ Take as input a JSON results output and convert it to a more human\-readable for
.PP
Execute healthcheck with the default JSON output:
.PP
.Vb 1
\& ipa\-healthcheck
.Ve
.nf 1
\&# ipa\-healthcheck
.fi
.PP
Execute healthcheck with a prettier JSON output:
.PP
.Vb 1
\& ipa\-healthcheck \-\-indent 2
.Ve
.nf 1
\&# ipa\-healthcheck \-\-indent 2
.fi
.PP
Execute healthcheck and only display errors:
.PP
.Vb 1
\& ipa\-healthcheck \-\-failures\-only
.Ve
.nf 1
\&# ipa\-healthcheck \-\-failures\-only
.fi
.PP
Display in human\-readable output a previous report:
.PP
.Vb 2
\& ipa\-healthcheck \-\-output\-format human \-\-input\-file \e
\& /var/log/ipa/check.json
.Ve
.nf 2
\&# ipa\-healthcheck \-\-output\-type human \-\-input\-file \e
\& /var/log/ipa/healthcheck/healthcheck.log
.fi

.SH "FILES"
.TP
Expand Down

0 comments on commit 4defcc1

Please sign in to comment.