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