1.\" Copyright 2012 Google Inc. 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-LIST 1 30.Os 31.Sh NAME 32.Nm 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 and 44prints a list of all their names, optionally accompanied by any metadata 45properties they have. 46.Pp 47The optional arguments to 48.Nm 49are used to select which test programs or test cases to run. These are 50filters and are explained in more detail in 51.Xr kyua-test-filters 7 . 52.Pp 53This command must be run within a test suite or a test suite must be 54provided with the 55.Fl -kyuafile 56flag. 57.Pp 58The following subcommand options are recognized: 59.Bl -tag -width XX 60.It Fl -build-root Ar path 61Specifies the build root in which to find the test programs referenced 62by the Kyuafile, if different from the Kyuafile's directory. See 63.Xr kyua-build-root 7 64for more information. 65.It Fl -kyuafile Ar path , Fl k Ar path 66Specifies the Kyuafile to process. Defaults to a 67.Pa Kyuafile 68file in the current directory. 69.It Fl -verbose , Fl v 70Prints metadata properties for every test case. 71.El 72.Sh EXIT STATUS 73The 74.Nm 75command returns 0 on success or 1 if any of the given test case filters 76does not match any test case. 77.Pp 78Additional exit codes may be returned as described in 79.Xr kyua 1 . 80.Sh SEE ALSO 81.Xr kyua 1 , 82.Xr kyua-build-root 7 , 83.Xr kyua-test-filters 7 84