aboutsummaryrefslogtreecommitdiff
path: root/gsp.1
blob: a54744f1ee8522c9083bab69d19b1d093d2ee363 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.Dd $Mdocdate: September 10 2023 $
.Dt GSP 1
.Os
.Sh NAME
.Nm gsp
.Nd better syntax for HTML
.Sh SYNOPSIS
.Nm
.Op Fl d
.Op Ar
.Sh DESCRIPTION
.Nm
is a utility to transpile
.Xr gsp 5
formatted plain-text files 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.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl d
Do not automatically generate a document type at the beginning of the document.
.El
.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:
.Pp
.Dl $ m4 foo.gsp | gsp
.Pp
Use your own document type instead of the HTML5 one:
.Pp
.Dl $ printf \(aq%s%s\(aq \(dq$doctype\(dq \(dq$(gsp -d foo.gsp)\(dq
.Sh SEE ALSO
.Xr m4 1 ,
.Xr sed 1 ,
.Xr gsp 5
.Sh AUTHORS
.An Thomas Voss Aq Mt mail@thomasvoss.com