Skip to content

Commit

Permalink
Update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
minoki committed Apr 30, 2019
1 parent 10e1bcc commit 28c9c95
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Command-line Options
Change the current working directory to the output directory when running TeX.
* `--watch`
Watch input files for change.
Requires [fswatch](http://emcrisostomo.github.io/fswatch/) program to be installed.
Requires [fswatch](http://emcrisostomo.github.io/fswatch/) program or `inotifywait` program to be installed on Unix systems.
* `--color[=WHEN]`
Make ClutTeX's message colorful.
`WHEN` is one of `always`, `auto`, or `never`.
Expand Down
Binary file modified doc/manual-ja.pdf
Binary file not shown.
11 changes: 6 additions & 5 deletions doc/manual-ja.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
\renewcommand\sectionautorefname{セクション}
\renewcommand\subsectionautorefname{サブセクション}

\title{\ClutTeX{}マニュアル}
\title{\ClutTeX{}マニュアル\\(バージョン0.3)}
\author{ARATA Mizuki}
\date{2019年4月30日}

\begin{document}
\maketitle
Expand All @@ -23,7 +24,7 @@ \chapter{\ClutTeX{}の概要}
\begin{itemize}
\item 作業ディレクトリを\texttt{.aux}や\texttt{.log}等の「余計な」ファイルで散らかさない
\item (相互参照の解決などで)複数回処理を行う必要がある場合に、必要な回数だけ自動で処理する
\item 入力ファイルを監視し、変更があった場合に自動で再処理する(\texttt{--watch}オプション\footnote{別途プログラムが必要})
\item 入力ファイルを監視し、変更があった場合に自動で再処理する(\texttt{--watch}オプション\footnote{Unix系OSでは、別途プログラムが必要})
\item MakeIndex, \BibTeX, Biber等のコマンドを自動で実行する(\texttt{--makeindex}オプション, \texttt{--bibtex}オプション, \texttt{--biber}オプション)
\item p\TeX 系列の処理系でPDFを生成する場合、別途\texttt{dvipdfmx}を実行する必要がない(自動で\texttt{dvipdfmx}を実行する)
\end{itemize}
Expand Down Expand Up @@ -71,7 +72,7 @@ \section{コマンドライン}
デフォルト:3
\item[\texttt{--watch}]
入力ファイルを監視する。
別途、\texttt{fswatch}プログラムが必要となる
別途、\texttt{fswatch}プログラムまたは\texttt{inotifywait}プログラムが必要となる場合がある
詳しくは\autoref{sec:watch-mode}を参照。
\item[\texttt{--color[=\metavar{WHEN}]}]
ターミナルへの出力を色付けする。
Expand Down Expand Up @@ -145,9 +146,9 @@ \section{Sync\TeX}\label{sec:synctex}

\section{監視モード}\label{sec:watch-mode}
\ClutTeX{}に\texttt{--watch}オプションを指定して起動した場合、文書の処理後に\emph{監視モード}に入る。
\texttt{fswatch}\footnote{\url{http://emcrisostomo.github.io/fswatch/}}プログラムが予めインストールされている必要がある。

\ClutTeX{}の将来のバージョンでは、外部プログラムに頼らない監視モードを実装するかもしれない。
Windows上では、\ClutTeX{}単体でファイルシステムの監視を行う。
一方で、それ以外のOS(Unix系)では、\texttt{fswatch}\footnote{\url{http://emcrisostomo.github.io/fswatch/}}プログラムまたは\texttt{inotifywait}プログラムが予めインストールされている必要がある。

\section{MakeIndexや\BibTeX}
MakeIndexや\BibTeX を使って処理を行う場合は、\texttt{--makeindex}や\texttt{--bibtex}等のオプションを指定する。
Expand Down
Binary file modified doc/manual.pdf
Binary file not shown.
12 changes: 7 additions & 5 deletions doc/manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
\newcommand\texpkg[1]{\texttt{#1}}
\newcommand\metavar[1]{\textnormal{\textsf{#1}}}

\title{\ClutTeX\ manual}
\title{\ClutTeX\ manual\\(Version 0.3)}
\author{ARATA Mizuki}
\date{2019-04-30}

\begin{document}
\maketitle
\tableofcontents
Expand All @@ -20,7 +22,7 @@ \chapter{About \ClutTeX}
\begin{itemize}
\item Does not clutter your working directory with ``extra'' files, like \texttt{.aux} or \texttt{.log}.
\item If multiple runs are required to generate correct document, do so.
\item Watch input files, and re-process documents if changes are detected\footnote{needs an external program}.
\item Watch input files, and re-process documents if changes are detected\footnote{needs an external program if you are on a Unix system}.
\item Run MakeIndex, \BibTeX, Biber, if requested.
\item Produces a PDF, even if the engine (e.g.\ p\TeX) does not suport direct PDF generation.
\end{itemize}
Expand Down Expand Up @@ -65,7 +67,7 @@ \section{Command-line usage}
Default: 3
\item[\texttt{--watch}]
Watch input files for change.
Requires \texttt{fswatch} command to be available.
May need an external program to be available.
See \autoref{sec:watch-mode} for details.
\item[\texttt{--color[=\metavar{WHEN}]}]
Colorize messages.
Expand Down Expand Up @@ -138,9 +140,9 @@ \section{Sync\TeX}\label{sec:synctex}

\section{Watch mode}\label{sec:watch-mode}
If \texttt{--watch} option is given, \ClutTeX\ enters \emph{watch mode} after processing the document.
An auxiliary program \texttt{fswatch}\footnote{\url{http://emcrisostomo.github.io/fswatch/}} needs to be installed for this mode.

A future version of \ClutTeX\ may implement a built-in filesystem watcher.
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.

\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.
Expand Down

0 comments on commit 28c9c95

Please sign in to comment.