Skip to content

Command Line Interface

Hello World Example

echo Hello World > doc.md
baseprinter doc.md -b=baseprint

The above example generates a Baseprint document snapshot in the baseprint subdirectory. The snapshot contains a Baseprint JATS XML file named article.xml.

Setup

To use Baseprinter from the command line, it can be run in two ways:

  • as a OCI (Docker) container, or
  • from locally installed packages.

For installation instructions, refer to the Baseprinter start page.

Usage

usage: baseprinter [-h] [--version] [-b BASEPRINT] [-o OUTDIR] [-c COPY]
                   [-C DIRECTORY] [--skip-pdf] [-d DEFAULTS]
                   [infiles ...]

positional arguments:
  infiles               pandoc input files

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -b, --baseprint BASEPRINT
                        baseprint output directory
  -o, --outdir OUTDIR   HTML/PDF output directory
  -c, --copy COPY       Relative paths to copy into baseprint output directory
  -C, --directory DIRECTORY
                        working directory to change to
  --skip-pdf            Do not generate PDF
  -d, --defaults DEFAULTS
                        pandoc default option settings

Inputs

The non-option arguments for input files (infiles ...) are passed through to pandoc. Pandoc will concatenate multiple input files. Pandoc can convert Markdown, LaTeX, and many other source file formats.

Command Line Options

-d DEFAULTS

Options for -d and --defaults for defaults files are also passed through to pandoc. For more information, see the Defaults files section of the Pandoc User's Guide.