Skip to content

Commit

Permalink
Add flags to README
Browse files Browse the repository at this point in the history
  • Loading branch information
WGUNDERWOOD committed Oct 25, 2024
1 parent e65e8fa commit 2a7b1d4
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,18 +230,19 @@ Visual Studio plugin, uses latexindent as the backend

## Options

The following options are offered by tex-fmt:

| Option | Default | Description |
| --- | --- | --- |
| `check` | | Check formatting, do not modify files. |
| `print` | | Print to STDOUT, do not modify files. |
| `keep` | | Keep lines, do not wrap. |
| `verbose` | | Show info log messages. |
| `quiet` | | Hide warning messages. |
| `trace` | | Show trace log messages. |
| `stdin` | | Process STDIN as a single file, output formatted text to STDOUT. |
| `tab` | `2` | Number of spaces to use as tab size. |
| `usetabs` | | Use tabs instead of spaces for indentation. |
| `wrap` | `80` | Line length for wrapping. |

The following command-line options are offered by tex-fmt.

| Option | Alias | Default | Description |
| ----------- | ----- | ------- | --- |
| `--check` | `-c` | | Check formatting, do not modify files. |
| `--print` | `-p` | | Print to STDOUT, do not modify files. |
| `--keep` | `-k` | | Keep lines, do not wrap. |
| `--verbose` | `-v` | | Show info log messages. |
| `--quiet` | `-q` | | Hide warning messages. |
| `--trace` | `-t` | | Show trace log messages. |
| `--stdin` | `-s` | | Process STDIN as a single file, output formatted text to STDOUT. |
| `--tab` | | `2` | Number of spaces to use as tab size. |
| `--usetabs` | | | Use tabs instead of spaces for indentation. |
| `--wrap` | | `80` | Line length for wrapping. |
| `--help` | `-h` | | Print help. |
| `--version` | `-V` | | Print version. |

0 comments on commit 2a7b1d4

Please sign in to comment.