View Source Tectonic (tectonic v0.1.1)

Tectonic is an installer and runner for tectonic, a modernized, complete, self-contained TeX/LaTeX engine, powered by XeTeX and TeXLive.

Profiles

You can define multiple tectonic profiles. By default, there is a profile called :default which you can configure its args, current directory and environment:

config :tectonic,
  version: "0.15.0",
  default: [
    args: ~w(
      -X compile
      --untrusted
    )
  ]

Tectonic configuration

There are two global configurations for the tectonic application:

  • :version - the expected tectonic version

  • :version_check - whether to perform the version check or not. Useful when you manage the tectonic executable with an external tool (e.g. OS package manager)

  • :cacerts_path - the directory to find certificates for https connections

  • :path - the path to find the tectonic executable at. By default, it is automatically downloaded and placed inside the _build directory of your current app

Overriding the :path is not recommended, as we will automatically download and manage tectonic for you. But in case you can't download it (for example, GitHub behind a proxy), you may want to set the :path to a configurable system location.

Once you find the location of the executable, you can store it in a MIX_TECTONIC_PATH environment variable, which you can then read in your configuration file:

config :tectonic, path: System.get_env("MIX_TECTONIC_PATH")

Summary

Functions

Returns the path to the executable.

Returns the version of the tectonic executable.

Returns the configuration for the given profile.

Returns the configured tectonic version.

The default URL to install Tectonic from.

Installs, if not available, and then runs tectonic.

Runs the given command with args.

Functions

Returns the path to the executable.

The executable may not be available if it was not yet installed.

Returns the version of the tectonic executable.

Returns {:ok, version_string} on success or :error when the executable is not available.

Returns the configuration for the given profile.

Returns nil if the profile does not exist.

Returns the configured tectonic version.

The default URL to install Tectonic from.

Link to this function

install(base_url \\ default_base_url())

View Source

Installs tectonic with configured_version/0.

Link to this function

install_and_run(profile, args)

View Source

Installs, if not available, and then runs tectonic.

Returns the same as run/2.

Link to this function

run(profile, extra_args \\ [])

View Source

Runs the given command with args.

The given args will be appended to the configured args. The task output will be streamed directly to stdio. It returns the status of the underlying call.