CTAN Comprehensive TeX Archive Network

Direc­tory support/cluttex

README.md

Clut: Pro­cess doc­u­ment with­out clut­ter­ing your di­rec­tory

Clut is a pro­gram to au­to­mat­i­cally pro­cess your doc­u­ment. If nec­es­sary, it re-runs pro­gram to re­solve cross-ref­er­ences and ev­ery­thing.

One of its main fea­ture is that, it does not clut­ter your work­ing di­rec­tory (but the fi­nal .pdf file is still brought for you).

Blog:

Fea­tures

  • Does not clut­ter your work­ing di­rec­tory with .aux, .log, etc. files.
  • Does not prompt for in­put when there is a er­ror.
  • With p-like en­gines, au­to­mat­i­cally run dvipdfmx to pro­duce PDF file.
  • Au­to­mat­i­cally re-run to re­solve cross-ref­er­ences and other things.
  • Watch in­put files for change (re­quires an ex­ter­nal pro­gram). [--watch op­tion]
  • Sup­port for MakeIn­dex, BibTeX, Biber, makeglos­saries com­mands. [--makeindex, --bibtex, --biber, --makeglossaries op­tions]

Usage

$ cluttex -e pdflatex file.tex

More gen­eral form:

$ cluttex [OPTIONS] [--] INPUT.tex

See ex­am­ple/ for some ex­am­ples.

In­stall

Click [Clone or down­load] but­ton on GitHub and [Down­load ZIP]. Un­pack cluttex-master.zip and copy bin/cluttex (or bin/cluttex.bat on Win­dows) to some­where in PATH.

Com­mand-line Op­tions

  • -e, --engine=ENGINE Spec­ify which en­gine/for­mat to use. ENGINE is one of the fol­low­ing: pdflatex, pdftex, lualatex, luatex, luajittex, xelatex, xetex, latex, etex, tex, platex, eptex, ptex, uplatex, euptex, uptex.
  • -o, --output=FILE The name of out­put file. [de­fault: JOBNAME.FORMAT]
  • --fresh Clean in­ter­me­di­ate files be­fore run­ning . Can­not be used with --output-directory.
  • --max-iterations=N Max­i­mum num­ber of run­ning to re­solve cross-ref­er­ences. [de­fault: 3]
  • --[no-]change-directory Change the cur­rent work­ing di­rec­tory to the out­put di­rec­tory when run­ning .
  • --watch Watch in­put files for change. Re­quires fswatch pro­gram to be in­stalled.
  • --color[=WHEN] Make Clut's mes­sage col­or­ful. WHEN is one of always, auto, or never. [de­fault: auto if --color is omit­ted, always if =WHEN is omit­ted]
  • --includeonly=NAMEs Insert \includeonly{NAMEs}.
  • --make-depends=FILE Write de­pen­den­cies as a Make­file rule.
  • --tex-option=OPTION Pass OPTION to as a sin­gle op­tion.
  • --tex-options=OPTIONs Pass OPTIONs to as mul­ti­ple op­tions.
  • --dvipdfmx-option[s]=OPTION[s] Same for dvipdfmx.
  • -h, --help Print this mes­sage and exit.
  • -v, --version Print ver­sion in­for­ma­tion and exit.
  • -V, --verbose Be more ver­bose.

Op­tions to run aux­il­iary pro­grams:

  • --makeindex=COMMAND Use MakeIn­dex pro­gram to pro­cess .idx files. (e.g. --makeindex=makeindex, or --makeindex=mendex)
  • --bibtex=COMMAND Use BibTeX pro­gram to pro­duce .bbl file from .aux files. (e.g. --bibtex=bibtex, or --bibtex=upbibtex)
  • --biber[=COMMAND] Use Biber pro­gram to pro­duce .bbl file from .bcf file.
  • --makeglossaries[=COMMAND] Use makeglos­saries pro­gram to pro­duce .gls file from .glo file.

-com­pat­i­ble op­tions:

  • --[no-]shell-escape
  • --shell-restricted
  • --synctex=NUMBER
  • --[no-]file-line-error [de­fault: yes]
  • --[no-]halt-on-error [de­fault: yes]
  • --interaction=STRING (STRING=batchmode/nonstopmode/scrollmode/errorstopmode) [de­fault: nonstopmode]
  • --jobname=STRING
  • --fmt=FORMAT
  • --output-directory=DIR [de­fault: some­where in the tem­po­rary di­rec­tory]
  • --output-format=FORMAT Set out­put for­mat (pdf or dvi). [de­fault: pdf]

For -com­pat­i­ble op­tions, sin­gle-hy­pen forms are al­lowed (e.g. -synctex=1 in ad­di­tion to --synctex=1).

If run as cllualatex or clxelatex, then the de­fault en­gine is lualatex or xelatex, ac­cord­ingly.

Li­cense

This pro­gram is dis­tributed un­der GNU Gen­eral Public Li­cense, ver­sion 3.

Down­load the con­tents of this pack­age in one zip archive (700.4k).

clut­tex – An au­toma­tion tool for run­ning

This is an­other tool for the au­toma­tion of doc­u­ment pro­cess­ing, like la­texmk or arara.

The main fea­ture of this tool is that it does not clut­ter your work­ing di­rec­tory with .aux or .log or other aux­il­iary files.

It has of course the usual fea­tures of au­toma­tion tools: It au­to­mat­i­cally re-runs for cross-ref­er­ences. MakeIn­dex, BibTeX, Biber, or makeglos­saries will be ex­e­cuted if a cor­re­spond­ing op­tion is set. Fur­ther­more, clut­tex can watch in­put files for changes (us­ing an ex­ter­nal pro­gram).

Pack­ageclut­tex
Bug trackerhttps://github.com/mi­noki/clut­tex/is­sues
Re­pos­i­toryhttps://github.com/mi­noki/clut­tex
Ver­sion0.2 2019-02-22
Li­censesGNU Gen­eral Public Li­cense, ver­sion 3
Copy­right2016, 2018–2019 ARATA Mizuki
Main­tainerMizuki Arata
Con­tained inTeX Live as clut­tex
MiKTeX as clut­tex
TopicsUse Lua
Com­pi­la­tion
...
Guest Book Sitemap Contact Contact Author