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