/ [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 4 - (show annotations)
Tue Apr 18 01:07:52 2017 UTC (4 years, 7 months ago) by norbert
File size: 15822 byte(s)
Merge branch 'multi-option-viewer' into svn
1 # texdoc.cnf
2 #
3 # DO NOT edit this file!
4 #
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 test = -3
130 adjscore tests = -3
131 adjscore example = -3
132 adjscore examples = -3
133 adjscore sample = -3
134 adjscore samples = -3
135 adjscore /images/ = -3
136
137 # readme's usually get a negative score because they have a bad extension,
138 # but they're still slightly better than other results with negative scores
139 adjscore readme = 0.1
140
141 # uncomment this to make the man pages have a greater priority
142 #adjscore .man1. = 5
143 #adjscore .man5. = 5
144
145 ## Specific adjustments
146
147 # 'texdoc' may look like "tex's documentation" but it isn't
148 # similar problem with 'tex-*'
149 adjscore(tex) texdoc = -10
150 adjscore(tex) tex-gyre = -10
151 adjscore(tex) tex-ps = -10
152
153 # avoid too many results to be shown for 'latex'
154 # package names
155 adjscore(latex) cjw-latex = -10
156 adjscore(latex) cweb-latex = -10
157 adjscore(latex) duerer-latex = -10
158 adjscore(latex) guide-to-latex = -10 # only useful with the book
159 adjscore(latex) latex-web-companion = -10
160 adjscore(latex) ocr-latex = -10
161 adjscore(latex) tufte-latex = -10
162 # file names
163 adjscore(latex) Content_LaTeX_Package_Demo = -10
164 adjscore(latex) example_latex = -10
165 adjscore(latex) test_latex = -10
166
167 # beamer
168 adjscore(beamer) beamer-tut-pt/tutorialbeamer = +10
169 adjscore(beamer) beamer-FUBerlin = -3
170 adjscore(beamer) beamer-tut-pt = -10
171 adjscore(beamer) presentations = -10
172
173 # misc
174 adjscore(context) circuitikz = -10
175 adjscore(context) /gnuplot/ = -3
176 adjscore(context) context.man1 = +2
177 adjscore(symbols) /staves/ = -5
178
179 # catalogue info missing in the tlcontrib version of the package :-(
180 adjscore(pgf) pgfmanual.pdf = +5
181
182 # context version is found first
183 adjscore(fixme) /third/ = -6
184
185
186 # Aliases
187 # =======
188
189 # Aliases allow to add results for a specific query, by making texdoc search
190 # for additional keywords in the file name. Matches for the new keyword get a
191 # very high score by default, but this can be adjusted.
192 #
193 # To override one of the settings below, use the 'noalias' directive in
194 # your personal configuration file, see the manual for details.
195
196 ## Essential documentation
197
198 alias live = texlive-en
199 alias texlive = texlive-en
200 alias tex-live = texlive-en
201
202 ## various stuff
203
204 # a few useful general documents
205 alias faq-en = newfaq
206 alias faq = newfaq
207 alias latex = latex-doc-ptr
208
209 # various lshort translations
210 adjscore(lshort) /lshort-english/ = +0.5 # original
211 alias lshort-de = l2kurz # german
212 alias lshort-pl = lshort-polish/lshort2e # polish
213 alias lshort-pt = pt-lshort # portuguese
214 alias lshort-sk = slshorte # slovak
215 alias lshort-es = lshort-spanish/lshort-a4 # spanish
216
217 # *TeX engines reference manuals, man pages and related
218 alias e-tex-ref = etex_man
219 alias etex-ref = etex_man
220 alias pdftex-ref = pdftex-a
221 #alias xetex-ref = xetex-reference # OK
222 alias xelatex = xetex-reference
223 alias luatex-ref = luatexref-t
224
225 # by default, <engine> = <engine>-ref (duplicated: no alias cascading)
226 alias e-tex = etex_man
227 alias etex = etex_man
228 alias pdftex = pdftex-a
229 #alias xetex = xetex-reference # OK
230 alias xelatex = xetex-reference
231 alias luatex = luatexref-t
232
233 alias e-tex-man = etex.man1
234 alias etex-man = etex.man1
235 alias pdftex-man = pdftex.man1
236 #alias xetex-man = xetex.man1 # missing
237 alias luatex-man = luatex.man1
238
239 alias luatex-pkg = oberdiek/luatex.pdf
240
241 # latex/basic classes
242 alias article = classes
243 alias book = classes
244 alias report = classes
245 #alias ltxguide = ? # missing
246 #alias minimal = ? # missing
247 adjscore(minimal) europecv = -1000 # false positive
248
249 # latex/basic packages, sorted by dtx
250 alias doc = base/doc
251 alias shortvrb = base/doc
252 alias letter = base/letter
253 alias slides = base/slides
254 alias(20) fontenc = encguide
255 alias(20) textcomp = encguide
256 alias fix-cm = fixltx2e
257 alias bezier = latex209
258 alias fleqn = latex209
259 alias leqno = latex209
260 alias openbib = latex209
261 alias t1enc = latex209
262 alias makeidx = makeindx
263 alias showidx = makeindx
264 alias flafter = source2e
265 alias fontenc = source2e
266 alias textcomp = source2e
267 alias tracefnt = source2e
268 # TODO: try to avoid the huge amount of false positives for `doc' itself.
269
270 # latex's required graphics bundle
271 alias color-dev = color
272 alias epsfig-dev = epsfig
273 alias graphics-dev = graphics
274 alias graphicx-dev = graphicx
275 alias color = grfguide
276 alias epsfig = grfguide
277 alias graphics = grfguide
278 alias graphicx = grfguide
279
280 # latex's required psnfss2e bundle
281 #alias avant = psnfss2e
282 #alias bookman = psnfss2e
283 #alias chancery = psnfss2e
284 alias charter = psnfss2e
285 alias courier = psnfss2e
286 #alias helvet = psnfss2e
287 alias mathpazo = psnfss2e
288 #alias mathpple = psnfss2e
289 #alias mathptm = psnfss2e
290 #alias mathptmx = psnfss2e
291 #alias newcent = psnfss2e
292 #alias palatino = psnfss2e
293 #alias times = psnfss2e
294 alias utopia = psnfss2e
295
296 # ams
297 alias amsfonts = amsfndoc
298 alias amslatex2 = technote
299 alias amsmath = amsldoc
300 alias amsrefs = amsrdoc
301 alias amsthm = amsthdoc
302 alias amsart = instr-l
303 alias amsbook = instr-l
304 alias amscls = instr-l
305 alias amsproc = instr-l
306 alias amsart-dev = amsclass
307 alias amsbook-dev = amsclass
308 alias amscls-dev = amsclass
309 alias amsproc-dev = amsclass
310 alias amsmath-dev = amsmath
311
312 # koma-script
313 alias koma = scrguien
314 alias koma-script = scrguien
315 alias scrartcl = scrguien
316 alias scrbook = scrguien
317 alias scrreprt = scrguien
318 alias typearea = scrguien
319 alias koma-de = scrguide
320 alias koma-script-de = scrguide
321 alias scrartcl-de = scrguide
322 alias scrbook-de = scrguide
323 alias scrreprt-de = scrguide
324 alias typearea-de = scrguide
325
326 # tugboat package and classes
327 alias tugboat = ltubguid
328
329 # caption
330 alias caption = caption-eng
331 alias caption-dev = caption.pdf
332
333 # metapost by various names
334 alias metapost = mpman
335 alias(5) metapost = mpgraph
336 alias(5) metapost = mpintro
337 alias mpost = mpman
338 alias(5) mpost = mpgraph
339 alias(5) mpost = mpintro
340 alias mp = mpman
341 alias(5) mp = mpgraph
342 alias(5) mp = mpintro
343
344 # latex3 and friends
345 alias latex3 = ltx3info
346 alias l3bootstrap = interface3
347 alias l3names = interface3
348 alias l3basics = interface3
349 alias l3expan = interface3
350 alias l3prg = interface3
351 alias l3quark = interface3
352 alias l3token = interface3
353 alias l3int = interface3
354 alias l3skip = interface3
355 alias l3tl = interface3
356 alias l3seq = interface3
357 alias l3clist = interface3
358 alias l3prop = interface3
359 alias l3box = interface3
360 alias l3coffins = interface3
361 alias l3color = interface3
362 alias l3msg = interface3
363 alias l3keys = interface3
364 alias l3file = interface3
365 alias l3fp = interface3
366 alias l3luatex = interface3
367
368 # misc
369 alias autofe = ucs
370 alias afoot = arabtex-doc
371 alias arabicfont = bezos
372 alias bibtex = btxdoc
373 alias changes = changes.english.pdf
374 alias(5) cmsuper = cm-super/FAQ
375 alias cm-super = cm-super/README
376 alias cmsuper = cm-super/README
377 alias cyrillic = cyrillic/00readme.txt
378 alias elsarticle = elsdoc
379 alias(0.1) fontinst = fontinstallationguide
380 alias hyperref = hyperref/manual.pdf
381 alias hyperref-dev = hyperref.pdf
382 alias iso = isoman
383 alias lettrine = lettrine # to hide context/third/lettrine-doc.pdf
384 alias nonfloat-de = nonfloat
385 alias nonfloat = nonfloat-en
386 alias xstring-fr = xstring_doc_fr
387 alias arabic = arabi/user_guide
388 alias 3parttable = threeparttable
389 alias croatian = babel
390 alias mls = montex
391 alias vrbexin = verbasef
392 alias dtk = dtk/doc/beispiel.pdf
393 alias musixtex = musixdoc
394 alias mychemistry = mychemistry_en
395 alias mychemistry-de = mychemistry_de
396 alias cjk = CJK.txt # FIXME: should be case insensitive
397 alias ieee = IEEEtran_HOWTO
398 alias layouts = layman
399 alias plnfss = plnfss.txt # XXX
400 alias teubner = teubner-doc
401 alias xypic = xyguide
402 alias kvoptions-patch = kvoptions # XXX?
403 alias cweb = cwebman # XXX: is in 'cweb' dir, should win
404 alias einfuehrung = einfuehrung/README # tl should get "readme" tag
405
406 ## a few easy patterns
407
408 # egrep 'manual\.pdf\>'
409 alias tree-dvips = tree-manual
410
411 # egrep 'user\.pdf\>'
412 alias cweb-latex = cweb-user
413
414 # egrep 'doc\.pdf\>'
415 alias barcode = eandoc.pdf
416 alias enctex-cz = encdoc
417 alias ngerman = gerdoc
418 alias jurabib-de = jbgerdoc
419 alias ofs-cz = ofsdoc
420 alias ofs = ofsdoc-e
421 alias pst-geo = pst-map3d-doc
422
423 ## aliases basically borrowed from texdoctk.dat with some adaptations
424
425 alias akletter = akletter/lettereng
426 alias arydshln = arydshln-man
427 alias cv = curve/curve
428 alias datenumber-de = datenumber/docgerman
429 alias labels(1) = envlab/elguide
430 alias expressg = expeg
431 alias flcards = flashcards
432 alias lehman = fontinstallationguide
433 alias gnlogic = gn-logic14
434 alias kluwer = kluwer/usrman
435 alias lmfonts = lm-info
436 alias mathenv = mdwtab
437 alias montex = mlsquick
438 alias mltex = mltex/mltex.txt
439 alias natbib2 = natnotes
440 alias uktugfaq = newfaq
441 alias onrannual = onrannual/README
442 alias otibet = otibet/unidoc
443 alias pbdiagram = pb-manual
444 alias tikz = pgfmanual
445 alias apmgraph = pmgraph
446 alias preprint = preprint/00readme.txt
447 alias dutch = rapdoc
448 alias startex = startex/base/guide
449 alias tangles = t-angles/t-manual
450 alias tex4ht = tex4ht/mn.html
451 alias(60) akademia = tex-virtual-academy-pl/index.html
452 alias treetex = tree_doc
453 alias lineno = ulineno
454 alias texguide = usrguide
455 alias(5) xypic = xyrefer
456
457 ## packages from ctan/macros/latex/contrib/misc or with doc in .sty only
458
459 # the score used is 4.1 because:
460 # - it is less than 4.5, the default score of foobar/foobar.pdf for name foobar
461 # - it is greater than the worse false positive here (.../VERSION for version)
462 #
463 # Anyway, this is a hopefully a temporary measure, since work is going on to
464 # produce suitable documentation for all these packages (thanks to Philipp
465 # Stephani and Robin Fairbairns mostly).
466
467 alias(4.1) 3parttable = 3parttable.sty
468 alias(4.1) bibcheck = bibcheck.sty
469 alias(4.1) concrete = concrete.sty
470 alias(4.1) linsys = linsys.sty
471 alias(4.1) mitpress = mitpress.sty
472 alias(4.1) nextpage = nextpage.sty
473 alias(4.1) statex2 = statex2.sty
474 alias(4.1) statex = statex.sty
475 alias(4.1) texilikecover = texilikecover.sty
476 alias(4.1) thrmappendix = thrmappendix.sty
477 alias(4.1) topcapt = topcapt.sty
478 alias(4.1) vrbexin = vrbexin.sty
479
480
481 # Final hack
482 #
483 # The next line has no effect when this file is installed as the last
484 # configuration file (default) but is useful when you install it as the "tricky"
485 # configuration file (usually TEXMFHOME/texdoc/texdoc-dist.cnf) whose mere
486 # existence is a hack to make it easier to run the the development version, see
487 # <http://tug.org/texdoc/dev/>.
488 #
489 # It is strongly recommended NOT to use it in any other circumstance.
490 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