CLUTTEX(1)

💖 CLUTTEX 💖

okay bestie, sit down, hydrate, because we're about to talk about cluttex — that's the section 1 manual page, general commands, the whole vibe. it's a tool for processing TeX files and it is literally the moment. no cap. 🎀

---

✨ NAME ✨

cluttex — a tool for processing TeX files 🦋

---

🌸 SYNOPSIS 🌸

cluttex -e ENGINE [options] [--] FILE.tex

that's it. that's the whole entrance. main character energy from line one. 👑

---

💅 DESCRIPTION 💅

Process TeX files without cluttering your working directory. that's the entire point of this icon, and honestly? obsessed. it's giving "my desk is clean and my soul is clean." ✨

The following options are accepted:

• -e, --engine=ENGINE — tell cluttex which TeX engine to use. ENGINE is one of the following: pdflatex, pdftex, lualatex, luatex, luajittex, xelatex, xetex, latex, etex, tex, platex, eptex, ptex, uplatex, euptex, uptex, — yes bestie, that trailing comma is right there in the original and we are respecting it, periodt. 💜
• --engine-executable=COMMAND+OPTIONs — the actual TeX command to use. [default: ENGINE]
• -o, --output=FILE — the name of output file. [default: JOBNAME.pdf or JOBNAME.dvi]
• --fresh — clean intermediate files before running TeX. 🧼 Cannot be used with --output-directory.

⚠️ fr fr: --fresh and --output-directory are not a thing together. pick one, bestie.

• --max-iterations=N — maximum number of running TeX to resolve cross-references. [default: 4]
• --start-with-draft — start with draft mode. ✍️
• --change-directory, --no-change-directory — change directory before running TeX. [default: no]
• --watch[=ENGINE] — watch input files for change. 👀 Requires fswatch or inotifywait to be installed. ENGINE is one of ‘fswatch’, ‘inotifywait’ or ‘auto’. [default: auto]
• --tex-option=OPTION — pass OPTION to TeX as a single option.
• --tex-options=OPTIONs — pass OPTIONs to TeX as multiple options.
• --dvipdfmx-option=OPTION, --dvipdfmx-options=OPTIONs — same for dvipdfmx. 💫
• --makeindex=COMMAND+OPTIONs — command to generate index, such as ‘makeindex’ or ‘mendex’.
• --bibtex=COMMAND+OPTIONs — command for BibTeX, such as ‘bibtex’ or ‘pbibtex’.
• --biber[=COMMAND+OPTIONs] — command for Biber.
• --makeglossaries[=COMMAND+OPTIONs] — command for makeglossaries.
• -h, --help — print this message and exit. 🫶
• -v, --version — print version information and exit.
• -V, --verbose — be more verbose. 🗣️
• --color[=WHEN] — make ClutTeX's message more colorful. WHEN is one of ‘always’, ‘auto’, or ‘never’. [default: ‘auto’ if Fl -color is omitted, ‘always’ if WHEN is omitted] 🌈
• --includeonly=NAMEs — insert ‘\includeonly{NAMEs}’.
• --make-depends=FILE — write dependencies as a Makefile rule.
• --print-output-directory — print the output directory and exit.
• --package-support=PKG1[,PKG2,...] — enable special support for some shell-escaping packages. Currently supported: minted, epstopdf.
• --check-driver=DRIVER — check that the correct driver file is loaded. DRIVER is one of ‘dvipdfmx’, ‘dvips’, ‘dvisvgm’.
• --source-date-epoch=TIME — set ‘SOURCE_DATE_EPOCH’ variable to TIME. TIME can be ‘now’ to auto-detect. ⏰
• --config-file=FILE — use the specified config file.
• --shell-escape, --no-shell-escape
• --shell-restricted
• --synctex=NUMBER
• --fmt=FMTNAME
• --file-line-error, --no-file-line-error — [default: yes]
• --halt-on-error, --no-halt-on-error — [default: yes]
• --interaction=STRING — [default: nonstopmode]
• --jobname=STRING
• --output-directory=DIR — [default: somewhere in the temporary directory] 🗂️
• --output-format=FORMAT — FORMAT is ‘pdf’ or ‘dvi’. [default: pdf]

---

🔥 EXIT STATUS 🔥

the cluttex utility exits 0 on success, and >0 if an error occurs.

so like — 0 means slay, anything above 0 means something went sideways. 💀

---

and that's the whole page, bestie!! this one came from the Debian crew and it's dated March 16, 2025 — so shoutout to them for shipping this on that day, we love a timestamped moment. 🎀✨ go compile something gorgeous. 💜