blob: 5ab337d241aac2aebe4bcbcc5e0346e7aed13ad9 (
plain)
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
.Dd Dec 13, 2019
.Dt mkws 1
.Os
.Sh NAME
.Nm mkws
.Nd make web site
.Sh SYNOPSIS
.Nm
.Ar url
.Op path
.Sh DESCRIPTION
The
.Nm
utility uses
.Xr pp 1
and the theme files in the
.Ev MKWSTHEMEPATH
directory
to preprocess all files in
.Op path
in order to produce a static web site in the current directory. If no
.Op path
is specified, the current directory is used instead.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Ar url
The url of the web site. It is used for generating
.Pa sitemap.xml
.
.It Op path
The path where the unpreprocessed files are located. If no
.Op path
is specified, the current directory is used instead.
.El
.Sh ENVIRONMENT
.Bl -tag -width MKWSTHEMEDIR
.It Ev MKWSTHEMEDIR
The directory containing the theme files. See the
.Em FILES
section for the minimum required files for a theme. If no
.Ev MKWSTHEMEDIR
variable is set
.Pa [path]/share
wil be used.
.It Ev LANG
The language for the website. It will be parsed to fill in the
.Em lang
attribute of the
.Em html
element and then
.Em charset
.Em meta
element.
.El
.Sh FILES
.Bl -tag -width "/tmp/vi.recover
.It Pa $MKWSTHEMEDIR/l.upphtml
The layout file of the website. It contains the
.Em DOCTYPE ,
.Em html ,
.Em head ,
.Em title ,
.Em meta
,
.Em link
,
.Em body
elements.
.It Pa $MKWSTHEMEDIR/sitemap.xml
The
.Pa sitemap.txt
template.
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Make https://example.com web site using the unpreprocessed files in the
current directory
.Pp
.Dl $ mkws https://example.com
.Pp
Make https://example.com web site using the unpreprocessed files in the
.Ar ~/src/ws
directory
.Pp
.Dl $ mkws https://example.com ~/src/ws
.Sh SEE ALSO
.Xr sh 1
.Xr pp 1
.Xr locale 1
|
