path: root/support/texdoc/texdoc.cnf

# original texdoc.cnf -- default runtime configuration for texdoc.
# Public domain.
#
# DO NOT edit this file!
# For your personal settings, run 'texdoc -f' and use the recommended file; you
# may need to create it. DO NOT copy the present file, please create a new one
# (you may want to copy/paste/edit portions of the present file however, or
# just read it for inspiration).
#
# For system-wide configuration or other uses, you may want to use the other
# files listed, see the manual (texdoc texdoc) for details. The files are read
# in the order they are printed. If a value is set multiple times, first wins.
#
# In those files, you can set your preferred viewer for various formats,
# some nice names (alias) for specific documentation, and your preferred default
# values of texdoc's configuration settings.
#
# Everything after a # on a line is ignored.
# Spaces at the beginning/end of a line, as well as empty lines, are ignored.
#
# For more details, see the texdoc manual (try 'texdoc texdoc').

# General settings
# ================

## Viewers

# Defaults depend on what is available on your system, as well as your desktop
# environment. Here are a few examples.
#
# %s is optional and stands for the filename.
#
# viewer_pdf = xpdf             # works
# viewer_pdf = xpdf %s &        # works even better

# If you want to enable support for zipped documentation (see below),
# you may want to adapt viewer_* so that it starts a subshell:
#
# viewer_pdf = (xpdf %s) &
#
# Otherwise, the & will have no effect since the viewing command is followed by
# some cleanup-commands for temporary files. For the same reason, %s must be the
# last thing on your command line: (xpdf %s -option) will not work.
#
# WARNING: for zip support your viewer needs to be blocking, i.e. it must not
# return immediately: otherwise the temporary file will be deleted too early.

## Zipped documentation support

# WARNING: support for zipped documents works only on Unix. Make sure that the
# values of the associated options are adapted to your system. Read the above
# warning concerning viewers.

# Built-in defaults (for reference):
#
# zipext_list =        # the empty list
# rm_file = rm -f
# rm_dir = rmdir
#
# For each "ext" in zipext_list, you must define a "unzip_ext" unzipper.
# The unzipped data must be printed on stdout. Example:
#
# zipext_list = gz
# unzip_gz = gzip -d -c

## User interaction

# Built-in defaults (for reference):
#
# mode = view
#
# interact_switch = true
# machine_switch = false
#
# verbosity_level = 2  # Print: 0: nothing, 1: errors, 2: warnings, 3: infos
# debug_list =         # the empty list

## Documentation searching

# Built-in defaults (for reference):
#
# 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

## Fuzzy search

# Built-in defaults (for reference):
#
# fuzzy_level = 3

# Known suffixes for documentation
suffix_list = doc, -doc, _doc, .doc, /doc, manual, /manual, -manual, userguide, /user_guide, -guide, -user, -man, notes, -info, ref

# Score adjustments
# =================

# Results are sorted by score (decreasing).
# Only results with positive scores are displayed (unless mode is 'showall').
# Results with score <= -100 are never displayed.
#
# The score of results containing a given pattern can be adjusted using the
# 'adjscore' directive, either globally or only for specific queries. It is
# also possible to set the score directly in alias directives, see the next
# section.
#
# As a general rule, use 'adjscore' if you only want to adjust the score of
# particular results, and 'alias' if you want to add new results (possibly
# adjusting their score) for a particular query.
#
# To override one of the settings below, use the 'noadjscore' directive in
# your personal configuration file, see the manual for details.

## General adjustments

# 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

# licence files aren't very likely to contain relevant documentation, but it
# feels wrong to totally kill them
adjscore copying = -10
adjscore license = -10
adjscore gpl = -10

# tex-virtual-academy provides a lot of spurious matches
adjscore /tex-virtual-academy-pl/ = -50

# test and example files are not likely the best documentation
adjscore example = -1
adjscore examples = -1
adjscore sample = -1
adjscore samples = -1
adjscore test = -3
adjscore tests = -3
adjscore /demo/ = -1
adjscore /demos/ = -1
adjscore /figures/ = -3
adjscore /images/ = -3

# latex-dev stuff are less important than stable ones
adjscore /latex-dev/ = -2

# readme files usually get negative scores because they have bad extensions,
# but they're still slightly better than other results with negative scores
adjscore readme = +0.1

## Specific adjustments

# 'texdoc' may look like "tex's documentation" but it isn't; 'tex-*' as well
adjscore(tex) texdoc = -10
adjscore(tex) tex-gyre = -10
adjscore(tex) tex-ps = -10

# avoid too many results to be shown for 'latex'
# package names
adjscore(latex) cjw-latex = -10
adjscore(latex) cweb-latex = -10
adjscore(latex) duerer-latex = -10
adjscore(latex) guide-to-latex = -10          # only useful with the book
adjscore(latex) latex-web-companion = -10
adjscore(latex) ocr-latex = -10
adjscore(latex) tufte-latex = -10
# file names
adjscore(latex) Content_LaTeX_Package_Demo = -10
adjscore(latex) example_latex = -10
adjscore(latex) test_latex = -10
# dir names
adjscore(latex) /latex/ = -4
adjscore(latex) /latex-dev/ = -5
adjscore(latex) /generic/ = -5

# prioritize official documents for 'latex'
adjscore(latex) /latex/base/ = +5
adjscore(latex) /latex/tools/ = +5

# beamer
adjscore(beamer) beamer-tut-pt/tutorialbeamer = +10
adjscore(beamer) beamer-FUBerlin = -3
adjscore(beamer) beamer-tut-pt = -10
adjscore(beamer) presentations = -10

# misc
adjscore(context) circuitikz = -10
adjscore(context) /gnuplot/ = -3
adjscore(context) context.man1 = +2
adjscore(symbols) /staves/ = -5

# catalogue info missing in the tlcontrib version of the package :-(
adjscore(pgf) pgfmanual.pdf = +5

# another catalogue info missing case
adjscore(hyph-utf8) hyphenation.pdf = +5

# let's not have context version found first
adjscore(fixme) /third/ = -6

# prioritize newer document
adjscore(babel-german) ngermanb.pdf = +5

# prioritize man page
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
# =======

# Aliases allow to add results for a specific query, by making texdoc search
# for additional keywords in the file name. Matches for the new keyword get a
# very high score by default, but this can be adjusted.
#
# To override one of the settings below, use the 'noalias' directive in
# your personal configuration file, see the manual for details.

## TeX Live documentation

# texlive-en for general, but prioritized local version if exists
alias texlive = texlive-en
alias texlive-cz = texlive-cz
alias texlive-de = texlive-de
alias texlive-en = texlive-en
alias texlive-es = texlive-es
alias texlive-fr = texlive-fr
alias texlive-it = texlive-it
alias texlive-ja = texlive-ja
alias texlive-pl = texlive-pl
alias texlive-ru = texlive-ru
alias texlive-sr = texlive-sr
alias texlive-zh-cn = texlive-zh-cn

alias live = texlive-en
alias live-cz = texlive-cz
alias live-de = texlive-de
alias live-en = texlive-en
alias live-es = texlive-es
alias live-fr = texlive-fr
alias live-it = texlive-it
alias live-ja = texlive-ja
alias live-pl = texlive-pl
alias live-ru = texlive-ru
alias live-sr = texlive-sr
alias live-zh-cn = texlive-zh-cn

alias tex-live = texlive-en
alias tex-live-cz = texlive-cz
alias tex-live-de = texlive-de
alias tex-live-en = texlive-en
alias tex-live-es = texlive-es
alias tex-live-fr = texlive-fr
alias tex-live-it = texlive-it
alias tex-live-ja = texlive-ja
alias tex-live-pl = texlive-pl
alias tex-live-ru = texlive-ru
alias tex-live-sr = texlive-sr
alias tex-live-zh-cn = texlive-zh-cn

## various stuff

# a few useful general documents
alias latex = latex-doc-ptr

# various lshort translations
adjscore(lshort) /lshort-english/ = +0.5                   # original
alias lshort-de = l2kurz                                   # german
alias lshort-ja = jlshort                                  # japanese
alias lshort-pl = lshort-polish/lshort2e                   # polish
alias lshort-pt = pt-lshort                                # portuguese
alias lshort-sk = slshorte                                 # slovak
alias lshort-es = lshort-spanish/lshort-a4                 # spanish

# *TeX engines reference manuals, man pages and related
alias e-tex-ref = etex_man
alias etex-ref = etex_man
alias pdftex-ref = pdftex-a
#alias xetex-ref = xetex-reference # OK
alias xelatex = xetex-reference

# by default, <engine> = <engine>-ref (duplicated: no alias cascading)
alias e-tex = etex_man
alias etex = etex_man
alias pdftex = pdftex-a
#alias xetex = xetex-reference # OK
alias xelatex = xetex-reference

alias e-tex-man = etex.man1
alias etex-man = etex.man1
alias pdftex-man = pdftex.man1
#alias xetex-man = xetex.man1 # missing
alias luatex-man = luatex.man1

# latex/basic classes
alias article = classes
alias book = classes
alias report = classes
#alias ltxguide = ? # missing
#alias minimal = ? # missing
adjscore(minimal) europecv = -1000 # false positive

# latex/basic packages, sorted by dtx
alias doc = base/doc
alias shortvrb = base/doc
alias letter = base/letter
alias slides = base/slides
alias(20) fontenc = encguide
alias(20) textcomp = encguide
alias makeidx = makeindx
alias showidx = makeindx
alias flafter = source2e
alias fontenc = source2e
alias textcomp = source2e
alias tracefnt = source2e
# TODO: try to avoid the huge amount of false positives for `doc' itself.

# latex-dev instruction
alias latex-dev = latex/base/ltnews30
alias(9) latex-dev = latex-dev.man1

# latex's required graphics bundle
alias color-dev = color
alias epsfig-dev = epsfig
alias graphics-dev = graphics
alias graphicx-dev = graphicx
alias color = grfguide
alias epsfig = grfguide
alias graphics = grfguide
alias graphicx = grfguide

# latex's required psnfss2e bundle
alias avant = psnfss2e
alias bookman = psnfss2e
alias chancery = psnfss2e
alias charter = psnfss2e
alias courier = psnfss2e
alias helvet = psnfss2e
alias mathpazo = psnfss2e
alias mathpple = psnfss2e
alias mathptm = psnfss2e
alias mathptmx = psnfss2e
alias newcent = psnfss2e
alias palatino = psnfss2e
alias times = psnfss2e
alias utopia = psnfss2e

# ams
alias amsfonts = amsfndoc
alias amslatex2 = technote
alias amsmath = amsldoc
alias amsrefs = amsrdoc
alias amsthm = amsthdoc
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
alias amsproc-dev = amsclass
alias amsmath-dev = amsmath

# koma-script
alias koma = scrguien
alias koma-script = scrguien
alias scrartcl = scrguien
alias scrbook = scrguien
alias scrreprt = scrguien
alias typearea = scrguien
alias koma-de = scrguide
alias koma-script-de = scrguide
alias scrartcl-de = scrguide
alias scrbook-de = scrguide
alias scrreprt-de = scrguide
alias typearea-de = scrguide

# tugboat package and classes
alias tugboat = ltubguid

# caption
alias caption = caption-eng
alias caption-dev = caption-eng

# metapost by various names
alias metapost = mpman
alias(5) metapost = mpgraph
alias(5) metapost = mpintro
alias mpost = mpman
alias(5) mpost = mpgraph
alias(5) mpost = mpintro
alias mp = mpman
alias(5) mp = mpgraph
alias(5) mp = mpintro

# latex3 and friends
alias latex3 = ltx3info
alias(3) expl3 = interface3
alias(3) expl3 = source3
alias l3bootstrap = interface3
alias l3names = interface3
alias l3basics = interface3
alias l3expan = interface3
alias l3prg = interface3
alias l3quark = interface3
alias l3token = interface3
alias l3int = interface3
alias l3skip = interface3
alias l3tl = interface3
alias l3seq = interface3
alias l3clist = interface3
alias l3prop = interface3
alias l3box = interface3
alias l3coffins = interface3
alias l3color-base = interface3
alias l3regex = interface3
alias l3msg = interface3
alias l3keys = interface3
alias l3file = interface3
alias l3fp = interface3
alias l3luatex = interface3

# misc
alias 3parttable = threeparttable
alias afoot = arabtex-doc
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 cm-super = cm-super/README
alias cmsuper = cm-super/README
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-dev = hyperref.pdf
alias iso = isoman
alias knuth-pdf = knuth-pdf/index.pdf
alias kvoptions-patch = kvoptions  # XXX?
alias layouts = layman
alias lettrine = lettrine          # to hide context/third/lettrine-doc.pdf
alias llmk = light-latex-make/llmk
alias(2) llmk = light-latex-make/README
alias mls = montex
alias musixtex = musixdoc
alias newcm = newcomputermodern/README
alias(5) newcm = newcomputermodern/newcomputermodern-sample.pdf
alias(5) newcm = newcomputermodern/newcm-unimath-symbols.pdf
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 symbols = symbols-a4
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 zztex = zzdetails.dat

## a few easy patterns

# egrep 'manual\.pdf\>'
alias tree-dvips = tree-manual

# egrep 'user\.pdf\>'
alias cweb-latex = cweb-user

# egrep 'doc\.pdf\>'
alias barcode = eandoc.pdf
alias enctex-cz = encdoc
alias ngerman = gerdoc
alias jurabib-de = jbgerdoc
alias ofs-cz = ofsdoc
alias ofs = ofsdoc-e

## aliases basically borrowed from texdoctk.dat with some adaptations
alias akletter = akletter/lettereng
alias arydshln = arydshln-man
alias cv = curve/curve
alias datenumber-de = datenumber/docgerman
alias labels(1) = envlab/elguide
alias expressg = expeg
alias flcards = flashcards
alias lehman = fontinstallationguide
alias gnlogic = gn-logic14
alias kluwer = kluwer/usrman
alias lmfonts = lm-info
alias mathenv = mdwtab
alias montex = mlsquick
alias mltex = mltex/mltex.txt
alias natbib2 = natnotes
alias onrannual = onrannual/README
alias otibet = otibet/unidoc
alias pbdiagram = pb-manual
alias tikz = pgfmanual
alias apmgraph = pmgraph
alias preprint = preprint/README
alias dutch = rapdoc
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 lineno = ulineno
alias texguide = usrguide
alias(5) xypic = xyrefer

## packages from ctan/macros/latex/contrib/misc or with doc in .sty only

# the score used is 4.1 because:
# - it is less than 4.5, the default score of foobar/foobar.pdf for name foobar
# - it is greater than the worse false positive here (.../VERSION for version)
#
# Anyway, this is a hopefully a temporary measure, since work is going on to
# produce suitable documentation for all these packages (thanks to Philipp
# Stephani and Robin Fairbairns mostly).

alias(4.1) 3parttable = 3parttable.sty
alias(4.1) bibcheck = bibcheck.sty
alias(4.1) concrete = concrete.sty
alias(4.1) linsys = linsys.sty
alias(4.1) mitpress = mitpress.sty
alias(4.1) nextpage = nextpage.sty
alias(4.1) setspace = setspace.sty
alias(4.1) statex = statex.sty
alias(4.1) statex2 = statex2.sty
alias(4.1) texilikecover = texilikecover.sty
alias(4.1) thrmappendix = thrmappendix.sty
alias(4.1) topcapt = topcapt.sty
alias(4.1) vrbexin = vrbexin.sty

# Final hack
# ================
#
# The next line has no effect when this file is installed as the last
# configuration file (default) but is useful when you install it as the "tricky"
# configuration file (usually TEXMFHOME/texdoc/texdoc-dist.cnf) whose mere
# existence is a hack to make it easier to run the development version, see
# <https://github.com/TeX-Live/texdoc>.
#
# It is strongly recommended NOT to use it in any other circumstance.
lastfile_switch = true