Skip to content

cli-options.md

Latest commit

 

History

History
79 lines (50 loc) · 2.75 KB

cli-options.md

File metadata and controls

79 lines (50 loc) · 2.75 KB
title CLI Options
section Configuration
order 1
description Command-line options reference

CLI Options

Calling texd with options works in any mode; these commands are equivalent:

$ texd -h
$ texd registry.gitlab.com/islandoftex/images/texlive:latest -h
$ docker run --rm -t ghcr.io/digineo/texd:latest -h

  • --help, -h

    Prints a short option listing and exits.

  • --version, -v

    Prints version information and exits.

  • --listen-address=ADDR, -b ADDR (Default: :2201)

    Specifies host address (optional) and port number for the HTTP API to bind to. Valid values are, among others:

    • :2201 (bind to all addresses on port 2201)
    • localhost:2201 (bind only to localhost on port 2201)
    • [fe80::dead:c0ff:fe42:beef%eth0]:2201 (bind to a link-local IPv6 address on a specific interface)

  • --tex-engine=ENGINE, -X ENGINE (Default: xelatex)

    TeX engine used to compile documents. Can be overridden on a per-request basis (see HTTP API below). Supported engines are xelatex, lualatex, and pdflatex.

  • --compile-timeout=DURATION, -t DURATION (Default: 1m)

    Maximum duration for a document rendering process before it is killed by texd. The value must be acceptable by Go's ParseDuration function.

  • --parallel-jobs=NUM, -P NUM (Default: number of cores)

    Concurrency level. PDF rendering is inherently single threaded, so limiting the document processing to the number of cores is a good start.

  • --queue-wait=DURATION, -w DURATION (Default: 10s)

    Time to wait in queue before aborting. When <= 0, clients will immediately receive a "full queue" response.

  • --job-directory=PATH, -D PATH (Default: OS temp directory)

    Place to put job sub directories in. The path must exist and it must be writable.

  • --pull (Default: omitted)

    Always pulls Docker images. By default, images are only pulled when they don't exist locally.

    This has no effect when no image tags are given to the command line.

  • --shell-escape and --no-shell-escape (Default: both omitted)

    By default, (La)TeX allows some "trusted" binaries, e.g. bibtex and kpsewhich, to be executed during the compilation process, since these are sometimes required for packages to work.

    If you want to prohibit the execution of these programs, pass --no-shell-escape to texd. Note that, as mentioned, some packages will stop working.

    On the other hand, if you want to allow arbitrary command execution (!), for example with os.execute in lualatex, you may pass --shell-escape. Be careful, here be dragons.

    Also note that --shell-escape and --no-shell-escape are mutually exclusive.

Note: This option listing might be outdated. Run texd --help to get the up-to-date listing.