/ [texdoc] / trunk / texdoc.cnf
To checkout: svn checkout http://svn.gnu.org.ua/sources/texdoc/trunk/texdoc.cnf
Puszcza

Contents of /trunk/texdoc.cnf

Parent Directory Parent Directory | Revision Log Revision Log


Revision 30 - (show annotations)
Tue Apr 17 21:47:32 2018 UTC (3 years, 5 months ago) by karl
File size: 16300 byte(s)
texdoc.cnf psnfss2e updates,etc.
1 # original texdoc.cnf -- default runtime configuration for texdoc.
2 # Public domain.
3 #
4 # DO NOT edit this file!
5 # For your personal settings, run 'texdoc -f' and use the file indicated by a
6 # star; you may need to create it. DO NOT copy the present file, please
7 # create a new one (you may want to copy/paste/edit portions of the present
8 # file however, or just read it for inspiration).
9 #
10 # For system-wide configuration or other uses, you may want to use the other
11 # files listed, see the manual (texdoc texdoc) for details. The files are read
12 # in the order they are printed. If a value is set multiple times, first wins.
13 #
14 # In those files, you can set your preferred viewer for various formats,
15 # some nice names (alias) for specific documentation, and your preferred default
16 # values of texdoc's configuration settings.
17 #
18 # Everything after a # on a line is ignored.
19 # Spaces at the beginning/end of a line, as well as empty lines, are ignored.
20 #
21 # For more details, see the texdoc manual (try `texdoc texdoc').
22
23
24 # General settings
25 # ================
26
27 ## Viewers
28
29 # Defaults depend on what is available on your system, as well as your desktop
30 # environment. Here are a few examples.
31 #
32 # %s is optional and stands for the filename.
33 #
34 # viewer_pdf = xpdf # works
35 # viewer_pdf = xpdf %s & # works even better
36
37 # If you want to enable support for zipped documentation (see below),
38 # you may want to adapt viewer_* so that it starts a subshell:
39 #
40 # viewer_pdf = (xpdf %s) &
41 #
42 # Otherwise, the & will have no effect since the viewing command is followed by
43 # some cleanup-commands for temporary files. For the same reason, %s must be the
44 # last thing on your command line: (xpdf %s -option) will not work.
45 #
46 # WARNING: for zip support your viewer needs to be blocking, i.e. it must not
47 # return immediately: otherwise the temporary file will be deleted too early.
48
49 ## Zipped documentation support
50
51 # WARNING: support for zipped documents works only on Unix. Make sure that the
52 # values of the associated options are adapted to your system. Read the above
53 # warning concerning viewers.
54
55 # Built-in defaults (for reference):
56 #
57 # zipext_list = # (empty list)
58 # rm_file = rm -f
59 # rm_dir = rmdir
60 #
61 # For each "ext" in zipext_list, you must define a "unzip_ext" unzipper.
62 # The unzipped data must be printed on stdout. Example:
63 #
64 # zipext_list = gz
65 # unzip_gz = gzip -d -c
66
67 ## User interaction
68
69 # Built-in defaults (for reference):
70 #
71 # mode = view
72 #
73 # interact_switch = true
74 # machine_switch = false
75 #
76 # verbosity_level = 2 # Print: 0: nothing, 1: errors, 2: warnings, 3: infos
77 # debug_list = # the empty list
78
79 ## Documentation searching
80
81 # Built-in defaults (for reference):
82 #
83 # ext_list = pdf, htm, html, txt, ps, dvi, # Note: empty string at end
84 # badext_list = txt, # Note: empty string at end
85 # basename_list = readme, 00readme
86 # badbasename_list = readme, 00readme
87
88 # Known suffixes for documentation
89 suffix_list = doc, -doc, _doc, .doc, /doc, manual, /manual, -manual, userguide, /user_guide, -guide, -user, -man, notes, -info, ref
90
91
92 # Score adjustments
93 # =================
94
95 # Results are sorted by score (decreasing).
96 # Only results with positive scores are displayed (unless mode is 'showall').
97 # Results with score <= -100 are never displayed.
98 #
99 # The score of results containing a given pattern can be adjusted using the
100 # 'adjscore' directive, either globally or only for specific queries. It is
101 # also possible to set the score directly in alias directives, see the next
102 # section.
103 #
104 # As a general rule, use 'adjscore' if you only want to adjust the score of
105 # particular results, and 'alias' if you want to add new results (possibly
106 # adjusting their score) for a particular query.
107 #
108 # To override one of the settings below, use the 'noadjscore' directive in
109 # your personal configuration file, see the manual for details.
110
111 ## General adjustments
112
113 # Makefile are never documentation, just as documents in src or source subdir
114 # -1000 should be enough to kill them
115 adjscore /Makefile = -1000
116 adjscore /src/ = -1000
117 adjscore /source/ = -1000
118
119 # licence files aren't very likely to contain relevant documentation, but it
120 # feels wrong to totally kill them
121 adjscore copying = -10
122 adjscore license = -10
123 adjscore gpl = -10
124
125 # tex-virtual-academy provides a lot of spurious matches
126 adjscore /tex-virtual-academy-pl/ = -50
127
128 # test and example files are not likely the best documentation
129 adjscore example = -3
130 adjscore examples = -3
131 adjscore sample = -3
132 adjscore samples = -3
133 adjscore test = -3
134 adjscore tests = -3
135 adjscore /demo/ = -3
136 adjscore /demos/ = -3
137 adjscore /figures/ = -3
138 adjscore /images/ = -3
139
140 # readme's usually get a negative score because they have a bad extension,
141 # but they're still slightly better than other results with negative scores
142 adjscore readme = 0.1
143
144 # uncomment this to make the man pages have a greater priority
145 #adjscore .man1. = 5
146 #adjscore .man5. = 5
147
148 ## Specific adjustments
149
150 # 'texdoc' may look like "tex's documentation" but it isn't
151 # similar problem with 'tex-*'
152 adjscore(tex) texdoc = -10
153 adjscore(tex) tex-gyre = -10
154 adjscore(tex) tex-ps = -10
155
156 # avoid too many results to be shown for 'latex'
157 # package names
158 adjscore(latex) cjw-latex = -10
159 adjscore(latex) cweb-latex = -10
160 adjscore(latex) duerer-latex = -10
161 adjscore(latex) guide-to-latex = -10 # only useful with the book
162 adjscore(latex) latex-web-companion = -10
163 adjscore(latex) ocr-latex = -10
164 adjscore(latex) tufte-latex = -10
165 # file names
166 adjscore(latex) Content_LaTeX_Package_Demo = -10
167 adjscore(latex) example_latex = -10
168 adjscore(latex) test_latex = -10
169
170 # beamer
171 adjscore(beamer) beamer-tut-pt/tutorialbeamer = +10
172 adjscore(beamer) beamer-FUBerlin = -3
173 adjscore(beamer) beamer-tut-pt = -10
174 adjscore(beamer) presentations = -10
175
176 # misc
177 adjscore(context) circuitikz = -10
178 adjscore(context) /gnuplot/ = -3
179 adjscore(context) context.man1 = +2
180 adjscore(symbols) /staves/ = -5
181
182 # catalogue info missing in the tlcontrib version of the package :-(
183 adjscore(pgf) pgfmanual.pdf = +5
184
185 # another catalogue info missing case
186 adjscore(hyph-utf8) hyphenation.pdf = +5
187
188 # let's not have context version found first
189 adjscore(fixme) /third/ = -6
190
191 # prioritize newer document
192 adjscore(babel-german) ngermanb.pdf = +5
193
194 # prioritize man page
195 adjscore(findhyph) findhyph.man1 = +5
196
197
198 # Aliases
199 # =======
200
201 # Aliases allow to add results for a specific query, by making texdoc search
202 # for additional keywords in the file name. Matches for the new keyword get a
203 # very high score by default, but this can be adjusted.
204 #
205 # To override one of the settings below, use the 'noalias' directive in
206 # your personal configuration file, see the manual for details.
207
208 ## Essential documentation
209
210 alias live = texlive-en
211 alias texlive = texlive-en
212 alias tex-live = texlive-en
213
214 ## various stuff
215
216 # a few useful general documents
217 alias faq-en = newfaq
218 alias faq = newfaq
219 alias latex = latex-doc-ptr
220
221 # various lshort translations
222 adjscore(lshort) /lshort-english/ = +0.5 # original
223 alias lshort-de = l2kurz # german
224 alias lshort-pl = lshort-polish/lshort2e # polish
225 alias lshort-pt = pt-lshort # portuguese
226 alias lshort-sk = slshorte # slovak
227 alias lshort-es = lshort-spanish/lshort-a4 # spanish
228
229 # *TeX engines reference manuals, man pages and related
230 alias e-tex-ref = etex_man
231 alias etex-ref = etex_man
232 alias pdftex-ref = pdftex-a
233 #alias xetex-ref = xetex-reference # OK
234 alias xelatex = xetex-reference
235 alias luatex-ref = luatexref-t
236
237 # by default, <engine> = <engine>-ref (duplicated: no alias cascading)
238 alias e-tex = etex_man
239 alias etex = etex_man
240 alias pdftex = pdftex-a
241 #alias xetex = xetex-reference # OK
242 alias xelatex = xetex-reference
243 alias luatex = luatexref-t
244
245 alias e-tex-man = etex.man1
246 alias etex-man = etex.man1
247 alias pdftex-man = pdftex.man1
248 #alias xetex-man = xetex.man1 # missing
249 alias luatex-man = luatex.man1
250
251 alias luatex-pkg = oberdiek/luatex.pdf
252
253 # latex/basic classes
254 alias article = classes
255 alias book = classes
256 alias report = classes
257 #alias ltxguide = ? # missing
258 #alias minimal = ? # missing
259 adjscore(minimal) europecv = -1000 # false positive
260
261 # latex/basic packages, sorted by dtx
262 alias doc = base/doc
263 alias shortvrb = base/doc
264 alias letter = base/letter
265 alias slides = base/slides
266 alias(20) fontenc = encguide
267 alias(20) textcomp = encguide
268 alias fix-cm = fixltx2e
269 alias bezier = latex209
270 alias fleqn = latex209
271 alias leqno = latex209
272 alias openbib = latex209
273 alias t1enc = latex209
274 alias makeidx = makeindx
275 alias showidx = makeindx
276 alias flafter = source2e
277 alias fontenc = source2e
278 alias textcomp = source2e
279 alias tracefnt = source2e
280 # TODO: try to avoid the huge amount of false positives for `doc' itself.
281
282 # latex's required graphics bundle
283 alias color-dev = color
284 alias epsfig-dev = epsfig
285 alias graphics-dev = graphics
286 alias graphicx-dev = graphicx
287 alias color = grfguide
288 alias epsfig = grfguide
289 alias graphics = grfguide
290 alias graphicx = grfguide
291
292 # latex's required psnfss2e bundle
293 alias avant = psnfss2e
294 alias bookman = psnfss2e
295 alias chancery = psnfss2e
296 alias charter = psnfss2e
297 alias courier = psnfss2e
298 alias helvet = psnfss2e
299 alias mathpazo = psnfss2e
300 alias mathpple = psnfss2e
301 alias mathptm = psnfss2e
302 alias mathptmx = psnfss2e
303 alias newcent = psnfss2e
304 alias palatino = psnfss2e
305 alias times = psnfss2e
306 alias utopia = psnfss2e
307
308 # ams
309 alias amsfonts = amsfndoc
310 alias amslatex2 = technote
311 alias amsmath = amsldoc
312 alias amsrefs = amsrdoc
313 alias amsthm = amsthdoc
314 alias amsart = instr-l
315 alias amsbook = instr-l
316 alias amscls = instr-l
317 alias amsproc = instr-l
318 alias amsart-dev = amsclass
319 alias amsbook-dev = amsclass
320 alias amscls-dev = amsclass
321 alias amsproc-dev = amsclass
322 alias amsmath-dev = amsmath
323
324 # koma-script
325 alias koma = scrguien
326 alias koma-script = scrguien
327 alias scrartcl = scrguien
328 alias scrbook = scrguien
329 alias scrreprt = scrguien
330 alias typearea = scrguien
331 alias koma-de = scrguide
332 alias koma-script-de = scrguide
333 alias scrartcl-de = scrguide
334 alias scrbook-de = scrguide
335 alias scrreprt-de = scrguide
336 alias typearea-de = scrguide
337
338 # tugboat package and classes
339 alias tugboat = ltubguid
340
341 # caption
342 alias caption = caption-eng
343 alias caption-dev = caption.pdf
344
345 # metapost by various names
346 alias metapost = mpman
347 alias(5) metapost = mpgraph
348 alias(5) metapost = mpintro
349 alias mpost = mpman
350 alias(5) mpost = mpgraph
351 alias(5) mpost = mpintro
352 alias mp = mpman
353 alias(5) mp = mpgraph
354 alias(5) mp = mpintro
355
356 # latex3 and friends
357 alias latex3 = ltx3info
358 alias l3bootstrap = interface3
359 alias l3names = interface3
360 alias l3basics = interface3
361 alias l3expan = interface3
362 alias l3prg = interface3
363 alias l3quark = interface3
364 alias l3token = interface3
365 alias l3int = interface3
366 alias l3skip = interface3
367 alias l3tl = interface3
368 alias l3seq = interface3
369 alias l3clist = interface3
370 alias l3prop = interface3
371 alias l3box = interface3
372 alias l3coffins = interface3
373 alias l3color = interface3
374 alias l3msg = interface3
375 alias l3keys = interface3
376 alias l3file = interface3
377 alias l3fp = interface3
378 alias l3luatex = interface3
379
380 # misc
381 alias autofe = ucs
382 alias afoot = arabtex-doc
383 alias arabicfont = bezos
384 alias bibtex = btxdoc
385 alias changes = changes.english.pdf
386 alias(5) cmsuper = cm-super/FAQ
387 alias cm-super = cm-super/README
388 alias cmsuper = cm-super/README
389 alias cyrillic = cyrillic/00readme.txt
390 alias elsarticle = elsdoc
391 alias(0.1) fontinst = fontinstallationguide
392 alias hyperref = hyperref/manual.pdf
393 alias hyperref-dev = hyperref.pdf
394 alias iso = isoman
395 alias lettrine = lettrine # to hide context/third/lettrine-doc.pdf
396 alias nonfloat-de = nonfloat
397 alias nonfloat = nonfloat-en
398 alias xstring-fr = xstring_doc_fr
399 alias arabic = arabi/user_guide
400 alias 3parttable = threeparttable
401 alias croatian = babel
402 alias mls = montex
403 alias vrbexin = verbasef
404 alias dtk = dtk/doc/beispiel.pdf
405 alias musixtex = musixdoc
406 alias mychemistry = mychemistry_en
407 alias mychemistry-de = mychemistry_de
408 alias cjk = CJK.txt # FIXME: should be case insensitive
409 alias ieee = IEEEtran_HOWTO
410 alias layouts = layman
411 alias plnfss = plnfss.txt # XXX
412 alias teubner = teubner-doc
413 alias xypic = xyguide
414 alias kvoptions-patch = kvoptions # XXX?
415 alias cweb = cwebman # XXX: is in 'cweb' dir, should win
416 alias einfuehrung = einfuehrung/README # tl should get "readme" tag
417
418 ## a few easy patterns
419
420 # egrep 'manual\.pdf\>'
421 alias tree-dvips = tree-manual
422
423 # egrep 'user\.pdf\>'
424 alias cweb-latex = cweb-user
425
426 # egrep 'doc\.pdf\>'
427 alias barcode = eandoc.pdf
428 alias enctex-cz = encdoc
429 alias ngerman = gerdoc
430 alias jurabib-de = jbgerdoc
431 alias ofs-cz = ofsdoc
432 alias ofs = ofsdoc-e
433 alias pst-geo = pst-map3d-doc
434
435 ## aliases basically borrowed from texdoctk.dat with some adaptations
436
437 alias akletter = akletter/lettereng
438 alias arydshln = arydshln-man
439 alias cv = curve/curve
440 alias datenumber-de = datenumber/docgerman
441 alias labels(1) = envlab/elguide
442 alias expressg = expeg
443 alias flcards = flashcards
444 alias lehman = fontinstallationguide
445 alias gnlogic = gn-logic14
446 alias kluwer = kluwer/usrman
447 alias lmfonts = lm-info
448 alias mathenv = mdwtab
449 alias montex = mlsquick
450 alias mltex = mltex/mltex.txt
451 alias natbib2 = natnotes
452 alias uktugfaq = newfaq
453 alias onrannual = onrannual/README
454 alias otibet = otibet/unidoc
455 alias pbdiagram = pb-manual
456 alias tikz = pgfmanual
457 alias apmgraph = pmgraph
458 alias preprint = preprint/00readme.txt
459 alias dutch = rapdoc
460 alias startex = startex/base/guide
461 alias tangles = t-angles/t-manual
462 alias tex4ht = tex4ht/mn.html
463 alias(60) akademia = tex-virtual-academy-pl/index.html
464 alias treetex = tree_doc
465 alias lineno = ulineno
466 alias texguide = usrguide
467 alias(5) xypic = xyrefer
468
469 ## packages from ctan/macros/latex/contrib/misc or with doc in .sty only
470
471 # the score used is 4.1 because:
472 # - it is less than 4.5, the default score of foobar/foobar.pdf for name foobar
473 # - it is greater than the worse false positive here (.../VERSION for version)
474 #
475 # Anyway, this is a hopefully a temporary measure, since work is going on to
476 # produce suitable documentation for all these packages (thanks to Philipp
477 # Stephani and Robin Fairbairns mostly).
478
479 alias(4.1) 3parttable = 3parttable.sty
480 alias(4.1) bibcheck = bibcheck.sty
481 alias(4.1) concrete = concrete.sty
482 alias(4.1) linsys = linsys.sty
483 alias(4.1) mitpress = mitpress.sty
484 alias(4.1) nextpage = nextpage.sty
485 alias(4.1) setspace = setspace.sty
486 alias(4.1) statex = statex.sty
487 alias(4.1) statex2 = statex2.sty
488 alias(4.1) texilikecover = texilikecover.sty
489 alias(4.1) thrmappendix = thrmappendix.sty
490 alias(4.1) topcapt = topcapt.sty
491 alias(4.1) vrbexin = vrbexin.sty
492
493
494 # Final hack
495 #
496 # The next line has no effect when this file is installed as the last
497 # configuration file (default) but is useful when you install it as the "tricky"
498 # configuration file (usually TEXMFHOME/texdoc/texdoc-dist.cnf) whose mere
499 # existence is a hack to make it easier to run the the development version, see
500 # <http://tug.org/texdoc/dev/>.
501 #
502 # It is strongly recommended NOT to use it in any other circumstance.
503 lastfile_switch = true

Properties

Name Value
svn:eol-style native

Send suggestions and bug reports to Sergey Poznyakoff
ViewVC Help
Powered by ViewVC 1.1.20