diff options
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoc.1 | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoc.man1.pdf | bin | 25515 -> 25260 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/NEWS | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/README.md | 12 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/texdoc.pdf | bin | 82654 -> 82978 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/texdoc.tex | 42 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/texdoc/texdoclib-config.tlu | 9 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/texdoc/texdoclib-const.tlu | 4 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/texdoc/texdoclib-search.tlu | 2 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/texdoc/texdoclib-util.tlu | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/texdoc/texdoc.cnf | 86 |
11 files changed, 85 insertions, 81 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texdoc.1 b/Master/texmf-dist/doc/man/man1/texdoc.1 index 2b51fbe793f..87e84c387ad 100644 --- a/Master/texmf-dist/doc/man/man1/texdoc.1 +++ b/Master/texmf-dist/doc/man/man1/texdoc.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "TEXDOC" "1" "February 2020" "Texdoc 3.2.1" "Texdoc manual" +.TH "TEXDOC" "1" "September 2020" "Texdoc 3.2.2" "Texdoc manual" . .SH "NAME" \fBtexdoc\fR \- find & view documentation in TeX Live diff --git a/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf Binary files differindex 0fdea3191ae..7e7b6711eb4 100644 --- a/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf 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) [](https://travis-ci.org/TeX-Live/texdoc) [](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 Binary files differindex 5462c218e69..2922130cda5 100644 --- a/Master/texmf-dist/doc/support/texdoc/texdoc.pdf +++ b/Master/texmf-dist/doc/support/texdoc/texdoc.pdf 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} diff --git a/Master/texmf-dist/scripts/texdoc/texdoclib-config.tlu b/Master/texmf-dist/scripts/texdoc/texdoclib-config.tlu index 4eb660873f9..d4f993d4495 100755 --- a/Master/texmf-dist/scripts/texdoc/texdoclib-config.tlu +++ b/Master/texmf-dist/scripts/texdoc/texdoclib-config.tlu @@ -345,7 +345,8 @@ function M.show_config_files(is_action) if is_action then print_func('Recommended file(s) for personal settings:') local sep = (os.type == 'windows') and ';' or ':' - local texmfhomes = string.explode(kpse.expand_path('$TEXMFHOME'), sep) + -- here TEXMFHOMEs do not have to exist, and thus use kpse.var_value + local texmfhomes = string.explode(kpse.var_value('TEXMFHOME'), sep) for _, home in ipairs(texmfhomes) do print_func(indent .. w32_path(home .. '/texdoc/texdoc.cnf')) end @@ -536,15 +537,15 @@ local function setup_config_from_defaults() mode = 'view', interact_switch = 'true', machine_switch = 'false', - ext_list = 'pdf, htm, html, txt, md, ps, dvi, ', + ext_list = 'pdf, htm, html, txt, dat, md, ps, dvi, ', basename_list = 'readme, 00readme', - badext_list = 'txt, ', + badext_list = 'txt, dat, ', badbasename_list = 'readme, 00readme', suffix_list = '', verbosity_level = C.def_verbosity, debug_list = '', max_lines = '20', - fuzzy_level = '5', + fuzzy_level = '3', } -- zip-related options set_config_ls { diff --git a/Master/texmf-dist/scripts/texdoc/texdoclib-const.tlu b/Master/texmf-dist/scripts/texdoc/texdoclib-const.tlu index 0bccb118a1c..a1907c75c45 100755 --- a/Master/texmf-dist/scripts/texdoc/texdoclib-const.tlu +++ b/Master/texmf-dist/scripts/texdoc/texdoclib-const.tlu @@ -21,8 +21,8 @@ end -- progname and version fullname = kpse.find_file('texdoc/texdoclib', 'lua') progname = 'Texdoc' -version = '3.2.1' -release_date = '2020-02-20' +version = '3.2.2' +release_date = '2020-09-16' -- make sure to update setup_config_from_cl() accordingly -- and set a default value in setup_config_from_defaults() if relevant diff --git a/Master/texmf-dist/scripts/texdoc/texdoclib-search.tlu b/Master/texmf-dist/scripts/texdoc/texdoclib-search.tlu index addb59a01f4..0340fa63ba1 100755 --- a/Master/texmf-dist/scripts/texdoc/texdoclib-search.tlu +++ b/Master/texmf-dist/scripts/texdoc/texdoclib-search.tlu @@ -442,7 +442,7 @@ end ------------------------------- use tlpdb -------------------------------- --- tlpdb mean TeX Live Package DataBase and tlp means TeX Live Package +-- tlpdb means TeX Live Package DataBase and tlp means TeX Live Package -- return true if cache exists and is newer than original, false otherwise local function good_cache(cache, ori) diff --git a/Master/texmf-dist/scripts/texdoc/texdoclib-util.tlu b/Master/texmf-dist/scripts/texdoc/texdoclib-util.tlu index d14a212a123..81627c823e6 100755 --- a/Master/texmf-dist/scripts/texdoc/texdoclib-util.tlu +++ b/Master/texmf-dist/scripts/texdoc/texdoclib-util.tlu @@ -12,12 +12,12 @@ local texdoc = { local M = {} local C = texdoc.const --- change '/' to '\' on windows +-- lowercase and change '/' to '\' on windows for display -- Note: Internal representation of files always use forward slashes. -- This function should be called only before displaying a path. if os.type == 'windows' then function M.w32_path(path) - return (string.gsub(path, '/', '\\')) + return (string.gsub(string.lower(path), '/', '\\')) end else function M.w32_path(path) diff --git a/Master/texmf-dist/texdoc/texdoc.cnf b/Master/texmf-dist/texdoc/texdoc.cnf index b54f56352f2..ae998a0c45a 100644 --- a/Master/texmf-dist/texdoc/texdoc.cnf +++ b/Master/texmf-dist/texdoc/texdoc.cnf @@ -79,8 +79,8 @@ # Built-in defaults (for reference): # -# ext_list = pdf, html, htm, txt, md, ps, dvi, # Note: empty string at end -# badext_list = txt, # Note: empty string at end +# ext_list = pdf, html, htm, txt, dat, md, ps, dvi, # Note: empty string at end +# badext_list = txt, dat, # Note: empty string at end # basename_list = readme, 00readme # badbasename_list = readme, 00readme @@ -117,6 +117,7 @@ suffix_list = doc, -doc, _doc, .doc, /doc, manual, /manual, -manual, userguide, # Makefile are never documentation, just as documents in src or source subdir # -1000 should be enough to kill them adjscore /Makefile = -1000 +adjscore /latexmkrc = -1000 adjscore /src/ = -1000 adjscore /source/ = -1000 @@ -207,6 +208,10 @@ adjscore(findhyph) findhyph.man1 = +5 # prioritize official latex-tools adjscore(layout) /tools/ = +1 +# yathesis +adjscore(yathesis) README-TRANSLATION = -1 +adjscore(yathesis) /specimen/a-plat/ = -1000 + # Aliases # ======= @@ -262,8 +267,6 @@ alias tex-live-zh-cn = texlive-zh-cn ## various stuff # a few useful general documents -alias faq-en = newfaq -alias faq = newfaq alias latex = latex-doc-ptr # various lshort translations @@ -281,7 +284,6 @@ alias etex-ref = etex_man alias pdftex-ref = pdftex-a #alias xetex-ref = xetex-reference # OK alias xelatex = xetex-reference -alias luatex-ref = luatexref-t # by default, <engine> = <engine>-ref (duplicated: no alias cascading) alias e-tex = etex_man @@ -289,7 +291,6 @@ alias etex = etex_man alias pdftex = pdftex-a #alias xetex = xetex-reference # OK alias xelatex = xetex-reference -alias luatex = luatexref-t alias e-tex-man = etex.man1 alias etex-man = etex.man1 @@ -297,8 +298,6 @@ alias pdftex-man = pdftex.man1 #alias xetex-man = xetex.man1 # missing alias luatex-man = luatex.man1 -alias luatex-pkg = oberdiek/luatex.pdf - # latex/basic classes alias article = classes alias book = classes @@ -314,12 +313,6 @@ alias letter = base/letter alias slides = base/slides alias(20) fontenc = encguide alias(20) textcomp = encguide -alias fix-cm = fixltx2e -alias bezier = latex209 -alias fleqn = latex209 -alias leqno = latex209 -alias openbib = latex209 -alias t1enc = latex209 alias makeidx = makeindx alias showidx = makeindx alias flafter = source2e @@ -364,10 +357,10 @@ alias amslatex2 = technote alias amsmath = amsldoc alias amsrefs = amsrdoc alias amsthm = amsthdoc -alias amsart = instr-l -alias amsbook = instr-l -alias amscls = instr-l -alias amsproc = instr-l +alias amsart = amscls-doc/Author_Handbook_Journals +alias amsbook = amscls-doc/Author_Handbook_Journals +alias amscls = amscls-doc/Author_Handbook_Journals +alias amsproc = amscls-doc/Author_Handbook_Journals alias amsart-dev = amsclass alias amsbook-dev = amsclass alias amscls-dev = amsclass @@ -393,7 +386,7 @@ alias tugboat = ltubguid # caption alias caption = caption-eng -alias caption-dev = caption.pdf +alias caption-dev = caption-eng # metapost by various names alias metapost = mpman @@ -434,45 +427,53 @@ alias l3fp = interface3 alias l3luatex = interface3 # misc -alias autofe = ucs +alias 3parttable = threeparttable alias afoot = arabtex-doc -alias arabicfont = bezos +alias annee-scolaire = annee-scolaire-eng +alias annee-scolaire-en = annee-scolaire-eng +alias annee-scolaire-fr = annee-scolaire-fra +alias arabic = arabi/user_guide +alias autofe = ucs alias bibtex = btxdoc alias btxdoc-ja = jbtxdoc alias btxhak-ja = jbtxhak alias changes = changes.english.pdf +alias cjk = CJK.txt # FIXME: should be case insensitive alias cm = cm/README -alias(5) cmsuper = cm-super/FAQ alias cm-super = cm-super/README alias cmsuper = cm-super/README -alias cyrillic = cyrillic/00readme.txt +alias(5) cmsuper = cm-super/FAQ +alias croatian = babel +alias cweb = cwebman # XXX: is in 'cweb' dir, should win +alias cyrillic = cyrillic/README +alias dtk = dtk/doc/beispiel.pdf +alias einfuehrung = einfuehrung/README # tl should get "readme" tag alias elsarticle = elsdoc alias(0.1) fontinst = fontinstallationguide alias hyperref = hyperref/manual.pdf alias hyperref-dev = hyperref.pdf alias iso = isoman +alias kvoptions-patch = kvoptions # XXX? +alias layouts = layman alias lettrine = lettrine # to hide context/third/lettrine-doc.pdf -alias nonfloat-de = nonfloat -alias nonfloat = nonfloat-en -alias xstring-fr = xstring_doc_fr -alias arabic = arabi/user_guide -alias 3parttable = threeparttable -alias croatian = babel +alias llmk = light-latex-make/llmk +alias(2) llmk = light-latex-make/README alias mls = montex -alias vrbexin = verbasef -alias dtk = dtk/doc/beispiel.pdf alias musixtex = musixdoc -alias mychemistry = mychemistry_en -alias mychemistry-de = mychemistry_de -alias cjk = CJK.txt # FIXME: should be case insensitive -alias ieee = IEEEtran_HOWTO -alias layouts = layman +alias newtxtext = newtxdoc +alias newtxmath = newtxdoc +alias nonfloat = nonfloat-en +alias nonfloat-de = nonfloat +alias nonumonpart = nonumonpart-en +alias nonumonpart-fr = nonumonpart-fr +alias pkfix-helper = pkfix-helper.man1.pdf alias plnfss = plnfss.txt # XXX alias teubner = teubner-doc +alias vntex = vntex # should win over vntex-man in general +alias vntex-vi = vntex-man +alias vrbexin = verbasef-doc alias xypic = xyguide -alias kvoptions-patch = kvoptions # XXX? -alias cweb = cwebman # XXX: is in 'cweb' dir, should win -alias einfuehrung = einfuehrung/README # tl should get "readme" tag +alias zztex = zzdetails.dat ## a few easy patterns @@ -489,7 +490,6 @@ alias ngerman = gerdoc alias jurabib-de = jbgerdoc alias ofs-cz = ofsdoc alias ofs = ofsdoc-e -alias pst-geo = pst-map3d-doc ## aliases basically borrowed from texdoctk.dat with some adaptations alias akletter = akletter/lettereng @@ -507,19 +507,17 @@ alias mathenv = mdwtab alias montex = mlsquick alias mltex = mltex/mltex.txt alias natbib2 = natnotes -alias uktugfaq = newfaq alias onrannual = onrannual/README alias otibet = otibet/unidoc alias pbdiagram = pb-manual alias tikz = pgfmanual alias apmgraph = pmgraph -alias preprint = preprint/00readme.txt +alias preprint = preprint/README alias dutch = rapdoc -alias startex = startex/base/guide +alias startex = startex/guide alias tangles = t-angles/t-manual alias tex4ht = tex4ht/mn.html alias(60) akademia = tex-virtual-academy-pl/index.html -alias treetex = tree_doc alias lineno = ulineno alias texguide = usrguide alias(5) xypic = xyrefer |