Skip to content

Commit ecc913d

Browse files
committed
docs(cli): Copy-edit main description to appease linter *and* read better
1 parent 3a3b1bc commit ecc913d

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

sile-lua.1.in

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
.B [\fIoptions\fR]
77
.B [\fIINPUT\fR]
88
.SH DESCRIPTION
9-
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.
10-
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 \fB\-\-output\fR argument is used.
11-
Additional input or output formats can be handled by loading a module with the \fB\-\-use\fR argument to add support for them first.
9+
The SILE Typesetter reads input file(s) and typesets the content into a rendered documument format, typically PDF.
10+
.LP
11+
By default, input files may be in declarative SIL markup, structured XML, or programatic Lua.
12+
The input format is automatically detected by the active modules.
13+
By default, the output will be a file with the same name as the first input file with the extension changed to .pdf.
14+
The output filename can be overridden with the \fB\-\-output\fR argument.
15+
Using \fB\-\-backend\fR one can change to a different output format (or a different driver for the same format).
16+
Additional input or output formats can be handled by loading a 3rd party module that supports them by adding \fB\-\-use\fR argument on the command line (which will load prior to attempting to read input documents).
1217
.SH OPTIONS
1318
.TP
1419
.BR \-b ", " \-\-backend= \fIvalue\fR

src/cli.rs

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
use clap::Parser;
22
use std::path::PathBuf;
33

4-
/// The SILE typesetter reads an input file(s), by default in either SIL or XML format, and
5-
/// processes them to generate an output file, by default in PDF format. The output will be written
6-
/// to a file with the same name as the first input file with the extension changed to .pdf unless
7-
/// the `--output` argument is used. Additional input or output formats can be handled by loading
8-
/// a module with the `--use` argument to add support for them first.
4+
/// The SILE Typesetter reads input file(s) and typesets the content into a rendered documument
5+
/// format, typically PDF.
6+
///
7+
/// By default, input files may be in declarative SIL markup, structured XML, or programatic Lua.
8+
/// The input format is automatically detected by the active modules. By default, the output will
9+
/// be a file with the same name as the first input file with the extension changed to .pdf. The
10+
/// output filename can be overridden with the `--output` argument. Using `--backend` one can
11+
/// change to a different output format (or a different driver for the same format). Additional
12+
/// input or output formats can be handled by loading a 3rd party module that supports them by
13+
/// adding `--use` argument on the command line (which will load prior to attempting to read input
14+
/// documents).
915
#[derive(Parser, Debug)]
1016
#[clap(author, name = "SILE", bin_name = "sile")]
1117
pub struct Cli {

0 commit comments

Comments
 (0)