summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-09-16 21:34:53 +0000
committerKarl Berry <karl@freefriends.org>2020-09-16 21:34:53 +0000
commit422619cc474863487a3bdee03feb1d5944af281b (patch)
treeeb77fb6c92a27f640133f5fb49bfa8be739ec4fb /Master/texmf-dist/doc/support
parent9171277495ead4380a670e2ad46848220142611a (diff)
texdoc (16sep20)
git-svn-id: svn://tug.org/texlive/trunk@56358 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/texdoc/NEWS5
-rw-r--r--Master/texmf-dist/doc/support/texdoc/README.md12
-rw-r--r--Master/texmf-dist/doc/support/texdoc/texdoc.pdfbin82654 -> 82978 bytes
-rw-r--r--Master/texmf-dist/doc/support/texdoc/texdoc.tex42
4 files changed, 32 insertions, 27 deletions
diff --git a/Master/texmf-dist/doc/support/texdoc/NEWS b/Master/texmf-dist/doc/support/texdoc/NEWS
index 29fa3873d96..86e77628c11 100644
--- a/Master/texmf-dist/doc/support/texdoc/NEWS
+++ b/Master/texmf-dist/doc/support/texdoc/NEWS
@@ -2,6 +2,11 @@ NEWS for texdoc
===============
(This file public domain.)
+Version 3.2.2
+-------------
+- Several aliases are added
+- Small documentation fixes
+
Version 3.2.1
-------------
- Bug fix: suspend a realpath not found error
diff --git a/Master/texmf-dist/doc/support/texdoc/README.md b/Master/texmf-dist/doc/support/texdoc/README.md
index c36135750ab..45805a7b8ad 100644
--- a/Master/texmf-dist/doc/support/texdoc/README.md
+++ b/Master/texmf-dist/doc/support/texdoc/README.md
@@ -1,4 +1,4 @@
-# Texdoc 3.2.1 (2020-02-20)
+# Texdoc 3.2.2 (2020-09-16)
[![Build Status](https://travis-ci.org/TeX-Live/texdoc.svg?branch=master)](https://travis-ci.org/TeX-Live/texdoc)
[![Build status](https://ci.appveyor.com/api/projects/status/uq28ms7eba7ns6d3/branch/master?svg=true)](https://ci.appveyor.com/project/wtsnjp/texdoc/branch/master)
@@ -56,7 +56,7 @@ Many building tasks are defined as [Rake](https://github.com/ruby/rake) tasks:
### Generating all documentation
-Following will generate both the PDF and the manpage in `doc/` directory.
+The following will generate both the PDF and the manpage in `doc/` directory.
```
$ rake doc
@@ -64,7 +64,7 @@ $ rake doc
### Generating a pre-hashed cache file
-Following will generate a pre-hashed cache file `script/Data.tlpdb.lua`. This task have to be done under a TeX Live setup with tlpdb.
+The following will generate a pre-hashed cache file `script/Data.tlpdb.lua`. This task have to be done under a TeX Live setup with tlpdb.
```
$ rake gen_datafile
@@ -72,7 +72,7 @@ $ rake gen_datafile
### Running tests
-Following will run all tests in `spec/` directory.
+The following will run all tests in `spec/` directory.
```
$ rake test
@@ -92,7 +92,7 @@ Following will show all available tasks with a short description.
$ rake -T
```
-In addition to that, for options available tasks (e.g., `rake test` and `rake run_texdoc`) you can get options information with `-h` option for each task:
+In addition to that, for options available tasks, e.g., `rake test` and `rake run_texdoc`, you can get options information with `-h` option for each task:
```
$ rake test -- -h
@@ -100,7 +100,7 @@ $ rake test -- -h
## Further Information
-More specific information (e.g., TODO) can be found in the Wiki of our GitHub repository. Please visit:
+More specific information, such as the TODO list of this project and some information for distributors, can be found in the Wiki of our GitHub repository. Please visit:
* <https://github.com/TeX-Live/texdoc/wiki>
diff --git a/Master/texmf-dist/doc/support/texdoc/texdoc.pdf b/Master/texmf-dist/doc/support/texdoc/texdoc.pdf
index 5462c218e69..2922130cda5 100644
--- a/Master/texmf-dist/doc/support/texdoc/texdoc.pdf
+++ b/Master/texmf-dist/doc/support/texdoc/texdoc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/texdoc/texdoc.tex b/Master/texmf-dist/doc/support/texdoc/texdoc.tex
index 7b9a2590089..c3607b4d61b 100644
--- a/Master/texmf-dist/doc/support/texdoc/texdoc.tex
+++ b/Master/texmf-dist/doc/support/texdoc/texdoc.tex
@@ -8,7 +8,7 @@
\subtitle{Find \& view documentation in \TL}
\pkgurl{https://tug.org/texdoc/}
\author{Manuel Pégourié-Gonnard\and Takuto Asakura}
-\date{v3.2.1\quad \today}
+\date{v3.2.2\quad \today}
\begin{document}
@@ -208,7 +208,7 @@ invoked by the program. Internally, this sets \ci{verbosity\_level} to maximum.
\begin{clopt}{%
\code{\sopt{d} \meta{list}}, \code{\lopt{debug}=\meta{list}},
\sopt{D}, \lopt{debug}}
-This sets \ci{debug\_list} to show dubbging information in the specified
+This sets \ci{debug\_list} to show debugging information in the specified
category. You can specify multiple categories with a comma-separated list. If
you specify |-D| or |--debug| without specifying a list, it activates all
available debug categories.
@@ -236,7 +236,7 @@ program using |TEXMF| search path. In addition, Texdoc uses |TEXMFROOT| and
|TEXMFVAR| to look for the tlpdb database and the cache respectively.
Second, the viewers for opening documents can be controlled by some environment
-variables. They all correspond to some \ci{viewer\_\meta{ext}}
+variables. They all correspond to some \ci{viewer\_\meta{ext}}
setting.\footnote{Old names of environment variables, namely
|TEXDOCVIEW_\{html,dvi,md,txt,pdf,ps\}| and
|TEXDOC_VIEWER_\{HTML,DVI,MD,TXT,PDF,PS\}|, are deprecated but still work.} You
@@ -465,8 +465,8 @@ in the future.
File extensions regarded as documents by Texdoc can be specified with the
configuration item \ci{ext\_list}. By default, files with extensions |pdf|,
-|html|, |htm|, |txt|, |md|, |ps|, and |dvi| and files without extension are
-recognized as documents.
+|html|, |htm|, |txt|, |dat|, |md|, |ps|, and |dvi| and files without extension
+are recognized as documents.
During the scoring process, the configuration item |badext_list| is also used:
files with a ``bad'' extension appearing in this list will get a lesser score.
@@ -564,7 +564,7 @@ shipped configuration file for more.
\end{confitem}
\begin{confitem}{ext\_list}
- {\meta{list}}[default: \code{pdf, html, htm, txt, md, dvi, ps,}]
+ {\meta{list}}[default: \code{pdf, html, htm, txt, dat, md, dvi, ps,}]
Set the list of recognised extensions to |«list»|. This list is used to filter
and sort the results that have the same score (with the default value: pdf
first, etc). Two special values are recognised:
@@ -600,7 +600,7 @@ similarly, if it is |htm| the |html| viewer is used. Otherwise, the |txt|
viewer is used and a warning is issued.
\end{confitem}
-\begin{confitem}{badext\_list}{\meta{list}}[default: \code{txt}]
+\begin{confitem}{badext\_list}{\meta{list}}[default: \code{txt, dat,}]
Set the list of ``bad'' extensions to |«list»|. Files with those extensions get
a malus of |1| on their heuristic score if it was previously positive.
\end{confitem}
@@ -662,7 +662,7 @@ where |«argument»| is the name of the argument to which the results correspond
(mainly useful if there were many arguments), {\metatab} is the tab (ASCII \#9)
character, and the other entries are pretty self-explanatory. Nothing else is
printed on stdout, except if an internal error occurs (in which case exit code
-will be 1). In the future, more tab-separated fields may be added at the end
+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
@@ -673,25 +673,25 @@ same meaning in future versions of Texdoc.
\begin{confitem}{zipext\_list}{\meta{list}}[default: empty]
List of supported extensions for zipped files. Allows compressed files with
-names like |foobar.«zip»|, with |«zip»| in the given |«list»|, to be found and
-unzipped before the viewer is started (the temporary file will be destroyed
-right after).
+names like |foobar.«zipext»|, where |«zipext»| is an element in the given
+|«list»|, to be found and unzipped before the viewer is started (the temporary
+file will be destroyed right after).
Warning: Support for zipped documentation is not meant to work on windows, a
Unix shell is assumed! If you add anything to this list, please make sure that
-you also set a corresponding |unzip=«ext»| value for each |«ext»| in the list.
-At the same time, make sure you are using blocking (i.e., not returning
-immediately) viewers.
+you also set the corresponding \ci{unzip\_\meta{zipext}} item for each
+|«zipext»| in the list. At the same time, make sure you are using blocking
+(i.e., not returning immediately) viewers.
-Remark: {\TL} doesn't ship compressed documentation files, so this option is
-mainly useful with re-packaged version of {\TL} that do, for example in Linux
-distributions.
+Remark: {\TL} does not ship any compressed documentation file, so this option
+is mainly useful with re-packaged versions of {\TL} that do, for example one in
+Linux distributions.
\end{confitem}
\begin{confitem}{unzip\_\meta{zipext}}{\meta{command}}[no default]
-The unzipping command for compressed files with extension |«zipext»|. Define
-one for each item in \ci{zipext\_list}. The command must print the result on
-stdout, like |gzip -d -c| does.
+The unzipping command for compressed files with extension |«zipext»|. You
+should set one for each item in the \ci{zipext\_list}. The command must print
+the result on stdout, like |gzip -d -c| does.
\end{confitem}
\begin{confitem}{rm\_file}{\meta{command}}[default: \code{rm -f}]
@@ -713,7 +713,7 @@ default configuration file from older versions to be used (see the
so).
\end{confitem}
-\begin{confitem}{fuzzy\_level}{\meta{number}}[default: \code{5}]
+\begin{confitem}{fuzzy\_level}{\meta{number}}[default: \code{3}]
Set the allowance of Levenshtein distance to |«number»| for fuzzy search. At
level~|0|, the fuzzy search feature is disabled.
\end{confitem}