Форматирование. LaTeX. tex-fmt

2025-11-15 · 3 мин. для прочтения

Форматирование. LaTeX. tex-fmt.

Содержание

1 Общая информация

2 Установка

2.1 Gentoo

3 Отключение форматирования

  • Завершение исходной строки на % tex-fmt: skip отключает форматирование для этой строки.
  • Чтобы отключить форматирование для блока, используйте % tex-fmt: off и % tex-fmt: on.
\documentclass{article}

\begin{document}

    This line is skipped % tex-fmt: skip

% tex-fmt: off
  These lines are also
    not formatted or wrapped
% tex-fmt: on

\end{document}

Среды Verbatim, включая verbatim, Verbatim, lstlisting и minted

4 Файл конфигурации

  • Явно указанный файл конфигурации:
    • если вы укажете путь к файлу конфигурации с помощью tex-fmt --config <PATH>, будет использоваться этот файл.
  • Текущий рабочий каталог:
    • файл с именем tex-fmt.toml в каталоге, где выполняется tex-fmt.
  • Корневой каталог Git-репозитория:
    • файл с именем tex-fmt.toml в корневом каталоге текущего Git-репозитория.
  • Каталог конфигурации пользователя:
    • Файл с именем tex-fmt.toml в подкаталоге tex-fmt/ каталога конфигурации пользователя:
      • Linux: ~/.config/tex-fmt/tex-fmt.toml
      • macOS: /Users/<user>/Library/Application Support/tex-fmt/tex-fmt.toml
      • Windows: C:\Users\<user>\AppData\Roaming\tex-fmt\tex-fmt.toml
  • Можно игнорировать все файлы конфигурации, используя флаг --noconfig.

5 Параметры командной строки

  • В командной строке можно передать следующие аргументы.
ВариантПсевдонимПо умолчаниюОписание
--check-cПроверьте форматирование, не изменяйте файлы.
--print-pВыводить на стандартный вывод, не изменять файлы
--fail-on-change-fОшибка, если файлы были изменены
--recursive-rРекурсивный поиск файлов для форматирования
--nowrap-nНе переносите длинные строки
--wraplen <N>-l80Длина строки для переноса
--tabsize <N>-t2Количество символов, используемых в качестве размера табуляции
--usetabsИспользуйте табуляции вместо пробелов для отступов.
--stdin-sОбрабатывать stdin как один файл, выводить на stdout
--config <PATH>Путь к файлу конфигурации
--noconfigНе читайте ни один файл конфигурации
--verbose-vПоказывать информационные сообщения
--quiet-qСкрыть предупреждающие сообщения
--traceПоказать сообщения трассировки
--completion <SHELL>Сгенерировать скрипт завершения оболочки
--manСоздать страницу руководства
--argsПросмотреть аргументы, переданные в tex-fmt
--help-hРаспечатать справку
--version-VВерсия для печати

6 Параметры файла конфигурации

  • Файл конфигурации: tex-fmt.toml.
  • Первый пример в каждой строке есть значение по умолчанию.
ВариантТипПримерыОписание
checkboolfalseПроверьте форматирование, не изменяйте файлы.
printboolfalseВыводить на стандартный вывод, не изменять файлы
fail-on-changeboolfalseОшибка, если файлы были изменены
wrapbooltrueПереносить длинные строки
wraplenint80, 100Длина строки для переноса
wrapminint70, 90Минимальная целевая длина для переноса строк
tabsizeint2, 4Количество символов, используемых в качестве размера табуляции
tabcharstr"space", "tab"Символ, используемый для отступа
stdinboolfalseОбрабатывать stdin как один файл, выводить на stdout
listsarr[str][], ["myitemize"]Дополнительный список сред, которые нужно отформатировать как itemize
verbatimsarr[str][], ["myverbatim"]Дополнительные дословные среды
no-indent-envsarr[str][], ["mydocument"]Среды без отступов
wrap-charsarr[str][], ["。"]Символы, после которых возможен перенос строк
verbositystr."warn", "error"Уровень детализации для терминального журнала

7 Пример файла конфигурации

  • Возможный файл конфигурации tex-fmt.toml:
    # tex-fmt.toml
    check = false
    print = false
    wrap = true
    wraplen = 80
    tabsize = 2
    tabchar = "space"
    stdin = false
    verbosity = "warn"
    lists = []
    no-indent-envs = []
    
Дмитрий Сергеевич Кулябов
Authors
Профессор кафедры теории вероятностей и кибербезопасности
Мои научные интересы включают физику, администрирование Unix и сетей.