| 1 |
.Dd March 16, 2025 |
| 2 |
.Dt CLUTTEX 1 |
| 3 |
.Os |
| 4 |
.Sh NAME |
| 5 |
.Nm cluttex |
| 6 |
.Nd a tool for processing TeX files |
| 7 |
.Sh SYNOPSIS |
| 8 |
.Nm |
| 9 |
.Fl e |
| 10 |
.Ar ENGINE |
| 11 |
.Op options |
| 12 |
.Op Fl \- |
| 13 |
.Ar FILE.tex |
| 14 |
.Sh DESCRIPTION |
| 15 |
Process TeX files without cluttering your working directory. |
| 16 |
.Pp |
| 17 |
The following options are accepted: |
| 18 |
.Bl -tag -width Ds |
| 19 |
.It Fl e , Fl \-engine Ns = Ns Ar ENGINE |
| 20 |
Specify which TeX engine to use. |
| 21 |
.Ar ENGINE |
| 22 |
is one of the following: |
| 23 |
pdflatex, pdftex, |
| 24 |
lualatex, luatex, luajittex, |
| 25 |
xelatex, xetex, latex, etex, tex, |
| 26 |
platex, eptex, ptex, |
| 27 |
uplatex, euptex, uptex, |
| 28 |
.It Fl \-engine\-executable Ns = Ns Ar COMMAND+OPTIONs |
| 29 |
The actual TeX command to use. |
| 30 |
[default: |
| 31 |
.Ar ENGINE ] |
| 32 |
.It Fl o , Fl \-output Ns = Ns Ar FILE |
| 33 |
The name of output file. |
| 34 |
[default: |
| 35 |
.Ar JOBNAME Ns |
| 36 |
\&.pdf or |
| 37 |
.Ar JOBNAME Ns |
| 38 |
\&.dvi] |
| 39 |
.It Fl \-fresh |
| 40 |
Clean intermediate files before running TeX. |
| 41 |
Cannot be used with --output-directory. |
| 42 |
.It Fl \-max-iterations Ns = Ns Ar N |
| 43 |
Maximum number of running TeX to resolve cross-references. |
| 44 |
[default: 4] |
| 45 |
.It Fl \-start-with-draft |
| 46 |
Start with draft mode. |
| 47 |
.It Fl \-change-directory , Fl \-no-change-directory |
| 48 |
Change directory before running TeX. |
| 49 |
[default: no] |
| 50 |
.It Fl \-watch Ns Op = Ns Ar ENGINE |
| 51 |
Watch input files for change. |
| 52 |
Requires fswatch or inotifywait to be installed. |
| 53 |
.Ar ENGINE |
| 54 |
is one of |
| 55 |
.Sq fswatch , |
| 56 |
.Sq inotifywait |
| 57 |
or |
| 58 |
.Sq auto . |
| 59 |
[default: auto] |
| 60 |
.It Fl \-tex-option Ns = Ns Ar OPTION |
| 61 |
Pass |
| 62 |
.Ar OPTION |
| 63 |
to TeX as a single option. |
| 64 |
.It Fl \-tex-options Ns = Ns Ar OPTIONs |
| 65 |
Pass |
| 66 |
.Ar OPTIONs |
| 67 |
to TeX as multiple options. |
| 68 |
.It Fl \-dvipdfmx-option Ns = Ns Ar OPTION , Fl \-dvipdfmx-options Ns = Ns Ar OPTIONs |
| 69 |
Same for dvipdfmx. |
| 70 |
.It Fl \-makeindex Ns = Ns Ar COMMAND+OPTIONs |
| 71 |
Command to generate index, such as |
| 72 |
.Sq makeindex |
| 73 |
or |
| 74 |
.Sq mendex . |
| 75 |
.It Fl \-bibtex Ns = Ns Ar COMMAND+OPTIONs |
| 76 |
Command for BibTeX, such as |
| 77 |
.Sq bibtex |
| 78 |
or |
| 79 |
.Sq pbibtex . |
| 80 |
.It Fl \-biber Ns Op = Ns Ar COMMAND+OPTIONs |
| 81 |
Command for Biber. |
| 82 |
.It Fl \-makeglossaries Ns Op = Ns Ar COMMAND+OPTIONs |
| 83 |
Command for makeglossaries. |
| 84 |
.It Fl h , Fl \-help |
| 85 |
Print this message and exit. |
| 86 |
.It Fl v , Fl \-version |
| 87 |
Print version information and exit. |
| 88 |
.It Fl V , Fl \-verbose |
| 89 |
Be more verbose. |
| 90 |
.It Fl \-color Ns Op = Ns Ar WHEN |
| 91 |
Make ClutTeX's message more colorful. |
| 92 |
.Ar WHEN |
| 93 |
is one of |
| 94 |
.Sq always , |
| 95 |
.Sq auto , |
| 96 |
or |
| 97 |
.Sq never . |
| 98 |
[default: |
| 99 |
.Sq auto |
| 100 |
if Fl \-color is omitted, |
| 101 |
.Sq always |
| 102 |
if |
| 103 |
.Ar WHEN |
| 104 |
is omitted] |
| 105 |
.It Fl \-includeonly Ns = Ns Ar NAMEs |
| 106 |
Insert |
| 107 |
.Sq \eincludeonly{ Ns Ar NAMEs Ns } . |
| 108 |
.It Fl \-make-depends Ns = Ns Ar FILE |
| 109 |
Write dependencies as a Makefile rule. |
| 110 |
.It Fl \-print\-output\-directory |
| 111 |
Print the output directory and exit. |
| 112 |
.It Fl \-package\-support Ns = Ns Ar PKG1 Ns Op , Ns Ar PKG2 Ns ,... |
| 113 |
Enable special support for some shell-escaping packages. |
| 114 |
Currently supported: minted, epstopdf. |
| 115 |
.It Fl \-check\-driver Ns = Ns Ar DRIVER |
| 116 |
Check that the correct driver file is loaded. |
| 117 |
.Ar DRIVER |
| 118 |
is one of |
| 119 |
.Sq dvipdfmx , |
| 120 |
.Sq dvips , |
| 121 |
.Sq dvisvgm . |
| 122 |
.It Fl \-source\-date\-epoch Ns = Ns Ar TIME |
| 123 |
Set |
| 124 |
.Sq SOURCE_DATE_EPOCH |
| 125 |
variable to |
| 126 |
.Ar TIME . |
| 127 |
.Ar TIME |
| 128 |
can be |
| 129 |
.Sq now |
| 130 |
to auto-detect. |
| 131 |
.It Fl \-config-file Ns = Ns Ar FILE |
| 132 |
Use the specified config file. |
| 133 |
.It Fl \-shell-escape , Fl \-no-shell-escape |
| 134 |
.It Fl \-shell-restricted |
| 135 |
.It Fl \-synctex Ns = Ns Ar NUMBER |
| 136 |
.It Fl \-fmt Ns = Ns Ar FMTNAME |
| 137 |
.It Fl \-file-line-error , Fl \-no-file-line-error |
| 138 |
[default: yes] |
| 139 |
.It Fl \-halt-on-error , Fl \-no-halt-on-error |
| 140 |
[default: yes] |
| 141 |
.It Fl \-interaction Ns = Ns Ar STRING |
| 142 |
[default: nonstopmode] |
| 143 |
.It Fl \-jobname Ns = Ns Ar STRING |
| 144 |
.It Fl \-output-directory Ns = Ns Ar DIR |
| 145 |
[default: somewhere in the temporary directory] |
| 146 |
.It Fl \-output-format Ns = Ns Ar FORMAT |
| 147 |
.Ar FORMAT |
| 148 |
is |
| 149 |
.Sq pdf |
| 150 |
or |
| 151 |
.Sq dvi . |
| 152 |
[default: pdf] |
| 153 |
.El |
| 154 |
.Sh EXIT STATUS |
| 155 |
.Ex -std |