Command-line interface#

Main executable#

The one-stop-shop for LaTeX checking.

usage: latexbuddy [-h] [--version] [--verbose] [--config CONFIG]
                  [--output OUTPUT] [--language LANGUAGE]
                  [--whitelist WHITELIST]
                  [--format {HTML,html,JSON,json,HTML_FLASK,html_flask}]
                  [--enable-modules ENABLE_MODULES | --disable-modules DISABLE_MODULES]
                  file [file ...]

Positional Arguments#

file: File(s) that will be processed.

Named Arguments#

--version, -V

show program’s version number and exit

--verbose, -v

Display debug output

Default: 0

--config, -c

Location of the config file.

Default: config.py

--output, -o

Directory, in which to put the output file.

--language, -l

Target language of the file.

--whitelist, -w

Location of the whitelist file.

--format, -f

Possible choices: HTML, html, JSON, json, HTML_FLASK, html_flask

Format of the output file (either HTML or JSON).

--enable-modules

Comma-separated list of module names that should be executed. (Any other module will be implicitly disabled!)

--disable-modules

Comma-separated list of modules that should be disabled. (Every other module will be implicitly enabled!)

More documentation at <https://latexbuddy.readthedocs.io/>.

Whitelist operations#

Perform whitelist operations.

usage: latexbuddy-whitelist [-h] [--whitelist WHITELIST]
                            {add,from-wordlist} ...

Named Arguments#

--whitelist, -w

Location of the whitelist file.

Default: ./whitelist

Sub-commands#

add#

Add keys to the whitelist.

latexbuddy-whitelist add [-h] KEY [KEY ...]

Positional Arguments#

KEY: Keys that should be added to whitelist. Ideally, they should have been copied from the HTML output

from-wordlist#

Read allowed words and add them to whitelist.

latexbuddy-whitelist from-wordlist [-h] WORD_LIST LANGUAGE

Positional Arguments#

WORD_LIST: Path to the wordlist file. It should contain one word per line.
LANGUAGE: Language of the words in the wordlist