summaryrefslogtreecommitdiff
path: root/support/cluttex/doc
diff options
context:
space:
mode:
Diffstat (limited to 'support/cluttex/doc')
-rw-r--r--support/cluttex/doc/Makefile7
-rw-r--r--support/cluttex/doc/cluttex-ja.pdfbin152472 -> 153918 bytes
-rw-r--r--support/cluttex/doc/cluttex-ja.tex25
-rw-r--r--support/cluttex/doc/cluttex.1144
-rw-r--r--support/cluttex/doc/cluttex.pdfbin193671 -> 193818 bytes
-rw-r--r--support/cluttex/doc/cluttex.tex7
6 files changed, 175 insertions, 8 deletions
diff --git a/support/cluttex/doc/Makefile b/support/cluttex/doc/Makefile
index 0685cc8c58..2260a0079a 100644
--- a/support/cluttex/doc/Makefile
+++ b/support/cluttex/doc/Makefile
@@ -1,4 +1,4 @@
-all: cluttex.pdf cluttex-ja.pdf
+all: cluttex.pdf cluttex-ja.pdf lint-manual
cluttex.pdf: cluttex.tex
cluttex -e pdflatex -o $@ --make-depends=cluttex.pdf.dep $<
@@ -10,7 +10,10 @@ clean-outdir:
-rm -rf $(shell cluttex -e pdflatex --print-output-directory cluttex.tex)
-rm -rf $(shell cluttex -e lualatex --print-output-directory cluttex-ja.tex)
-.PHONY: all clean-outdir
+lint-manual:
+ mandoc -Tlint cluttex.1
+
+.PHONY: all clean-outdir lint-manual
-include cluttex.pdf.dep
-include cluttex-ja.pdf.dep
diff --git a/support/cluttex/doc/cluttex-ja.pdf b/support/cluttex/doc/cluttex-ja.pdf
index c9f0750252..d8b98c15c9 100644
--- a/support/cluttex/doc/cluttex-ja.pdf
+++ b/support/cluttex/doc/cluttex-ja.pdf
Binary files differ
diff --git a/support/cluttex/doc/cluttex-ja.tex b/support/cluttex/doc/cluttex-ja.tex
index b4742ee4ee..3e79bccb8c 100644
--- a/support/cluttex/doc/cluttex-ja.tex
+++ b/support/cluttex/doc/cluttex-ja.tex
@@ -11,9 +11,27 @@
\crefformat{section}{#2セクション#1#3}
\crefformat{subsection}{#2サブセクション#1#3}
-\title{\ClutTeX{}マニュアル\\(バージョン0.5.1)}
+\ltjsetparameter{
+ alxspmode={`\-,allow},
+ alxspmode={`\\,allow},
+ alxspmode={`\.,allow},
+ alxspmode={`\{,preonly},
+ alxspmode={`\},postonly},
+ alxspmode={`\_,allow},
+ alxspmode={`\$,allow},
+ alxspmode={`\!,allow},
+ alxspmode={`\*,allow},
+ alxspmode={`\^,allow},
+ alxspmode={`\:,allow},
+ alxspmode={`\#,allow},
+ alxspmode={`\/,allow},
+ alxspmode={`\<,preonly},
+ alxspmode={`\>,postonly},
+}
+
+\title{\ClutTeX{}マニュアル\\(バージョン0.6)}%VERSION
\author{ARATA Mizuki}
-\date{2021年11月4日}
+\date{2023年11月18日}
\begin{document}
\maketitle
@@ -72,7 +90,7 @@
\item[\texttt{--max-iterations=\metavar{N}}]
相互参照の解決等のために最大何回処理を行うかを指定する。
デフォルト:3
-\item[\texttt{--watch}]
+\item[\texttt{--watch[=\metavar{ENGINE}]}]
入力ファイルを監視する。
別途、\texttt{fswatch}プログラムまたは\texttt{inotifywait}プログラムが必要となる場合がある。
詳しくは\cref{sec:watch-mode}を参照。
@@ -162,6 +180,7 @@
Windows上では、\ClutTeX{}単体でファイルシステムの監視を行う。
一方で、それ以外のOS(Unix系)では、\texttt{fswatch}\footnote{\url{http://emcrisostomo.github.io/fswatch/}}プログラムまたは\texttt{inotifywait}プログラムが予めインストールされている必要がある。
+補助プログラムは自動検出されるが、\metavar{ENGINE}引数で明示的に指定することもできる。
\section{MakeIndexや\BibTeX}
MakeIndexや\BibTeX を使って処理を行う場合は、\texttt{--makeindex}や\texttt{--bibtex}等のオプションを指定する。
diff --git a/support/cluttex/doc/cluttex.1 b/support/cluttex/doc/cluttex.1
new file mode 100644
index 0000000000..ab6c60f19d
--- /dev/null
+++ b/support/cluttex/doc/cluttex.1
@@ -0,0 +1,144 @@
+.Dd November 18, 2023
+.Dt CLUTTEX 1
+.Os
+.Sh NAME
+.Nm cluttex
+.Nd a tool for processing TeX files
+.Sh SYNOPSIS
+.Nm
+.Fl e
+.Ar ENGINE
+.Op options
+.Op Fl \-
+.Ar FILE.tex
+.Sh DESCRIPTION
+Process TeX files without cluttering your working directory.
+.Pp
+The following options are accepted:
+.Bl -tag -width Ds
+.It Fl e , Fl \-engine Ns = Ns Ar ENGINE
+Specify which TeX engine to use.
+.Ar ENGINE
+is one of the following:
+pdflatex, pdftex,
+lualatex, luatex, luajittex,
+xelatex, xetex, latex, etex, tex,
+platex, eptex, ptex,
+uplatex, euptex, uptex,
+.It Fl \-engine\-executable Ns = Ns Ar COMMAND+OPTIONs
+The actual TeX command to use.
+[default:
+.Ar ENGINE ]
+.It Fl o , Fl \-output Ns = Ns Ar FILE
+The name of output file.
+[default:
+.Ar JOBNAME Ns
+\&.pdf or
+.Ar JOBNAME Ns
+\&.dvi]
+.It Fl \-fresh
+Clean intermediate files before running TeX.
+Cannot be used with --output-directory.
+.It Fl \-max-iterations Ns = Ns Ar N
+Maximum number of running TeX to resolve cross-references.
+[default: 3]
+.It Fl \-start-with-draft
+Start with draft mode.
+.It Fl \-change-directory , Fl \-no-change-directory
+Change directory before running TeX.
+[default: no]
+.It Fl \-watch Ns Op = Ns Ar ENGINE
+Watch input files for change.
+Requires fswatch or inotifywait to be installed.
+.Ar ENGINE
+is one of
+.Sq fswatch ,
+.Sq inotifywait
+or
+.Sq auto .
+[default: auto]
+.It Fl \-tex-option Ns = Ns Ar OPTION
+Pass
+.Ar OPTION
+to TeX as a single option.
+.It Fl \-tex-options Ns = Ns Ar OPTIONs
+Pass
+.Ar OPTIONs
+to TeX as multiple options.
+.It Fl \-dvipdfmx-option Ns = Ns Ar OPTION , Fl \-dvipdfmx-options Ns = Ns Ar OPTIONs
+Same for dvipdfmx.
+.It Fl \-makeindex Ns = Ns Ar COMMAND+OPTIONs
+Command to generate index, such as
+.Sq makeindex
+or
+.Sq mendex .
+.It Fl \-bibtex Ns = Ns Ar COMMAND+OPTIONs
+Command for BibTeX, such as
+.Sq bibtex
+or
+.Sq pbibtex .
+.It Fl \-biber Ns Op = Ns Ar COMMAND+OPTIONs
+Command for Biber.
+.It Fl \-makeglossaries Ns Op = Ns Ar COMMAND+OPTIONs
+Command for makeglossaries.
+.It Fl h , Fl \-help
+Print this message and exit.
+.It Fl v , Fl \-version
+Print version information and exit.
+.It Fl V , Fl \-verbose
+Be more verbose.
+.It Fl \-color Ns Op = Ns Ar WHEN
+Make ClutTeX's message more colorful.
+.Ar WHEN
+is one of
+.Sq always ,
+.Sq auto ,
+or
+.Sq never .
+[default:
+.Sq auto
+if Fl \-color is omitted,
+.Sq always
+if
+.Ar WHEN
+is omitted]
+.It Fl \-includeonly Ns = Ns Ar NAMEs
+Insert
+.Sq \eincludeonly{ Ns Ar NAMEs Ns } .
+.It Fl \-make-depends Ns = Ns Ar FILE
+Write dependencies as a Makefile rule.
+.It Fl \-print\-output\-directory
+Print the output directory and exit.
+.It Fl \-package\-support Ns = Ns Ar PKG1 Ns Op , Ns Ar PKG2 Ns ,...
+Enable special support for some shell-escaping packages.
+Currently supported: minted, epstopdf.
+.It Fl \-check\-driver Ns = Ns Ar DRIVER
+Check that the correct driver file is loaded.
+.Ar DRIVER
+is one of
+.Sq dvipdfmx ,
+.Sq dvips ,
+.Sq dvisvgm .
+.It Fl \-shell-escape , Fl \-no-shell-escape
+.It Fl \-shell-restricted
+.It Fl \-synctex Ns = Ns Ar NUMBER
+.It Fl \-fmt Ns = Ns Ar FMTNAME
+.It Fl \-file-line-error , Fl \-no-file-line-error
+[default: yes]
+.It Fl \-halt-on-error , Fl \-no-halt-on-error
+[default: yes]
+.It Fl \-interaction Ns = Ns Ar STRING
+[default: nonstopmode]
+.It Fl \-jobname Ns = Ns Ar STRING
+.It Fl \-output-directory Ns = Ns Ar DIR
+[default: somewhere in the temporary directory]
+.It Fl \-output-format Ns = Ns Ar FORMAT
+.Ar FORMAT
+is
+.Sq pdf
+or
+.Sq dvi .
+[default: pdf]
+.El
+.Sh EXIT STATUS
+.Ex -std
diff --git a/support/cluttex/doc/cluttex.pdf b/support/cluttex/doc/cluttex.pdf
index 2d49565b10..d290b54384 100644
--- a/support/cluttex/doc/cluttex.pdf
+++ b/support/cluttex/doc/cluttex.pdf
Binary files differ
diff --git a/support/cluttex/doc/cluttex.tex b/support/cluttex/doc/cluttex.tex
index ae3bc01b67..2666ff44c9 100644
--- a/support/cluttex/doc/cluttex.tex
+++ b/support/cluttex/doc/cluttex.tex
@@ -8,9 +8,9 @@
\newcommand\texpkg[1]{\texttt{#1}}
\newcommand\metavar[1]{\textnormal{\textsf{#1}}}
-\title{\ClutTeX\ manual\\(Version 0.5.1)}
+\title{\ClutTeX\ manual\\(Version 0.6)}
\author{ARATA Mizuki}
-\date{2021-11-04}
+\date{2023-11-18}
\begin{document}
\maketitle
@@ -66,7 +66,7 @@ Basic options:
\item[\texttt{--max-iterations=\metavar{N}}]
Set maximum number of run, for resolving cross-references and etc.
Default: 3
-\item[\texttt{--watch}]
+\item[\texttt{--watch[=\metavar{ENGINE}]}]
Watch input files for change.
May need an external program to be available.
See \autoref{sec:watch-mode} for details.
@@ -155,6 +155,7 @@ If \texttt{--watch} option is given, \ClutTeX\ enters \emph{watch mode} after pr
On Windows, a built-in filesystem watcher is implemented.
On other platforms, an auxiliary program \texttt{fswatch}\footnote{\url{http://emcrisostomo.github.io/fswatch/}} or \texttt{inotifywait} needs to be installed.
+The auxiliary program will be detected automatically, but it could also be specified by the \metavar{ENGINE} argument.
\section{MakeIndex and \BibTeX}
If you want to generate index or bibliography, using MakeIndex or \BibTeX, set \texttt{--makeindex}, \texttt{--bibtex}, or \texttt{--biber} option.