PyTeXMK

GitHub License OS GitHub release Last Commit Issues Github Action PyPI version PyPI Downloads GitHub repo size

LaTeX 辅助编译命令行程序 LaTeX Auxiliary Compilation Command Line Tool

安装

官方版本 PyTeXMK 发布在 PyPI 上，并且可以通过 pip 包管理器从 PyPI 镜像轻松安装。

请注意，您必须使用 Python 3 版本pip：

pip3 install pytexmk

升级 

pip3 install --upgrade pytexmk

使用入门

PyTeXMK 默认参数：xelatex 编译、待编译主文件名 main.tex、batch 模式（编译过程信息不显，如需显示编译过程信息请使用 -uq 参数）、编译结果存放在 LaTeX 项目的 Build 文件夹下 ( VSCode 用户则需要在 settings.json 中注意设置 "latex-workshop.latex.outDir": "./Build", 使得 LaTeX-Workshop 能够找到 pdf )、辅助文件存放在 LaTeX 项目的 Auxiliary 文件夹下。

请仔细阅读：待编译主文件及编译类型选定逻辑

PyTeXMK，仅支持 utf-8 编码的 TeX 文件。

编译命令

PyTeXMK 支持：

位置参数:

Option Description
document 要被编译的文件名

选项:

Option Description
-h, --help 显示帮助信息
-v, --version 显示程序版本号
-p, --pdflatex pdflatex 进行编译
-x, --xelatex xelatex 进行编译
-l, --lualatex lualatex 进行编译
-c, --clean 清除所有主文件的辅助文件
-C, --Clean 清除所有主文件的辅助文件（包含根目录）和输出文件
-ca, --clean-any 清除所有带辅助文件后缀的文件
-Ca, --Clean-any 清除所有带辅助文件后缀的文件（包含根目录）和主文件输出文件
-uq, --unquiet 非安静模式运行，此模式下显示编译过程
-vb, --verbose 显示 PyTeXMK 运行过程中的详细信息
-pr, --pdf-repair 修复所有根目录以外的 pdf 文件

说明：
-pr 参数的功能是 "当 LaTeX 编译过程中报类似 invalid X X R object at offset XXXXX 的警告时，可使用此参数尝试修复所有 pdf 文件"
invalid X X R object at offset XXXXX 警告的出现是由于 PDF 图片文件在创建、编辑或传输过程中发生了某种形式的损坏或非法操作导致的，可能的原因包括文件部分内容缺失、xref表损坏、或者是文件结构中的其他问题

魔法注释

PyTeXMK 支持使用魔法注释来自定义编译命令、编译类型、编译结果存放位置等（仅支持检索文档前 50 行）。

Magic Comment Description
% !TEX program = xelatex 指定编译类型，可选 xelatex pdflatex lualatex
% !TEX root = file.tex 指定待编译 LaTeX 文件名，仅支持主文件在项目根目录下的情况
% !TEX outdir = PDFfile 指定编译结果存放位置，仅支持文件夹名称
% !TEX auxdir = auxfiles 指定辅助文件存放位置，仅支持文件夹名称

魔法注释仅支持在主文件中定义，不支持在子文件中定义。

待编译主文件及编译类型选定逻辑

未来工作方向