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