caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-14 04:56:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve CLI help doc about input & output (#4282)

Browse Source
This commit is contained in:
Yip Coekjan 2024-05-30 16:00:10 +08:00 committed by GitHub
parent b15aa664f2
commit 023b8068f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/typst-cli/src/args.rs
View File

@ -71,11 +71,12 @@ pub struct CompileCommand {
#[clap(flatten)]
pub common: SharedArgs,
/// Path to output file (PDF, PNG, or SVG).
/// Use `-` to write output to stdout; For output formats emitting one file per page,
/// a page number template must be present if the source document renders to multiple pages.
/// Use `{p}` for page numbers, `{0p}` for zero padded page numbers, `{t}` for page count.
/// For example, `doc-page-{0p}-of-{t}.png` creates `doc-page-01-of-10.png` and so on.
/// Path to output file (PDF, PNG or SVG). Use `-` to write output to stdout.
///
/// For output formats emitting one file per page (PNG & SVG), a page number template
/// must be present if the source document renders to multiple pages. Use `{p}` for page
/// numbers, `{0p}` for zero padded page numbers and `{t}` for page count. For example,
/// `page-{0p}-of-{t}.png` creates `page-01-of-10.png`, `page-02-of-10.png` and so on.
#[clap(required_if_eq("input", "-"), value_parser = ValueParser::new(output_value_parser))]
pub output: Option<Output>,
@ -169,7 +170,7 @@ pub enum SerializationFormat {
/// Common arguments of compile, watch, and query.
#[derive(Debug, Clone, Args)]
pub struct SharedArgs {
/// Path to input Typst file, use `-` to read input from stdin
/// Path to input Typst file. Use `-` to read input from stdin
#[clap(value_parser = input_value_parser)]
pub input: Input,