Skip to content

Commit

Permalink
docs(cli): Copy-edit main description to appease linter *and* read be…
Browse files Browse the repository at this point in the history
…tter
  • Loading branch information
alerque committed Sep 30, 2024
1 parent 3a3b1bc commit ecc913d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
11 changes: 8 additions & 3 deletions sile-lua.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@
.B [\fIoptions\fR]
.B [\fIINPUT\fR]
.SH DESCRIPTION
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 \fB\-\-output\fR argument is used.
Additional input or output formats can be handled by loading a module with the \fB\-\-use\fR argument to add support for them first.
The SILE Typesetter reads input file(s) and typesets the content into a rendered documument format, typically PDF.
.LP
By default, input files may be in declarative SIL markup, structured XML, or programatic Lua.
The input format is automatically detected by the active modules.
By default, the output will be a file with the same name as the first input file with the extension changed to .pdf.
The output filename can be overridden with the \fB\-\-output\fR argument.
Using \fB\-\-backend\fR one can change to a different output format (or a different driver for the same format).
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).
.SH OPTIONS
.TP
.BR \-b ", " \-\-backend= \fIvalue\fR
Expand Down
16 changes: 11 additions & 5 deletions src/cli.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
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.
/// The SILE Typesetter reads input file(s) and typesets the content into a rendered documument
/// format, typically PDF.
///
/// By default, input files may be in declarative SIL markup, structured XML, or programatic Lua.
/// The input format is automatically detected by the active modules. By default, the output will
/// be a file with the same name as the first input file with the extension changed to .pdf. The
/// output filename can be overridden with the `--output` argument. Using `--backend` one can
/// change to a different output format (or a different driver for the same format). Additional
/// input or output formats can be handled by loading a 3rd party module that supports them by
/// adding `--use` argument on the command line (which will load prior to attempting to read input
/// documents).
#[derive(Parser, Debug)]
#[clap(author, name = "SILE", bin_name = "sile")]
pub struct Cli {
Expand Down

0 comments on commit ecc913d

Please sign in to comment.