xref: /src/contrib/kyua/doc/kyua-help.1.in (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
108334c51SBrooks Davis.\" Copyright 2012 The Kyua Authors.
208334c51SBrooks Davis.\" All rights reserved.
308334c51SBrooks Davis.\"
408334c51SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
508334c51SBrooks Davis.\" modification, are permitted provided that the following conditions are
608334c51SBrooks Davis.\" met:
708334c51SBrooks Davis.\"
808334c51SBrooks Davis.\" * Redistributions of source code must retain the above copyright
908334c51SBrooks Davis.\"   notice, this list of conditions and the following disclaimer.
1008334c51SBrooks Davis.\" * Redistributions in binary form must reproduce the above copyright
1108334c51SBrooks Davis.\"   notice, this list of conditions and the following disclaimer in the
1208334c51SBrooks Davis.\"   documentation and/or other materials provided with the distribution.
1308334c51SBrooks Davis.\" * Neither the name of Google Inc. nor the names of its contributors
1408334c51SBrooks Davis.\"   may be used to endorse or promote products derived from this software
1508334c51SBrooks Davis.\"   without specific prior written permission.
1608334c51SBrooks Davis.\"
1708334c51SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1808334c51SBrooks Davis.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1908334c51SBrooks Davis.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
2008334c51SBrooks Davis.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2108334c51SBrooks Davis.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2208334c51SBrooks Davis.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2308334c51SBrooks Davis.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2408334c51SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2508334c51SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2608334c51SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2708334c51SBrooks Davis.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2808334c51SBrooks Davis.Dd September 9, 2012
2908334c51SBrooks Davis.Dt KYUA-HELP 1
3008334c51SBrooks Davis.Os
3108334c51SBrooks Davis.Sh NAME
3208334c51SBrooks Davis.Nm "kyua help"
3308334c51SBrooks Davis.Nd Shows usage information
3408334c51SBrooks Davis.Sh SYNOPSIS
3508334c51SBrooks Davis.Nm
3608334c51SBrooks Davis.Op Ar command
3708334c51SBrooks Davis.Sh DESCRIPTION
3808334c51SBrooks DavisThe
3908334c51SBrooks Davis.Nm
4008334c51SBrooks Daviscommand provides interactive help on all supported commands and options.
4108334c51SBrooks DavisIf, for some reason, you happen to spot a discrepancy in the output of this
4208334c51SBrooks Daviscommand and this document, the command is the authoritative source of
4308334c51SBrooks Davisinformation.
4408334c51SBrooks Davis.Pp
4508334c51SBrooks DavisIf no arguments are provided, the command prints the list of common options
4608334c51SBrooks Davisand the list of supported subcommands.
4708334c51SBrooks Davis.Pp
4808334c51SBrooks DavisIf the
4908334c51SBrooks Davis.Ar command
5008334c51SBrooks Davisargument is provided to, this single argument is the name of a valid
5108334c51SBrooks Davissubcommand.
5208334c51SBrooks DavisIn that case,
5308334c51SBrooks Davis.Nm
5408334c51SBrooks Davisprints a textual description of the command, the list of common options and
5508334c51SBrooks Davisthe list of subcommand-specific options.
5608334c51SBrooks Davis.Sh EXIT STATUS
5708334c51SBrooks DavisThe
5808334c51SBrooks Davis.Nm
5908334c51SBrooks Daviscommand always returns 0.
6008334c51SBrooks Davis.Pp
6108334c51SBrooks DavisAdditional exit codes may be returned as described in
6208334c51SBrooks Davis.Xr kyua 1 .
6308334c51SBrooks Davis.Sh SEE ALSO
6408334c51SBrooks Davis.Xr kyua 1
65