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 October 13, 2014 29.Dt KYUA-LIST 1 30.Os 31.Sh NAME 32.Nm "kyua list" 33.Nd Lists test cases and their metadata 34.Sh SYNOPSIS 35.Nm 36.Op Fl -build-root Ar path 37.Op Fl -kyuafile Ar file 38.Op Fl -verbose 39.Ar test_case1 Op Ar .. test_caseN 40.Sh DESCRIPTION 41The 42.Nm 43command scans all the test programs and test cases in a test suite (as 44defined by a 45.Xr kyuafile 5 ) 46and prints a list of all their names, optionally accompanied by any metadata 47properties they have. 48.Pp 49The optional arguments to 50.Nm 51are used to select which test programs or test cases to run. 52These are filters and are described below in 53.Sx Test filters . 54.Pp 55This command must be run within a test suite or a test suite must be 56provided with the 57.Fl -kyuafile 58flag. 59.Pp 60The following subcommand options are recognized: 61.Bl -tag -width XX 62.It Fl -build-root Ar path 63Specifies the build root in which to find the test programs referenced 64by the Kyuafile, if different from the Kyuafile's directory. 65See 66.Sx Build directories 67below for more information. 68.It Fl -kyuafile Ar path , Fl k Ar path 69Specifies the Kyuafile to process. 70Defaults to a 71.Pa Kyuafile 72file in the current directory. 73.It Fl -verbose , Fl v 74Prints metadata properties for every test case. 75.El 76.Ss Build directories 77__include__ build-root.mdoc COMMAND=list 78.Ss Test filters 79__include__ test-filters.mdoc 80.Sh EXIT STATUS 81The 82.Nm 83command returns 0 on success or 1 if any of the given test case filters 84does not match any test case. 85.Pp 86Additional exit codes may be returned as described in 87.Xr kyua 1 . 88.Sh SEE ALSO 89.Xr kyua 1 , 90.Xr kyuafile 5 91