aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2023-09-09 23:08:00 +0200
committerThomas Voss <mail@thomasvoss.com> 2023-09-09 23:08:00 +0200
commiteda0dc9c9a4ec74e97a4b69b1b463f16a6d7f7bb (patch)
treee1b4d9ab05e4ea6aeab5bb3c9c35f32734dfa681
parent506c84f1cf5f8fd59bc811d5b0073195e9e33068 (diff)
Add an initial manual page for gsp(1)
-rw-r--r--gsp.141
1 files changed, 41 insertions, 0 deletions
diff --git a/gsp.1 b/gsp.1
new file mode 100644
index 0000000..d0d4124
--- /dev/null
+++ b/gsp.1
@@ -0,0 +1,41 @@
+.Dd $Mdocdate: September 9 2023 $
+.Dt GSP 1
+.Os
+.Sh NAME
+.Nm gsp
+.Nd better syntax for HTML
+.Sh SYNOPSIS
+.Nm
+.Op Ar
+.Sh DESCRIPTION
+.Nm
+is a utility to transpile a
+.Xr gsp 5
+formatted plain\-text file into valid HTML.
+Files provided as command\-line arguments will be transpiled with the result
+being written to the standard output.
+If no arguments or the special filename
+.Pa -
+is provided, then input will be read from the standard input.
+.Sh EXIT STATUS
+.Ex -std gsp
+.Sh EXAMPLES
+Compile the files
+.Pa head.gsp
+and
+.Pa tail.gsp
+into one HTML document:
+.Pp
+.Dl $ gsp head.gsp tail.gsp >out.html
+.Pp
+Expand
+.Xr m4 1
+macros before transpiling to HTML:
+.Pp
+.Dl $ m4 foo.gsp | gsp
+.Sh SEE ALSO
+.Xr m4 1 ,
+.Xr sed 1 ,
+.Xr gsp 5
+.Sh AUTHORS
+.An Thomas Voss Aq Mt mail@thomasvoss.com