Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rm-dr
rm-dr committed Sep 20, 2024
1 parent 9bc1d96 commit a5e3416
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
9 changes: 8 additions & 1 deletion docs/src/ref/tectonic-toml.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@ the file are detailed below.
```toml
[doc]
name = <string> # the document name
bundle = <url or filesystem path> # the source of the TeX bundle

# A string identifying the location of the “bundle” of TeX support files
# underlying the processing of the document. The `tectonic -X new` command
# will populate this field with the current recommended default.
#
# This field should be a URL (a `.ttb` on the web, or a legacy indexed tar bundle),
# or a file on your computer (a `.ttb` or a legacy `.zip` bundle).
bundle = <url or filesystem path>

# Extra search paths for TeX sources, images, etc.
#
Expand Down
3 changes: 1 addition & 2 deletions docs/src/ref/v1cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The following are the available flags.

| Short | Full | Explanation |
|:------|:-------------------------------|:-------------------------------------------------------------------------------------------------------|
| `-b` | `--bundle <file_path>` | Use this directory or Zip-format bundle file to find resource files instead of the default |
| `-b` | `--bundle <path or url>` | Use this bundle instead of the default |
| `-c` | `--chatter <level>` | How much chatter to print when running [default: `default`] [possible values: `default`, `minimal`] |
| | `--color <when>` | Enable/disable colorful log output [default: `auto`] [possible values: `always`, `auto`, `never`] |
| `-f` | `--format <path>` | The name of the "format" file used to initialize the TeX engine [default: `latex`] |
Expand All @@ -63,5 +63,4 @@ The following are the available flags.
| | `--synctex` | Generate SyncTeX data |
| | `--untrusted` | Input is untrusted — disable all known-insecure features |
| `-V` | `--version` | Prints version information |
| `-w` | `--web-bundle <url>` | Use this URL to find resource files instead of the default |
| `-Z` | `-Z <option>...` | Unstable options. Pass `-Zhelp` to show a list |
6 changes: 6 additions & 0 deletions docs/src/v2cli/bundle.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The `bundle` subcommands are:

- [`tectonic -X bundle cat`](#tectonic--x-bundle-cat)
- [`tectonic -X bundle search`](#tectonic--x-bundle-search)
- [`tectonic -X bundle create`](#tectonic--x-bundle-create)


## tectonic -X bundle cat
Expand Down Expand Up @@ -71,3 +72,8 @@ be added in the future, activated by additional options.
If this command is run outside of a [document workspace](../ref/workspaces.md),
the system default bundle will be used.
## tectonic -X bundle create
Create a new bundle. See `./bundles` in the `tectonic` repository.
12 changes: 5 additions & 7 deletions docs/src/v2cli/compile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ tectonic -X compile # full form
[--reruns <count>] [-r <count>]
[--synctex]
[--untrusted]
[--web-bundle <url>] [-w <url>]
[-Z <option>...]
<input>
```
Expand Down Expand Up @@ -92,9 +91,9 @@ The following are the available flags.
<!-- Keep alphabetized by full name: -->

| Short | Full | Explanation |
|:------|:-------------------------------|:-------------------------------------------------------------------------------------------------------|
| `-b` | `--bundle <file_path>` | Use this directory or Zip-format bundle file to find resource files instead of the default |
| `-f` | `--format <path>` | The name of the "format" file used to initialize the TeX engine [default: `latex`] |
| :---- | :----------------------------- | :----------------------------------------------------------------------------------------------------- |
| `-b` | `--bundle <path or url>` | Use this bundle instead of the default |
| `-f` | `--format <path>` | The name of the “format” file used to initialize the TeX engine [default: `latex`] |
| `-h` | `--help` | Prints help information |
| | `--hide <hide_path>...` | Tell the engine that no file at `<hide_path>` exists, if it tries to read it |
| `-k` | `--keep-intermediates` | Keep the intermediate files generated during processing |
Expand All @@ -109,7 +108,6 @@ The following are the available flags.
| | `--synctex` | Generate SyncTeX data |
| | `--untrusted` | Input is untrusted — disable all known-insecure features |
| `-V` | `--version` | Prints version information |
| `-w` | `--web-bundle <url>` | Use this URL to find resource files instead of the default |
| `-Z` | `-Z <option>...` | Unstable options. Pass `-Zhelp` to show a list |

#### Unstable options
Expand All @@ -119,8 +117,8 @@ the set of unstable options is subject to change at any time.

<!-- Keep alphabetized: -->

| Expression | Explanation |
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Expression | Explanation |
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-Z help` | List all unstable options |
| `-Z continue-on-errors` | Keep compiling even when severe errors occur |
| `-Z min-crossrefs=<num>` | Equivalent to bibtex’s `-min-crossrefs` flag - "include after `<num>` crossrefs" [default: `2`] |
Expand Down

0 comments on commit a5e3416

Please sign in to comment.