xref: /freebsd/contrib/kyua/doc/kyua-help.1.in (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1*b0d29bc4SBrooks Davis.\" Copyright 2012 The Kyua Authors.
2*b0d29bc4SBrooks Davis.\" All rights reserved.
3*b0d29bc4SBrooks Davis.\"
4*b0d29bc4SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
5*b0d29bc4SBrooks Davis.\" modification, are permitted provided that the following conditions are
6*b0d29bc4SBrooks Davis.\" met:
7*b0d29bc4SBrooks Davis.\"
8*b0d29bc4SBrooks Davis.\" * Redistributions of source code must retain the above copyright
9*b0d29bc4SBrooks Davis.\"   notice, this list of conditions and the following disclaimer.
10*b0d29bc4SBrooks Davis.\" * Redistributions in binary form must reproduce the above copyright
11*b0d29bc4SBrooks Davis.\"   notice, this list of conditions and the following disclaimer in the
12*b0d29bc4SBrooks Davis.\"   documentation and/or other materials provided with the distribution.
13*b0d29bc4SBrooks Davis.\" * Neither the name of Google Inc. nor the names of its contributors
14*b0d29bc4SBrooks Davis.\"   may be used to endorse or promote products derived from this software
15*b0d29bc4SBrooks Davis.\"   without specific prior written permission.
16*b0d29bc4SBrooks Davis.\"
17*b0d29bc4SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*b0d29bc4SBrooks Davis.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*b0d29bc4SBrooks Davis.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*b0d29bc4SBrooks Davis.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*b0d29bc4SBrooks Davis.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*b0d29bc4SBrooks Davis.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*b0d29bc4SBrooks Davis.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*b0d29bc4SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*b0d29bc4SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*b0d29bc4SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*b0d29bc4SBrooks Davis.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*b0d29bc4SBrooks Davis.Dd September 9, 2012
29*b0d29bc4SBrooks Davis.Dt KYUA-HELP 1
30*b0d29bc4SBrooks Davis.Os
31*b0d29bc4SBrooks Davis.Sh NAME
32*b0d29bc4SBrooks Davis.Nm "kyua help"
33*b0d29bc4SBrooks Davis.Nd Shows usage information
34*b0d29bc4SBrooks Davis.Sh SYNOPSIS
35*b0d29bc4SBrooks Davis.Nm
36*b0d29bc4SBrooks Davis.Op Ar command
37*b0d29bc4SBrooks Davis.Sh DESCRIPTION
38*b0d29bc4SBrooks DavisThe
39*b0d29bc4SBrooks Davis.Nm
40*b0d29bc4SBrooks Daviscommand provides interactive help on all supported commands and options.
41*b0d29bc4SBrooks DavisIf, for some reason, you happen to spot a discrepancy in the output of this
42*b0d29bc4SBrooks Daviscommand and this document, the command is the authoritative source of
43*b0d29bc4SBrooks Davisinformation.
44*b0d29bc4SBrooks Davis.Pp
45*b0d29bc4SBrooks DavisIf no arguments are provided, the command prints the list of common options
46*b0d29bc4SBrooks Davisand the list of supported subcommands.
47*b0d29bc4SBrooks Davis.Pp
48*b0d29bc4SBrooks DavisIf the
49*b0d29bc4SBrooks Davis.Ar command
50*b0d29bc4SBrooks Davisargument is provided to, this single argument is the name of a valid
51*b0d29bc4SBrooks Davissubcommand.
52*b0d29bc4SBrooks DavisIn that case,
53*b0d29bc4SBrooks Davis.Nm
54*b0d29bc4SBrooks Davisprints a textual description of the command, the list of common options and
55*b0d29bc4SBrooks Davisthe list of subcommand-specific options.
56*b0d29bc4SBrooks Davis.Sh EXIT STATUS
57*b0d29bc4SBrooks DavisThe
58*b0d29bc4SBrooks Davis.Nm
59*b0d29bc4SBrooks Daviscommand always returns 0.
60*b0d29bc4SBrooks Davis.Pp
61*b0d29bc4SBrooks DavisAdditional exit codes may be returned as described in
62*b0d29bc4SBrooks Davis.Xr kyua 1 .
63*b0d29bc4SBrooks Davis.Sh SEE ALSO
64*b0d29bc4SBrooks Davis.Xr kyua 1
65