From 2a7b1d489adf0499b0e38c93f57c1d14ec822f32 Mon Sep 17 00:00:00 2001 From: William G Underwood <42812654+WGUNDERWOOD@users.noreply.github.com> Date: Fri, 25 Oct 2024 16:36:26 +0100 Subject: [PATCH] Add flags to README --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f65bced..c2c3d0e 100644 --- a/README.md +++ b/README.md @@ -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. |