/
sile.1.in
94 lines (94 loc) · 4.72 KB
/
sile.1.in
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
.TH @TRANSFORMED_PACKAGE_NAME@ 1 "@MAN_DATE@" "version v@VERSION@"
.SH NAME
@TRANSFORMED_PACKAGE_NAME@ \- Simon's Improved Layout Engine
.SH SYNOPSIS
.B @TRANSFORMED_PACKAGE_NAME@ [
.I options
.B ] [
.I filename.sil
.B |
.I filename.xml
.B ]
.SH DESCRIPTION
The SILE typesetter reads a single input file, by default in either SIL or XML format, and processes it to generate a single output file, by default in PDF format.
The output will be written to the same name as the input file with the extension changed to .pdf unless the \fB\-\-output\fR flag is used.
Additional input or output formats can be handled by loading a module with \fB\-\-use\fR to add support for them first.
.SH OPTIONS
.B @TRANSFORMED_PACKAGE_NAME@ accepts the following feature flags:
.TP
.BR \-t ", " \-\-traceback
Display detailed location trace on errors and warnings.
.TP
.BR \-h ", " \-\-help
Print help message and exit.
.TP
.BR \-v ", " \-\-version
Print version information and exit.
.TP
.B @TRANSFORMED_PACKAGE_NAME@ accepts the following options with values:
.TP
.BR \-b ", " \-\-backend= \fIvalue\fR
Choose an alternative output backend.
The default backend for producing PDF files is \fIlibtexpdf\fR.
Other available backends include \fIcairo\fR, \fIdebug\fR, \fItext\fR, and \fIdummy\fR.
.TP
.BR \-c ", " \-\-class= \fIvalue\fR
Set the document class.
The default for documents that do not specify is \fIplain\fR.
Can be used to either change the default class or to override the class specified in a document.
Other default classes include \fIbase\fR, \fIbible\fR, \fIbook\fR, \fIdiglot\fR, \fIdocbook\fR, \fIdocbook.sil \fIjbook\fR, \fIjplain\fR, \fIletter\fR, \fImarkdown\fR, \fIpecha\fR, \fItbook\fR, \fItplain\fR, and \fItriglot\fR.
.TP
.BR \-d ", " \-\-debug= \fIvalue\fR[,\fIvalue\fR]
Debug SILE's operation.
Multiple debug flags may be given as a comma separated list.
While packages may define their own debug flags, the most commonly used ones are \fItypesetter\fR, \fIpagebuilder\fR, \fIvboxes\fR, \fIbreak\fR, \fIframes\fR, \fIprofile\fR, and \fIversions\fR.
May be specified more than once.
.TP
.BR \-e ", " \-\-evaluate= \fIvalue\fR
Evaluate Lua expression before processing input.
May be specified more than once.
.TP
.BR \-E ", " \-\-evaluate-after= \fIvalue\fR
Evaluate Lua expression after processing input.
May be specified more than once.
.TP
.BR \-f ", " \-\-fontmanager= \fIvalue\fR
Choose an alternative font manager.
The font manager is responsible for discovering the locations on font files on the system given a font name.
The default font manager is \fIfontconfig\fR on non-macOS systems and \fImacfonts\fR on macOS.
.TP
.BR \-m ", " \-\-makedeps \fIfile\fR
Generate a list of dependencies in Makefile format.
.TP
.BR \-o ", " \-\-output= \fIfile\fR
Explicitly set the output file name.
.TP
.BR \-O ", " \-\-options= \fIparameter=value\fR[,\fIparameter=value\fR]
Set document class options.
Can be used to change default options or override the ones specified in a document.
For example setting \fB\-\-options papersize=letter\fR would override both the default \fIpapersize\fR of A4 and any specific one set in the document's options.
May be specified more than once.
.TP
.BR \-I ", " \-\-include= \fIfilename\fR
Deprecated, will be removed.
Please use \-\-use, \-\-preamble, or \-\-postamble.
.TP
.BR \-p ", " \-\-preamble= \fIfilename\fR
Include an SIL, XML, or other content resource before the input document.
The value should be a full filename with a path relative to PWD or an absolute path.
May be specified more than once.
.TP
.BR \-P ", " \-\-postamble= \fIfilename\fR
Include an SIL, XML, or other content resource after the input document.
The value should be a full filename with a path relative to PWD or an absolute path.
May be specified more than once.
.TP
.BR \-u ", " \-\-use= \fImodule\fR [[\fIparameter=value[,parameter=value]]]\fR
Load and initialize a class, inputter, shaper, or other module before processing the main input.
The value should be a loadable module name (with no extension, using \fI'.'\fR as a path separator) and will be loaded using SILE's module search path.
Options may be passed to the module by enclosing \fIkey=value\fR pairs in square brackets following the module name.
This is particularly useful when the input document is not SIL or a natively recognized XML scheme and SILE needs to be taught new tricks before even trying to read the input file.
If the module is a document class, it will replace \fIplain\fR as the default class for processing documents that do not specifically identify one to use.
Because this executes before loading the document, it may even add an input parser or modify an existing one to support new file formats.
Package modules will be added to the preamble to be loaded after the class is initialized.
May be specified more than once.