commit - 24fb5e236e6b8a089b8c8e8545761001cd61a1fc
commit + ca8ce622a22580202c01e86572be6e2815018c71
blob - /dev/null
blob + e1ef5a0a9c9724f8f4ce816d6a4aee0e4605678d (mode 644)
--- /dev/null
+++ ninepscript.8
@@ -0,0 +1,50 @@
+.\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: December 02 2021$
+.Dt NINEPSCRIPT 8
+.Os
+.Sh NAME
+.Nm ninepscript
+.Nd scripting language for the kamid regress suite
+.Sh SYNOPSIS
+.Nm
+.Op Fl nv
+.Ar
+.Sh DESCRIPTION
+.Nm
+is an interpreter for a custom DSL
+.Pq domain sppecific language
+used to write the regression suite of
+.Xr kamid 8 .
+The test themselves are written in
+.Xr ninepscript 5 .
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl n
+don't run the test, check only the syntax of the provided
+.Ar files .
+.It Fl v
+verbose logging, print more information during the tests execution.
+.El
+.Pp
+.Nm
+first loads all the given
+.Ar files
+then proceeds to execute each defined test.
+.Pp
+See
+.Xr ninepscript 5
+for the description of the ninepscript language.