1 .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
2 .\"
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
6 .\"
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .\"
15 .Dd $Mdocdate: January 09 2022$
16 .Dt NINEPSCRIPT 8
17 .Os
18 .Sh NAME
19 .Nm ninepscript
20 .Nd scripting language for the kamid regress suite
21 .Sh SYNOPSIS
22 .Nm
23 .Op Fl nv
24 .Fl r Ar dir
25 .Op Fl x Ar pattern
26 .Ar
27 .Sh DESCRIPTION
28 .Nm
29 is an interpreter for a custom DSL
30 .Pq domain sppecific language
31 used to write the regression suite of
32 .Xr kamid 8 .
33 The test themselves are written in
34 .Xr ninepscript 5 .
35 .Pp
36 The options are as follows:
37 .Bl -tag -width Ds
38 .It Fl n
39 don't run the test, check only the syntax of the provided
40 .Ar files .
41 .It Fl r Ar dir
42 Use the specified
43 .Ar
44 as root for the tests.
45 .It Fl v
46 verbose logging, print more information during the tests execution.
47 .It Fl x Ar pattern
48 Run only the tests that match the given
49 .Ar pattern .
50 .El
51 .Pp
52 .Nm
53 first loads all the given
54 .Ar files
55 then proceeds to execute each defined test.
56 .Pp
57 See
58 .Xr ninepscript 5
59 for the description of the ninepscript language.