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: December 02 2021$
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 .Op Fl x Ar pattern
25 .Ar
26 .Sh DESCRIPTION
27 .Nm
28 is an interpreter for a custom DSL
29 .Pq domain sppecific language
30 used to write the regression suite of
31 .Xr kamid 8 .
32 The test themselves are written in
33 .Xr ninepscript 5 .
34 .Pp
35 The options are as follows:
36 .Bl -tag -width Ds
37 .It Fl n
38 don't run the test, check only the syntax of the provided
39 .Ar files .
40 .It Fl v
41 verbose logging, print more information during the tests execution.
42 .It Fl x Ar pattern
43 Run only the tests that match the given
44 .Ar pattern .
45 .El
46 .Pp
47 .Nm
48 first loads all the given
49 .Ar files
50 then proceeds to execute each defined test.
51 .Pp
52 See
53 .Xr ninepscript 5
54 for the description of the ninepscript language.