xref: /minix3/external/bsd/kyua-cli/dist/doc/kyua-list.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-LIST 1
30*11be35a1SLionel Sambuc.Os
31*11be35a1SLionel Sambuc.Sh NAME
32*11be35a1SLionel Sambuc.Nm list
33*11be35a1SLionel Sambuc.Nd Lists test cases and their metadata
34*11be35a1SLionel Sambuc.Sh SYNOPSIS
35*11be35a1SLionel Sambuc.Nm
36*11be35a1SLionel Sambuc.Op Fl -build-root Ar path
37*11be35a1SLionel Sambuc.Op Fl -kyuafile Ar file
38*11be35a1SLionel Sambuc.Op Fl -verbose
39*11be35a1SLionel Sambuc.Ar test_case1 Op Ar .. test_caseN
40*11be35a1SLionel Sambuc.Sh DESCRIPTION
41*11be35a1SLionel SambucThe
42*11be35a1SLionel Sambuc.Nm
43*11be35a1SLionel Sambuccommand scans all the test programs and test cases in a test suite and
44*11be35a1SLionel Sambucprints a list of all their names, optionally accompanied by any metadata
45*11be35a1SLionel Sambucproperties they have.
46*11be35a1SLionel Sambuc.Pp
47*11be35a1SLionel SambucThe optional arguments to
48*11be35a1SLionel Sambuc.Nm
49*11be35a1SLionel Sambucare used to select which test programs or test cases to run.  These are
50*11be35a1SLionel Sambucfilters and are explained in more detail in
51*11be35a1SLionel Sambuc.Xr kyua-test-filters 7 .
52*11be35a1SLionel Sambuc.Pp
53*11be35a1SLionel SambucThis command must be run within a test suite or a test suite must be
54*11be35a1SLionel Sambucprovided with the
55*11be35a1SLionel Sambuc.Fl -kyuafile
56*11be35a1SLionel Sambucflag.
57*11be35a1SLionel Sambuc.Pp
58*11be35a1SLionel SambucThe following subcommand options are recognized:
59*11be35a1SLionel Sambuc.Bl -tag -width XX
60*11be35a1SLionel Sambuc.It Fl -build-root Ar path
61*11be35a1SLionel SambucSpecifies the build root in which to find the test programs referenced
62*11be35a1SLionel Sambucby the Kyuafile, if different from the Kyuafile's directory.  See
63*11be35a1SLionel Sambuc.Xr kyua-build-root 7
64*11be35a1SLionel Sambucfor more information.
65*11be35a1SLionel Sambuc.It Fl -kyuafile Ar path , Fl k Ar path
66*11be35a1SLionel SambucSpecifies the Kyuafile to process.  Defaults to a
67*11be35a1SLionel Sambuc.Pa Kyuafile
68*11be35a1SLionel Sambucfile in the current directory.
69*11be35a1SLionel Sambuc.It Fl -verbose , Fl v
70*11be35a1SLionel SambucPrints metadata properties for every test case.
71*11be35a1SLionel Sambuc.El
72*11be35a1SLionel Sambuc.Sh EXIT STATUS
73*11be35a1SLionel SambucThe
74*11be35a1SLionel Sambuc.Nm
75*11be35a1SLionel Sambuccommand returns 0 on success or 1 if any of the given test case filters
76*11be35a1SLionel Sambucdoes not match any test case.
77*11be35a1SLionel Sambuc.Pp
78*11be35a1SLionel SambucAdditional exit codes may be returned as described in
79*11be35a1SLionel Sambuc.Xr kyua 1 .
80*11be35a1SLionel Sambuc.Sh SEE ALSO
81*11be35a1SLionel Sambuc.Xr kyua 1 ,
82*11be35a1SLionel Sambuc.Xr kyua-build-root 7 ,
83*11be35a1SLionel Sambuc.Xr kyua-test-filters 7
84