summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex38
1 files changed, 31 insertions, 7 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index 8adac4c59c..25c8c052ca 100644
--- a/indexing/xindex/doc/xindex-doc.tex
+++ b/indexing/xindex/doc/xindex-doc.tex
@@ -36,10 +36,9 @@
\gdef\DoubleperCent{%%}
}
-
\usepackage{xcolor,fancyvrb,varioref}
\usepackage{xltabular}
-\usepackage{dtk-logos} % for Wikipedia W
+\usepackage{hvlogos} % for Wikipedia W
\usepackage{listings}
\usepackage{dtk-extern} % for Wikipedia W
\lstset{basicstyle=\ttfamily\small,language=[LaTeX]TeX}
@@ -81,7 +80,7 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\xIndexVersion{#2}}
-\setVersion{version = 0.30}% can be automatically changed by perl
+\setVersion{version = 0.31}% can be automatically changed by perl
\setkeys{dtk}{cleanup=true,force}
@@ -101,8 +100,9 @@ Mark Baudoin;
Denis Bitouzé;
Brian Dunn;
Michal Hoftich;
+Frank Mittelbach;
Heiko Oberdiek;
-Matteo Paolini;\\
+Matteo Paolini;
Florent Rougon;
Martin Sievers;
Simon Spiegel
@@ -157,7 +157,7 @@ EntryList[2] = {
\subsection{Syntax}
-The \Index{syntax} is \verb|xindex [...] <file>| where \verb|[...]| are optional \Index{argument}s, either in short or
+The \Index{syntax} is \verb|xindex [...] <file(s)>| where \verb|[...]| are optional \Index{argument}s, either in short or
long form which, of course, can be mixed:
\begin{verbatim}
@@ -174,15 +174,38 @@ xindex
[-l,--language ] default is en
[-p,--prefix] default L
[-u,--use_UCA ] default is false
- <input file>
+ [-s,--use_stdin ] default is false
+ <files...> (default stdin) file(s)[.idx] one or more files
\end{verbatim}
For example:
\begin{verbatim}
xindex -q -l fr -b myDoc
+xindex -l de -c DIN2 demo1 demo2 demo3
+xindex -c norsk -o index.ind demo1 demo2.bdx demo3.adx
+\end{verbatim}
+
+\begin{enumerate}
+\item \texttt{-q}: quiet; \texttt{-l fr}: french language setting; \texttt{-b}: no labels; \texttt{myDoc}: input data \texttt{myDoc} or \texttt{myDoc.idx)\newline
+ output data will be \texttt{myDoc.ind} and logfile \texttt{myDoc.ilg}
+\item \texttt{-l de}: german language setting; \texttt{-c DIN2}: config file \texttt{xindex-DIN2.lua}; \texttt{demo1 demo2 demo3}: input data files with or without
+ extension \texttt{.idx} \newline
+ output data will be \texttt{demo1.ind} and logfile \texttt{xindex.ilg}}
+\item \texttt{-c norsk}: config file \texttt{xindex-norsk.lua}; \texttt{-o index.ind}: output file; \texttt{demo1 demo2.bdx demo3.adx}: input data files with or without
+ extension \texttt{.idx} \newline
+ output data will be \texttt{xindex.ind} and logfile \texttt{xindex.ilg}
+\end{enumerate}
+
+It is also possible to use standard input for the index data, which needs the \verb|-s| parameter:
+
+\begin{verbatim}
+cat myDoc.idx | xindex -q -l fr -b -s
+xindex -l de -c DIN2 < myDoc.idx
\end{verbatim}
+
+
\iffalse
local args = require ('xindex-lapp') [[
parameter handling
@@ -198,7 +221,8 @@ local args = require ('xindex-lapp') [[
-l,--language (default en)
-p,--prefix (default L)
-u,--use_UCA
- <input> (string)
+ -s,--use_stdin
+ <files...> (default stdin) [.idx] file(s)
]]
\fi