{"id":21202676,"url":"https://github.com/minoki/cluttex","last_synced_at":"2025-07-10T06:33:15.676Z","repository":{"id":43097295,"uuid":"76929745","full_name":"minoki/cluttex","owner":"minoki","description":"Process LaTeX documents without cluttering your working directory","archived":false,"fork":false,"pushed_at":"2024-09-10T00:38:43.000Z","size":3725,"stargazers_count":45,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-09-10T04:22:51.809Z","etag":null,"topics":["latex","tex"],"latest_commit_sha":null,"homepage":"","language":"Standard ML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minoki.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-20T06:29:16.000Z","updated_at":"2024-09-02T01:21:27.000Z","dependencies_parsed_at":"2022-09-05T23:41:12.877Z","dependency_job_id":"a441c039-8924-43f6-bea8-e8a970f257f7","html_url":"https://github.com/minoki/cluttex","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoki%2Fcluttex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoki%2Fcluttex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoki%2Fcluttex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoki%2Fcluttex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minoki","download_url":"https://codeload.github.com/minoki/cluttex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225622825,"owners_count":17498170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["latex","tex"],"created_at":"2024-11-20T20:17:38.523Z","updated_at":"2025-07-10T06:33:15.661Z","avatar_url":"https://github.com/minoki.png","language":"Standard ML","funding_links":[],"categories":[],"sub_categories":[],"readme":"ClutTeX: Process LaTeX document without cluttering your directory\n=====\n\nClutTeX is a program to automatically process your LaTeX document.\nIf necessary, it re-runs (La)TeX program to resolve cross-references and everything.\n\nOne of its main feature is that, it does not clutter your working directory (but the final `.pdf` file is still brought for you).\n\nBlog:\n\n* [TeX 実行の自動化ツールを作った (ClutTeX)](https://blog.miz-ar.info/2016/12/cluttex/)\n* [LaTeX処理自動化ツール ClutTeX をリリースした](https://blog.miz-ar.info/2018/10/cluttex-release/)\n\nFeatures\n-----\n\n* Does not clutter your working directory with `.aux`, `.log`, etc. files.\n* Does not prompt for input when there is a (La)TeX error.\n* With pTeX-like engines, automatically run dvipdfmx to produce PDF file.\n* Automatically re-run (La)TeX to resolve cross-references and other things.\n* Watch input files for change (requires an external program). \\[`--watch` option\\]\n* Support for MakeIndex, BibTeX, Biber, makeglossaries commands. \\[`--makeindex`, `--bibtex`, `--biber`, `--makeglossaries` options\\]\n\nUsage\n-----\n\n`$ cluttex -e pdflatex file.tex`\n\nMore general form:\n\n`$ cluttex [OPTIONS] [--] INPUT.tex`\n\nSee [example/](example/) for some examples.\n\nInstall\n-----\n\nClutTeX is included in [TeX Live](https://tug.org/texlive/).\n\nIf you want to install it manually, go [Releases](https://github.com/minoki/cluttex/releases) page and download the latest archive (zip or tar.gz). Unpack the archive and copy `bin/cluttex` to somewhere in PATH.\n\nCommand-line Options\n-----\n\n* `-e`, `--engine=ENGINE`\n  Specify which TeX engine/format to use.\n  `ENGINE` is one of the following:\n    `pdflatex`, `pdftex`,\n    `lualatex`, `luatex`, `luajittex`,\n    `xelatex`, `xetex`,\n    `latex`, `etex`, `tex`,\n    `platex`, `eptex`, `ptex`,\n    `uplatex`, `euptex`, `uptex`.\n* `-o`, `--output=FILE`\n  The name of output file.  \\[default: `JOBNAME.FORMAT`\\]\n* `--fresh`\n  Clean intermediate files before running TeX.\n  Cannot be used with `--output-directory`.\n* `--max-iterations=N`\n  Maximum number of running TeX to resolve cross-references.\n  \\[default: 4\\]\n* `--[no-]change-directory`\n  Change the current working directory to the output directory when running TeX.\n* `--watch[=ENGINE]`\n  Watch input files for change.\n  Requires [fswatch](http://emcrisostomo.github.io/fswatch/) program or `inotifywait` program to be installed on Unix systems.\n* `--color[=WHEN]`\n  Make ClutTeX's message colorful.\n  `WHEN` is one of `always`, `auto`, or `never`.\n  \\[default: `auto` if `--color` is omitted, `always` if `=WHEN` is omitted\\]\n* `--includeonly=NAMEs`\n  Insert `\\includeonly{NAMEs}`.\n* `--make-depends=FILE`\n  Write dependencies as a Makefile rule.\n* `--tex-option=OPTION`\n  Pass `OPTION` to TeX as a single option.\n* `--tex-options=OPTIONs`\n  Pass `OPTIONs` to TeX as multiple options.\n* `--dvipdfmx-option[s]=OPTION[s]`\n  Same for dvipdfmx.\n* `-h`, `--help`\n  Print this message and exit.\n* `-v`, `--version`\n  Print version information and exit.\n* `-V`, `--verbose`\n  Be more verbose.\n* `--print-output-directory`\n  Print the output directory and exit.\n* `--package-support=PKG1[,PKG2,...,PKGn]`\n  Enable special support for shell-escaping packages.\n  Currently supported packages are `minted` and `epstopdf`.\n* `--engine-executable=COMMAND`\n  The actual TeX command to use.\n* `--check-driver=DRIVER`\n  Check that the correct driver file is loaded.\n  `DRIVER` is one of `dvipdfmx`, `dvips`, `dvisvgm`.\n  Can only be used with `--output-format=dvi`.\n* `--config-file=FILE`\n  Use the specified config file.\n\nOptions to run auxiliary programs:\n\n* `--makeindex=COMMAND`\n  Use MakeIndex program to process `.idx` files.\n  (e.g. `--makeindex=makeindex`, or `--makeindex=mendex`)\n* `--bibtex=COMMAND`\n  Use BibTeX program to produce `.bbl` file from `.aux` files.\n  (e.g. `--bibtex=bibtex`, or `--bibtex=upbibtex`)\n* `--biber[=COMMAND]`\n  Use Biber program to produce `.bbl` file from `.bcf` file.\n* `--makeglossaries[=COMMAND]`\n  Use makeglossaries program to produce `.gls` file from `.glo` file.\n\nTeX-compatible options:\n\n* `--[no-]shell-escape`\n* `--shell-restricted`\n* `--synctex=NUMBER`\n* `--[no-]file-line-error`\n  \\[default: yes\\]\n* `--[no-]halt-on-error`\n  \\[default: yes\\]\n* `--interaction=STRING`\n  (`STRING`=`batchmode`/`nonstopmode`/`scrollmode`/`errorstopmode`)\n  \\[default: `nonstopmode`\\]\n* `--jobname=STRING`\n* `--fmt=FORMAT`\n* `--output-directory=DIR`\n  \\[default: somewhere in the temporary directory\\]\n* `--output-format=FORMAT`\n  Set output format (`pdf` or `dvi`).\n  \\[default: `pdf`\\]\n\nFor TeX-compatible options, single-hypen forms are allowed (e.g. `-synctex=1` in addition to `--synctex=1`).\n\nIf run as `cllualatex` or `clxelatex`, then the default engine is `lualatex` or `xelatex`, accordingly.\n\nLicense\n-----\n\nThis program is distributed under GNU General Public License, version 3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminoki%2Fcluttex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminoki%2Fcluttex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminoki%2Fcluttex/lists"}