summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/texdoc
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-02-28 16:12:57 +0000
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-02-28 16:12:57 +0000
commit92c8406013463f54d0b27ac6a2fa5b4608cc0966 (patch)
tree725332ecf8a74ff09b7de3e33a2be0b204be2598 /Master/texmf/doc/texdoc
parent5589232e99f0fa13868111280c5b64ce9dc25730 (diff)
texdoc 0.70.
git-svn-id: svn://tug.org/texlive/trunk@17236 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/texdoc')
-rw-r--r--Master/texmf/doc/texdoc/News12
-rw-r--r--Master/texmf/doc/texdoc/texdoc.pdfbin208206 -> 206108 bytes
-rw-r--r--Master/texmf/doc/texdoc/texdoc.tex86
3 files changed, 49 insertions, 49 deletions
diff --git a/Master/texmf/doc/texdoc/News b/Master/texmf/doc/texdoc/News
index faca951b308..ad619ef593c 100644
--- a/Master/texmf/doc/texdoc/News
+++ b/Master/texmf/doc/texdoc/News
@@ -1,3 +1,15 @@
+Version 0.70
+------------
+
+Use information from the TeX Live package database (some of it coming from the
+CTAN catalogue) to improve search results. Display some of this information.
+
+Show the current settings in --help message.
+
+Misc. internal changes & fixes.
+
+Deprecate -a, --alias, -A, --noalias and alias_switch.
+
Version 0.66
------------
diff --git a/Master/texmf/doc/texdoc/texdoc.pdf b/Master/texmf/doc/texdoc/texdoc.pdf
index 7eff49cd9a1..6a5ace22009 100644
--- a/Master/texmf/doc/texdoc/texdoc.pdf
+++ b/Master/texmf/doc/texdoc/texdoc.pdf
Binary files differ
diff --git a/Master/texmf/doc/texdoc/texdoc.tex b/Master/texmf/doc/texdoc/texdoc.tex
index 47d92faf292..6e4389432a4 100644
--- a/Master/texmf/doc/texdoc/texdoc.tex
+++ b/Master/texmf/doc/texdoc/texdoc.tex
@@ -163,7 +163,7 @@
\subtitle{Find \& view documentation in \TeX\ Live}
\author{\url{http://tug.org/texdoc/}\\
Manuel Pégourié-Gonnard}
-\date{v0.66 2010-02-22}
+\date{v0.70 2010-02-28}
\begin{document}
\VerbatimFootnotes
@@ -207,7 +207,8 @@ Usually, \texdoc shows you only results it considers relevant. If there are no
using the ``showall'' mode. (This implies using a menu rather than starting a
viewer.)
-You can select with command-line options: use ©texdoc «option» «name»© with
+You can select the mode with command-line options: use
+©texdoc «option» «name»© with
one of the following options: ©-w© or ©--view© for view mode, ©-m© or
©--mixed© for mixed mode, ©-l© or ©--list© for list mode, ©-s© or ©--showall©
for showall mode.
@@ -317,7 +318,7 @@ about how a file can match keyword first (all matching is case-insensitive):
(there is no space in file names in \TeX\ Live) and a subword is a
substring both ends of which are a word boundary.
\item The keyword can match ``exactly'' the file name: that is, the file
- name is the keyword + and extension.
+ name is the keyword plus an extension.
\end{enumerate}
\subsection{Alias directives}\label{ss-alias}
@@ -358,10 +359,6 @@ from begin applied for a particular keyword by saying ©stopalias «keyword»© in
your personal configuration file. It will keep the aliases defined before
this directive (if any) and prevent all further aliasing on this keyword.
-If, for some reason, you want to prevent any alias from begin used for one
-particular session of texdoc, you can use the ©-A© or ©--noalias© command-line
-option (see~\ref{cl-a}).
-
\subsection{Score directives}\label{ss-score}
\begin{htcode}
@@ -456,35 +453,28 @@ item.
-h, --help
\end{cmdsubsub}
-Shows a quick help message (namely a list of command-line options) and exits
+Show a quick help message (namely a list of command-line options) and exit
successfully.
\begin{cmdsubsub}{-V, --version}{cl-V}
-V, --version
\end{cmdsubsub}
-Show the current version of the program and exits successfully.
+Show the current version of the program and exit successfully.
\begin{cmdsubsub}{-f, --files}{cl-f}
-f, --files
\end{cmdsubsub}
-Shows the list of the configuration files for the current installation and
+Show the list of the configuration files for the current installation and
platform, with their status (active, not found, or disabled
-(see~\ref{cf-lastfile_switch})) and exits successfully.
+(see~\ref{cf-lastfile_switch})) and exit successfully.
-\begin{cmdsubsub}{-w, -l, -m, -s, -r, --view, --list, --mixed, --showall,
- --regex}{cl-mode}
- -w, --view, -l, --list, -m, --mixed, -s, --showall, -r, --regex
+\begin{cmdsubsub}{-w, -l, -m, -s, --view, --list, --mixed, --showall}{cl-mode}
+ -w, --view, -l, --list, -m, --mixed, -s, --showall
\end{cmdsubsub}
-\hfill Set ©mode© to the given value, see~\ref{cf-mode}.
-
-\begin{cmdsubsub}{-a, -A, --alias, --noalias}{cl-a}
- -a, --alias, -A, --noalias
-\end{cmdsubsub}
-
-Set ©alias_switch© true (resp. false), see~\ref{cf-alias_switch}
+Set ©mode© to the given value, see~\ref{cf-mode}.
\begin{cmdsubsub}{-i, -I, --interact, --nointeract}{cl-i}
-i, --interact, -I, --nointeract
@@ -492,14 +482,11 @@ Set ©alias_switch© true (resp. false), see~\ref{cf-alias_switch}
Set ©interact_switch© to true (resp. false), see~\ref{cf-interact_switch}.
-\begin{cmdsubsub}{-e, --extensions}{cl-e}
- -e=«l», --extensions=«l»
+\begin{cmdsubsub}{-M, --machine}{cl-M}
+ -M, --machine
\end{cmdsubsub}
-Set ©ext_list©, see~\ref{cf-ext_list}. \textbf{Warning}: this command-line
-option is deprecated and will likely be removed soon. It is recommended to set
-©ext_list© in a configuration file instead. Please protest on the \tdml if you
-want to keep this command-line option.
+Set ©machine_switch© to true, see~\ref{cf-machine_switch}.
\begin{cmdsubsub}{-q, --quiet}{cl-q}
-q, --quiet
@@ -520,12 +507,6 @@ Set ©verbosity_level© to maximum, see~\ref{cf-verbosity_level}.
Set ©debug_list©, see~\ref{cf-debug_list}. If not list is given, activates all
available debug items.
-\begin{cmdsubsub}{-M, --machine}{cl-M}
- -M, --machine
-\end{cmdsubsub}
-
-Set ©machine_switch© to true, see~\ref{cf-machine_switch}.
-
\subsection{Environment variables}\label{ss-envvar}
They all correspond to some ©viewer_«ext»© setting, and the reader is referred
@@ -584,16 +565,11 @@ except when the name of the ©«configuration item»© ends with:
In these cases, an improper ©«value»© will raise a warning too.
\begin{cmdsubsub}{mode}{cf-mode}
- mode = «view, list, mixed, showall, regex»
+ mode = «view, list, mixed, showall»
\end{cmdsubsub}
-Set the mode to the given value. Default is ©view©. All mode except regex
+Set the mode to the given value. Default is ©view©. The various modes
have been presented in~\ref{ss-modes}.
-In regex mode, the given name is interpreted as a Lua regex, and only files
-whose full name (including path) matches it are found. Alias and score
-mechanisms are disabled. \textbf{Warning}: this mode is deprecated and will
-likely be removed soon. Please protest on the \tdml if you want it to stay.
-
\begin{cmdsubsub}{interact}{cf-interact_switch}
interact_switch = «true, false»
\end{cmdsubsub}
@@ -630,15 +606,14 @@ recognised:
There is a very special case: if the searched ©«name»© has ©.sty© extension,
\texdoc enters a special search mode for ©.sty© files (not located in the same
place as real documentation files) for this ©«name»©, indepandantly of the
-current value of ©ext_list© and ©mode© (unless it is the ©regex© mode). In an
-ideal world, this wouldn't be necessary since every sty file would have a
-proper documentation in pdf, html or plain text, but\dots
-
-For each ©«ext»© in ©ext_list© there should be a corresponding
-©viewer_«ext»© value set. Defaults are defined corresponding to the default
-©ext_list©, but you can add values if you want. For example, if you want
-\texdoc to be able to find man pages and display them with the ©man© command,
-you can use
+current value of ©ext_list© and ©mode©. In an ideal world, this wouldn't be
+necessary since every sty file would have a proper documentation in pdf, html
+or plain text, but\dots
+
+For each ©«ext»© in ©ext_list© there should be a corresponding ©viewer_«ext»©
+value set. Defaults are defined corresponding to the default ©ext_list©, but
+you can add values if you want. For example, if you want \texdoc to be able
+to find man pages and display them with the ©man© command, you can use
\begin{htcode}
ext_list = pdf, html, 1, 5, txt, dvi, ps,
viewer_1 = man
@@ -679,6 +654,14 @@ Set the list of activated debug items (default: none; if the option is used
without arguments, the list defaults to all known debug items). Implies
©--verbose©. Debug information is printed on standard error.
+\begin{cmdsubsub}{max_line}{cf-max_lines}
+ max_lines = «number»
+\end{cmdsubsub}
+
+Set the maximum number of results to be printed without confirmation in list,
+mixed or showall mode (default: 20). This setting has no effect if interaction
+is disabled.
+
\begin{cmdsubsub}{machine_switch}{cf-machine_switch}
machine_switch = «true, false»
\end{cmdsubsub}
@@ -696,6 +679,11 @@ printed on stdout, except if a internal error occurs (in which case exit code
will be 1). In the future, more tab-separated fields may be added at the end
of the line, but the first 3 fields will remain unchanged.
+Currently, there are two additional fields: a two-letter language code, and
+an unstructured description, both taken from the CTAN catalogue (via the TeX
+Live database). These fields may be empty and they are not guaranteed to keep
+the same meaning in future versions of \texdoc.
+
\begin{cmdsubsub}{zipext_list}{cf-zipext_list}
zipext_list = «list»
\end{cmdsubsub}