Skip to content

Start documenting cli options #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 2, 2019
Merged

Start documenting cli options #505

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1eaf8cd
Tabelize tectonic --help
PHPirates Nov 27, 2019
07d6783
Add example
PHPirates Nov 28, 2019
88dc3b6
Something about ascii characters?
PHPirates Nov 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions docs/src/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# Tectonic’s Command Line Interface
# Tectonic's Command Line Interface

So much to add here! [Go do it!](github.com/tectonic-typesetting/tectonic/pull/new).
Tectonic has many command line options.
If you have Tectonic installed, you can view them with `tectonic --help`.

The following are the available flags.

| Short | Full | Explanation |
|:------|:--------------------------|:-----------------------------------------------------------------------------------------------|
| `-h` | `--help` | Prints help information |
| `-k` | `--keep-intermediates` | Keep the intermediate files generated during processing |
| | `--keep-logs` | Keep the log files generated during processing |
| `-C` | `--only-cached` | Use only resource files cached locally |
| `-p` | `--print` | Print the engine's chatter during processing |
| | `--synctex` | Generate SyncTeX data |
| `-V` | `--version` | Prints version information |

The following are the available options.

| Short | Full | Explanation |
|:------|:--------------------------|:-----------------------------------------------------------------------------------------------|
| `-b` | `--bundle <PATH>` | Use this Zip-format bundle file to find resource files instead of the default |
| `-c` | `--chatter <LEVEL>` | How much chatter to print when running [default: default] [possible values: default, minimal] |
| | `--format <PATH>` | The name of the "format" file used to initialize the TeX engine [default: latex] |
| | `--hide <PATH>...` | Tell the engine that no file at <PATH> exists, if it tries to read it |
| | `--makefile-rules <PATH>` | Write Makefile-format rules expressing the dependencies of this run to <PATH> |
| `-o` | `--outdir <OUTDIR>` | The directory in which to place output files [default: the directory containing INPUT] |
| | `--outfmt <FORMAT>` | The kind of output to generate [default: pdf] [possible values: pdf, html, xdv, aux, format] |
| | `--pass <PASS>` | Which engines to run [default: default] [possible values: default, tex, bibtex_first] |
| `-r` | `--reruns <COUNT>` | Rerun the TeX engine exactly this many times after the first |
| `-w` | `--web-bundle <URL>` | Use this URL find resource files instead of the default |

If you specify a path, make sure to put it into brackets when it contains spaces.

Then, after specifying flags and options, you have to provide the actual input to tectonic.
This can be a (path to a) file, or "-" to process the standard input stream.

In short, the usage is `tectonic [FLAGS] [OPTIONS] <INPUT>`.

An example would be `tectonic --synctex --reruns 0 -o ../out/ main.tex`.