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