# texdoc.cnf # # DO NOT edit this file! # # For your personal or local setting, if you are a normal user, run 'texdoc -f' # and use the file indicated by a star. 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'). ### Viewer settings ### # Defaults depend on what is available on you system, as well as you 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 = # (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 ### Other settings ### # 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 # # ext_list = pdf, html, txt, ps, dvi, # Note: empty string at end # badext_list = txt, # Note: empty string at end ### Score ### # Only results with positive scores are displayed (unless mode is 'showall'). # Results with score <= -100 are never displayed. # # You can adjust the score of results containing a pattern with adjscore, # either globally or only for specific keywords # Makefile's are never documentation, just as documents in src or source subdir # -1000 should be enough to kill them adjscore /Makefile = -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 fake matches adjscore /tex-virtual-academy-pl/ = -50 # test and example files are not likely the best documentation adjscore test = -3 adjscore example = -3 adjscore sample = -3 # readme's usually deserve a negative score because they have a bad extension, # but they're still slightly better than other results with negative scores... adjscore readme = 0.1 # Uncomment this to make the man pages have a greater priority #adjscore .man1. = 5 #adjscore .man5. = 5 # 'texdoc' may look like "tex's documentation" but it isn't... 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) guide-to-latex = -10 # only usefull with the book adjscore(latex) latex-web-companion = -10 adjscore(latex) tufte-latex = -10 adjscore(latex) cweb-latex = -10 adjscore(latex) duerer-latex = -10 adjscore(latex) cjw-latex = -10 adjscore(latex) ocr-latex = -10 # file names adjscore(latex) Content_LaTeX_Package_Demo = -10 adjscore(latex) example_latex = -10 adjscore(latex) test_latex = -10 # beamer adjscore(beamer) beamer-tut-pt = -10 adjscore(beamer) beamer-tut-pt/tutorialbeamer = +10 adjscore(beamer) presentations = -10 adjscore(beamer) beamer-FUBerlin = -3 # it is also possible to set the score directly in alias directives # eg, fontinstallationguide is related to fontinst: alias(0.1) fontinst = fontinstallationguide ### Aliases ### ## Essential documentation alias live = texlive-en alias texlive = texlive-en alias latex = latex-doc-ptr ## various stuff # a few useful general documents alias faq-en = newfaq alias faq = newfaq adjscore(symbols) /staves/ = -5 # various lshort translations adjscore(lshort) /lshort-english/ = +3 # original alias lshort-de = l2kurz # german alias lshort-pl = lshort-polish/lshort2e # polish alias lshort-pt = ptlshort # portuguese alias lshort-sk = slshorte # slovak alias lshort-es = lshort-spanish/lshort # 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 luatex-ref = luatexref-t alias etex-man = etex.man1 alias pdftex-man = pdftex.man1 #alias xetex-man = xetex.man1 # should exist... alias luatex-man = luatex.man1 alias luatex-pkg = oberdiek/luatex.pdf # by default, = -ref (duplicated: no alias cascading) alias e-tex = etex_man alias etex = etex_man alias xetex = XeTeX-reference alias luatex = luatexref-t # latex/basic classes alias article = classes alias report = classes alias book = classes #alias ltxguide = ??? #alias minimal = ??? adjscore(minimal) europecv = -1000 # false positive # latex/basic packages, grouped by dtx alias bezier = latex209 alias fleqn = latex209 alias leqno = latex209 alias openbib = latex209 alias t1enc = latex209 alias fix-cm = fixltx2e alias flafter = source2e alias tracefnt = source2e alias fontenc = source2e alias textcomp = source2e alias(20) fontenc = encguide alias(20) textcomp = encguide alias makeidx = makeindx alias showidx = makeindx alias shortvrb = base/doc alias doc = base/doc # TODO: try to avoid the huge amount of false positives for `doc' itself. # latex's required graphics bundle alias graphics = grfguide alias graphicx = grfguide alias color = grfguide alias epsfig = grfguide # latex's required psnfss2e bundle alias mathpazo = psnfss2e alias mathptmx = psnfss2e alias helvet = psnfss2e alias avant = psnfss2e alias courier = psnfss2e alias chancery = psnfss2e alias bookman = psnfss2e alias newcent = psnfss2e alias charter = psnfss2e alias times = psnfss2e alias palatino = psnfss2e alias mathptm = psnfss2e alias mathpple = psnfss2e alias utopia = psnfss2e # ams alias amsmath = amsldoc alias amsthm = amsthdoc alias amsfonts = amsfndoc alias amsrefs = amsrdoc alias amslatex2 = technote # alias amsmath-dev = amsmath alias amscls-dev = amsclass alias amsart-dev = amsclass alias amsproc-dev = amsclass alias amsbook-dev = amsclass # koma-script alias koma-script = scrguien alias koma = scrguien alias scrartcl = scrguien alias scrreprt = scrguien alias scrbook = scrguien alias typearea = scrguien alias koma-script-de = scrguide alias koma-de = scrguide alias scrartcl-de = scrguide alias scrreprt-de = scrguide alias scrbook-de = scrguide alias typearea-de = scrguide # tugboat package and classes alias tugboat = ltubguid # caption alias caption = caption-eng alias caption-dev = caption.pdf # misc alias hyperref = hyperref/manual.pdf alias hyperref-dev = hyperref.pdf alias bibtex = btxdoc alias metapost = mpman alias(5) metapost = mpintro alias(5) metapost = mpgraph alias iso = isoman alias pstricks = pstricks-doc alias xstring-fr = xstring_doc_fr alias isomath = isomath.sty.pdf alias elsarticle = elsdoc alias afoot = arabtex-doc alias vntex = vntex # umbrella document (manual comes first due to catalogue) alias asymptote = asymptote # not mentioned in the catalogue currently alias nonfloat = nonfloat-en alias nonfloat-de = nonfloat alias subdocs = bezos alias dotlessi = bezos alias checkend = bezos alias arabicfont = bezos alias cm-super = cm-super/README alias cmsuper = cm-super/README alias(5) cmsuper = cm-super/FAQ alias cyrillic = cyrillic/00readme.txt alias eqexam = eqexam/readme ## a few easy patterns # egrep 'manual\.pdf\>' alias t-angles = t-manual 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 jurabib-de = jbgerdoc alias ofs = ofsdoc-e alias ofs-cz = ofsdoc alias pst-geo = pst-map3d-doc alias german = gerdoc alias ngerman = gerdoc alias pst-eucl = pst-eucl/euclide_english alias pst-eucl-fr = pst-eucl/euclide ## aliases basically borrowed from texdoctk.dat with some adaptations alias texguide = usrguide alias lehman = fontinstallationguide alias uktugfaq = newfaq alias datenumber-de = datenumber/docgerman alias index = ind alias psnfss = psnfss2e alias euro = eurosamp alias lmfonts = lm-info alias dutch = rapdoc alias montex = mlsquick alias(60) akademia = tex-virtual-academy-pl/index.html alias otibet = otibet/unidoc alias startex = startex/base/guide alias apmgraph = pmgraph alias tikz = pgfmanual alias treetex = tree_doc alias(5) xypic = xyrefer alias pbdiagram = pb-manual alias expressg = expeg alias arydshln = arydshln-man alias natbib2 = natnotes alias tangles = t-angles/t-manual alias mathenv = mdwtab alias gnlogic = gn-logic14 alias labels(1) = envlab/elguide alias lineno = ulineno alias akletter = akletter/lettereng alias mltex = mltex/mltex.txt alias flcards = flashcards alias tex4ht = tex4ht/mn.html alias ppower4 = ppower4/report alias latex3 = ltx3info alias musictex = musicdoc alias kluwer = kluwer/usrman alias cv = curve/curve alias preprint = preprint/00readme.txt alias onrannual = onrannual/README ## 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) morefloats = morefloats.sty alias(4.1) nextpage = nextpage.sty alias(4.1) parskip = parskip.sty alias(4.1) path = path.sty alias(4.1) printlen = printlen.sty alias(4.1) relsize = relsize.sty alias(4.1) romanneg = romanneg.sty alias(4.1) secdot = secdot.sty alias(4.1) section = section.sty alias(4.1) selectp = selectp.sty alias(4.1) sepnum = sepnum.sty alias(4.1) shadow = shadow.sty alias(4.1) showtags = showtags.sty alias(4.1) sphack = sphack.sty alias(4.1) statex2 = statex2.sty alias(4.1) statex = statex.sty alias(4.1) subfigmat = subfigmat.sty alias(4.1) texilikecover = texilikecover.sty alias(4.1) thrmappendix = thrmappendix.sty alias(4.1) topcapt = topcapt.sty alias(4.1) varwidth = varwidth.sty alias(4.1) verbasef = verbasef.sty alias(4.1) version = version.sty alias(4.1) vertbars = vertbars.sty alias(4.1) vrbexin = vrbexin.sty alias(4.1) wrapfig = wrapfig.sty alias(0) theoremref = theoremref.sty alias(0) shadethm = shadethm.sty # 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 the development version, see # . # # It is strongly recommended NOT to use it in any other circumstance. lastfile_switch = true