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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
use clap::Parser;
use std::path::PathBuf;
/// The SILE typesetter reads an input file(s), by default in either SIL or XML format, and
/// processes them to generate an output file, by default in PDF format. The output will be written
/// to a file with the same name as the first input file with the extension changed to .pdf unless
/// the `--output` argument is used. Additional input or output formats can be handled by loading
/// a module with the `--use` argument to add support for them first.
#[derive(Parser, Debug)]
#[clap(author, name = "SILE", bin_name = "sile")]
pub struct Cli {
/// Input document filename(s), by default in SIL, XML, or Lua formats.
///
/// One or more input files from which to process content.
/// The first listed file is considered the master document, others are procced in sequence.
/// Other inputter formats may be enabled via`--use`.
/// Use `-` to read a content stream from STDIN.
pub input: Option<Vec<PathBuf>>,
/// Specify the output backend.
///
/// The default is `libtexpdf` and suitible for most PDF output.
/// Alternatives supported out of the box include `text`, `debug`, `dummy`, `cairo`, and `podofo`.
/// Other outputters may be enabled via `--use`.
#[clap(short, long, value_name = "BACKEND")]
pub backend: Option<String>,
/// Override the default or specified document class.
///
/// The default class for documents that do not specify one in the root tag is `plain`.
/// This can be used to either change the default class or to override the class actually specified in a document.
/// Other bundled classes include `base`, `bible`, `book`, `diglot`, `docbook`, `docbook`, `jbook`, `jplain`, `letter`, `pecha`, `tbook`, `tplain`, and `triglot`.
/// Others will be loaded dynamically from the module path.
#[clap(short, long)]
pub class: Option<String>,
/// Show debug information for tagged aspects of 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 `typesetter`, `pagebuilder`, `vboxes`, `break`, `frames`, `profile`, and `versions`.
/// May be specified more than once.
#[clap(short, long, value_name = "DEBUGFLAG[,DEBUGFLAG]")]
// TODO: switch to num_args(0..) to allow space separated inputs
pub debug: Option<Vec<String>>,
/// Evaluate Lua expression before processing input.
///
/// May be specified more than once.
#[clap(short, long, value_name = "EXRPESION")]
pub evaluate: Option<Vec<String>>,
/// Evaluate Lua expression after processing input.
///
/// May be specified more than once.
#[clap(short = 'E', long, value_name = "EXRPESION")]
pub evaluate_after: Option<Vec<String>>,
/// Specify which font manager to use.
///
/// The font manager is responsible for discovering the locations on font files on the system given a font name.
/// The default font manager is `fontconfig` on non-macOS systems and `macfonts` on macOS.
#[clap(short, long, value_name = "FONTMANAGER")]
pub fontmanager: Option<String>,
/// Generate a Makefile format list of dependencies and white them to a file.
///
/// This tracks all the files (input files, Lua libraries, fonts, images, etc.) use during the
/// typesetting process.
/// After completion, the list is written to FILE in the format of a dependency list for
/// a target in a Makefile.
/// This can be used later to determine if a PDF needs re-rendering based on whether any inputs
/// have changed.
#[clap(short, long, value_name = "FILE")]
pub makedeps: Option<PathBuf>,
/// Explicitly set the output file name.
///
/// By default the basename of the first input file will be used as the output filename.
/// An extension will be chosen based on the output backend, typically .pdf.
/// With this option any arbitrary name and path can be given.
/// Additionally `-` can be used to write the output to STDOUT.
#[clap(short, long, value_name = "FILE")]
pub output: Option<PathBuf>,
/// Set or override document class options.
///
/// Can be used to change default options or override the ones specified in a document.
/// For example setting `--options papersize=letter` would override both the default `papersize` of A4 and any specific one set in the document’s options.
/// May be specified more than once.
#[clap(short = 'O', long)]
pub option: Option<Vec<String>>,
/// Include the contents of a SIL, XML, or other resource file before the input document content.
///
/// The value should be a full filename with a path relative to PWD or an absolute path.
/// May be specified more than once.
#[clap(short, long, value_name = "FILE")]
pub preamble: Option<Vec<PathBuf>>,
/// Include the contents of a SIL, XML, or other resource file after the input document content.
///
/// The value should be a full filename with a path relative to PWD or an absolute path.
/// May be specified more than once.
#[clap(short = 'P', long, value_name = "FILE")]
pub postamble: Option<Vec<PathBuf>>,
/// 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 `.` as a path separator) and will be loaded using SILE’s module search path.
/// Options may be passed to the module by enclosing `key=value` 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 `plain` 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.
#[clap(
short,
long,
value_name = "MODULE[[PARAMETER=VALUE[,PARAMETER=VALUE]]]"
)]
pub r#use: Option<Vec<String>>,
/// Suppress warnings and informational messages during processing.
#[clap(short, long)]
pub quiet: bool,
/// Display detailed location trace on errors and warnings.
#[clap(short, long)]
pub traceback: bool,
}