View Source Tectonic (tectonic v0.2.2)

Tectonic is an installer and runner for the Tectonic typesetter. Refer to the about page for more details.

Tectonic configuration

For profile configuration, see the Get Started guide.

There are several global configuration options for the tectonic application:

  • :version - the expected tectonic version

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

  • :ensure_installed - whether to automatically install or not. Useful when the package is required by your application runtime. Defaults to true. Note: Requires version_check to be true.

  • :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.

Whether or not the configured version is installed.

The default URL to install Tectonic from.

Installs, if configured version 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.

Link to this function

configured_version_installed?()

View Source

Whether or not the configured version is installed.

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 configured version 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.