summaryrefslogtreecommitdiff
path: root/support/light-latex-make/llmk.1
blob: 1f284f5de98f4801d60386947119568480f19d81 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "LLMK" "1" "October 2020" "llmk 0.2.0" "llmk manual"
.
.SH "NAME"
\fBllmk\fR \- Light LaTeX Make
.
.SH "SYNOPSIS"
\fBllmk\fR [OPTION]\.\.\. [FILE]\.\.\.
.
.SH "DESCRIPTION"
\fBllmk\fR is yet another LaTeX\-specific build tool\. Its aim is to provide a simple way to write down workflows for processing LaTeX documents\. The only requirement is the \fBtexlua\fR(1) program\.
.
.P
If one or more FILE(s) are specified, \fBllmk\fR reads the TOML fields or other supported magic comments in the files\. Otherwise, it will read the special configuration file \fIllmk\.toml\fR in the working directory\. Then, \fBllmk\fR will execute the specified workflow to typeset the LaTeX documents\.
.
.SH "OPTIONS"
.
.TP
\fB\-c\fR, \fB\-\-clean\fR
Remove the temporary files such as \fB*\.aux\fR and \fB*\.log\fR\.
.
.TP
\fB\-C\fR, \fB\-\-clobber\fR
Remove all generated files including final PDFs\.
.
.TP
\fB\-d\fRCAT, \fB\-\-debug\fR=CAT
Activate debug output restricted to CAT\.
.
.TP
\fB\-D\fR, \fB\-\-debug\fR
Activate all debug output (equal to "\-\-debug=all")\.
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print this help message\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would have been executed\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress warnings and most error messages\.
.
.TP
\fB\-s\fR, \fB\-\-silent\fR
Silence messages from called programs\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print additional information (e\.g\., running commands)\.
.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print the version number\.
.
.SH "EXIT STATUS"
.
.TP
0
Success\.
.
.TP
1
General error\.
.
.TP
2
Failure executing the workflow\. The exit status of the external program is reported in an error message\.
.
.TP
3
Parser error\.
.
.TP
4
Type error\.
.
.SH "REPORTING BUGS"
Report bugs to \fIhttps://github\.com/wtsnjp/llmk/issues\fR\.
.
.br
Source: \fIhttps://github\.com/wtsnjp/llmk\fR
.
.SH "COPYRIGHT"
Copyright 2018\-2020 Takuto ASAKURA (wtsnjp)\.
.
.br
License: The MIT License \fIhttps://opensource\.org/licenses/mit\-license\fR\.
.
.br
This is free software: you are free to change and redistribute it\.
.
.SH "SEE ALSO"
The full documentation is maintained as a PDF manual\. The command
.
.IP "" 4
.
.nf

texdoc llmk
.
.fi
.
.IP "" 0
.
.P
should give you access to the complete manual\.