summaryrefslogtreecommitdiff
path: root/support/latexindent/documentation/sec-how-to-use.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/latexindent/documentation/sec-how-to-use.tex')
-rw-r--r--support/latexindent/documentation/sec-how-to-use.tex29
1 files changed, 23 insertions, 6 deletions
diff --git a/support/latexindent/documentation/sec-how-to-use.tex b/support/latexindent/documentation/sec-how-to-use.tex
index 62e821fb0d..f5c7907729 100644
--- a/support/latexindent/documentation/sec-how-to-use.tex
+++ b/support/latexindent/documentation/sec-how-to-use.tex
@@ -1,11 +1,11 @@
% arara: pdflatex: { files: [latexindent]}
\section{How to use the script}
\texttt{latexindent.pl} ships as part of the \TeX Live distribution for
- Linux and Mac users; \texttt{latexindent.exe} ships as part of the \TeX Live and
- MiK\TeX{} distributions for Windows users. These files are also available from github
- \cite{latexindent-home} should you wish to use them without a \TeX{} distribution; in
- this case, you may like to read \vref{sec:updating-path} which details how the
- \texttt{path} variable can be updated.
+ Linux and Mac users; \texttt{latexindent.exe} ships as part of the \TeX Live for Windows
+ users. These files are also available from github \cite{latexindent-home} should you wish
+ to use them without a \TeX{} distribution; in this case, you may like to read
+ \vref{sec:updating-path} which details how the \texttt{path} variable can be updated.
+ \index{TeXLive}
In what follows, we will always refer to \texttt{latexindent.pl}, but depending on your
operating system and preference, you might substitute \texttt{latexindent.exe} or simply
@@ -24,6 +24,11 @@
\announce{2018-01-13}{perl module installer helper script} in particular, note that a module installer helper script is shipped with
\texttt{latexindent.pl}.
+ MiKTeX users on Windows may like to see \cite{miktex-guide} for details of how to use
+ \texttt{latexindent.exe} without a Perl installation.
+ \index{MiKTeX}
+ \index{latexindent.exe}
+
\subsection{From the command line}\label{sec:commandline}
\texttt{latexindent.pl} has a number of different switches/flags/options, which
can be combined in any way that you like, either in short or long form as detailed below.
@@ -38,14 +43,26 @@
\announce{2017-06-25}{version}
\begin{commandshell}
latexindent.pl -v
+latexindent.pl --version
\end{commandshell}
This will output only the version number to the terminal.
+\flagbox{-vv, --vversion}
+ \index{switches!-vv, --vversion definition and details}
+ \announce*{2022-01-08}{vversion switch}
+ \begin{commandshell}
+latexindent.pl -vv
+latexindent.pl --vversion
+\end{commandshell}
+ This will output \emph{verbose} version details to the terminal, including the location
+ of \texttt{latexindent.pl} and \texttt{defaultSettings.yaml}.
+
\flagbox{-h, --help}
\index{switches!-h, --help definition and details}
\begin{commandshell}
latexindent.pl -h
+latexindent.pl --help
\end{commandshell}
As above this will output a welcome message to the terminal, including the version number
@@ -485,7 +502,7 @@ latexindent.pl myfile.tex
exit code & indentation & status \\
\midrule
0 & \faCheck & success; if \texttt{-k} or \texttt{-kv} active, indented text matches original \\
- 0 & \faClose & success; if \texttt{-version} or \texttt{-help}, no indentation performed \\
+ 0 & \faClose & success; if \texttt{-version}, \texttt{-vversion} or \texttt{-help}, no indentation performed \\
1 & \faCheck & success, and \texttt{-k} or \texttt{-kv} active; indented text \emph{different} from original \\
\midrule
2 & \faClose & failure, \texttt{defaultSettings.yaml} could not be read \\