summaryrefslogtreecommitdiff
path: root/Master/texmf/texdoc/texdoc.cnf
blob: e58ff40bfd6e59f57ec081a39d08ffbb37d0202c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# texdoc.cnf
#
# DO NOT edit this file!
#
# For your personal or local setting, use one of the following files:
# (the star points to the recommended file for a user's personal settings)
#     TEXMFHOME/texdoc/texdoc-<arch>.cnf
# (*) TEXMFHOME/texdoc/texdoc.cnf
#     TEXMFLOCAL/texdoc/texdoc-<arch>.cnf
#     TEXMFLOCAL/texdoc/texdoc.cnf
# where <arch> stands for your architecture (eg, win32, i386-linux,
# powerpc-darwin).  You can get this list with variables expanded by typing
#       texdoc -f
# Those are read by texdoc in this order, and former values
# override later ones.
#
# 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
# environement.  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 file will be delete 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
# alias_switch = true
# ext_list = pdf, html, txt, ps, dvi,	# Note: empty string at end
# badext_list = txt, 			# Note: empty string at end
# verbosity_level = 2 	# Print: 0 nothing, 1 errors, 2 warnings, 3: infos
# debug_list = 		# the empty list
# machine_switch = false

### 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, -1000 should be enough to kill them
adjscore /Makefile = -1000

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

# 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

# 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 symbols = symbols-a4
alias faq-en = newfaq
alias faq = newfaq

# various lshort translations (keep the obvious ones for the tests)
alias lshort = lshort-english/lshort 	# original
alias lshort-bg = lshort-bg 		# bulgarian
alias lshort-zh = lshort-zh-cn		# chinese
alias lshort-nl = lshort-nl-1.3		# dutch
alias lshort-en = -english/lshort	# english (original)
alias lshort-fi = lyhyt2e		# finnish
alias lshort-fr = lshort-fr		# french
alias lshort-de = l2kurz		# german
alias lshort-it = itlshort		# italian
alias lshort-ja = jlshort		# japanese
alias lshort-pl = polish/lshort2e	# polish
alias lshort-pt = ptlshort		# portuguese
alias lshort-ru = lshortru		# russian
alias lshort-sk	= slshorte		# slovak
alias lshort-sl = lshort-slovenian	# slovenian
alias lshort-es	= -spanish/lshort	# spanish
alias lshort-th = lsh132		# thai
alias lshort-tr = lshort-tr		# turkish
alias lshort-uk = lshort-ukr		# ukrainian (package ukr, booh)
alias lshort-vi	= lshort-vi		# vietnamese


# *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
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, <engine> = <engine>-ref (duplicated: no alias cascading)
alias e-tex = etex_man
alias etex = etex_man
alias pdftex = pdftex-a
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
# 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 amslatex = amshelp
alias amscls = instr-l
alias amsart = instr-l
alias amsproc = instr-l
alias amsbook = instr-l
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
alias tugboat-plain = tubguide
alias ltugboat = ltubguid
alias ltugproc = ltubguid

# caption
alias caption = caption-eng
alias caption-de = caption-deu
alias caption-ru = caption-rus
alias caption-dev = caption.pdf

# misc
alias hyperref = hyperref/manual.pdf
alias hyperref-dev = hyperref.pdf
alias psfrag = pfgguide
alias bibtex = btxdoc
alias IEEEtran = IEEEtran_HOWTO
alias metapost = mpman
alias(5) metapost = mpintro
alias(5) metapost = mpgraph
alias iso = isoman
alias pstricks = pstricks-doc
alias extramarks = fancyhdr/fancyhdr
alias fonttable = fonttable/fonttable
alias biocon = biocon/manual.
alias makeindex = makeindex/makeindex
alias ltablex = ltablex.sty
alias comment = comment.sty
alias xstring = xstring_doc_en
alias xstring-fr = xstring_doc_fr
alias isomath = isomath.sty.pdf
alias ucs = ucs/FAQ
alias elsarticle = elsdoc

# cite package (from texlive.tlpdb listing for cite)
alias cite = /cite/README
alias chapterbib = /cite/README
alias drftcite = /cite/README
alias overcite = /cite/README


## a few easy patterns

# egrep 'manual\.pdf\>'
alias pdfslide = pdfslide/demo
alias t-angles = t-manual
alias texmate = texmate2manual
alias tree-dvips = tree-manual

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

# egrep 'doc\.pdf\>'
alias barcode = eandoc.pdf
alias barr = diaxydoc.pdf
alias doublestroke = dsdoc.pdf
alias enctex = encdoc-e
alias enctex-cz = encdoc
alias hyplain = hydoc.pdf
alias jurabib = jbendoc
alias jurabib-de = jbgerdoc
alias juramisc = jmgerdoc
alias marvosym = marvodoc
alias musixtex = musixdoc
alias ofs = ofsdoc-e
alias ofs-cz = ofsdoc
alias petri-nets = pndoc
alias pst-geo = pst-map3d-doc
alias sanskrit = sktdoc
alias german = gerdoc

## 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 genfont1 = fntguide
alias psnfss = psnfss2e
alias astro = astrosym.txt
alias braille = braille/summary
alias brushscr = brushscr/AAA_readme
alias ocherokee = cherokee
alias cmsuper = cm-super/README
alias euro = eurosamp
alias fourier = fourier-doc-en
alias lmfonts = lm-info
alias t1enc1 = fontsmpl
alias yfonts = yfonts/readme
alias mfpic1 = mfpguide
alias dutch = rapdoc
alias montex = mlsquick
alias akademia = tex-virtual-academy-pl/index.html
alias cyrillic = cyrillic/00readme.txt
alias otibet = otibet/unidoc
alias layouts = layman
alias texsis = texsis/base/README
alias startex = startex/base/guide
alias overpic = opic-rel
alias apmgraph = pmgraph
alias metaobj = momanual
alias tikz = pgfmanual
alias treetex = tree_doc
alias PSfrag = pfgguide
alias xypic = xyguide
alias(5) xypic = xyrefer
alias pbdiagram = pb-manual
alias expressg = expeg
alias texpower = texpower/manual
alias ifmslide = ifmman
alias arydshln = arydshln-man
alias multirow = multirow/README
alias titletoc = titlesec
alias custom-bib = custom-bib/makebst
alias ascelike = ascexmpl
alias natbib2 = natnotes
alias adrconv = adrguide
alias tangles = t-angles/t-manual
alias mathenv = mdwtab
alias gnlogic = gn-logic14
alias footnote1 = mdwtools/footnote
alias footnote2 = yafoot/yafoot-man
alias labels1 = envlab/elguide
alias newvbtm = newvbtm-man
alias lineno = ulineno
alias akletter = akletter/lettereng
alias isorot = isorot/rotman
alias MLTeX = mltex/mltex.txt
alias ecards = eCardsman
alias flcards = flashcards
alias tex4ht = tex4ht/mn.html
alias ppower4 = ppower4/report
alias pdfscreen = pdfscreen/manual-print
alias latex3 = ltx3info
alias latex3p = expl3/expl3
alias xmltex = xmltex/base/manual.html
alias musixlyr = mxlyrdoc
alias musictex = musicdoc
alias acmtrans = acmtr2e
alias aastex = aastex/aasguide
alias ieee = IEEEtran_HOWTO
alias nrc = nrc/userguide
alias kluwer = kluwer/usrman
alias spie = spie/article
alias cv = curve/curve
alias preprint = preprint/00readme.txt
alias sffms = sffms_manual

## packages from ctan/macros/latex/contrib/misc
# hope they all contain comments...
# anyway, this is quite bad and should be changed some day

alias 2in1 = 2in1.sty
alias 3parttable = 3parttable.sty
alias a4wide = a4wide.sty
alias a5comb = a5comb.sty
alias acromake = acromake.sty
alias advdate = advdate.sty
alias anonchap = anonchap.sty
alias askinclude = askinclude.sty
alias authoraftertitle = authoraftertitle.sty
alias bibcheck = bibcheck.sty
alias block = block.sty
alias bold-extra = bold-extra.sty
alias boxedminipage = boxedminipage.sty
alias braket = braket.sty
alias breakcites = breakcites.sty
alias cancel = cancel.sty
alias captdef = captdef.sty
alias cases = cases.sty
alias changepage = changepage.sty
alias chbibref = chbibref.sty
alias chngcntr = chngcntr.sty
alias circle = circle.sty
alias concrete = concrete.sty
alias dblfloatfix = dblfloatfix.sty
alias endnotes = endnotes.sty
alias excludeonly = excludeonly.sty
alias fn2end = fn2end.sty
alias fncylab = fncylab.sty
alias fnpara = fnpara.sty
alias framed = framed.sty
alias ftcap = ftcap.sty
alias fwlw = fwlw.sty
alias hypernat = hypernat.sty
alias ifmtarg = ifmtarg.sty
alias import = import.sty
alias isonums = isonums.sty
alias kix = kix.sty
alias linsys = linsys.sty
alias listing = listing.sty
alias magaz = magaz.sty
alias midpage = midpage.sty
alias mitpress = mitpress.sty
alias morefloats = morefloats.sty
alias needspace = needspace.sty
alias nextpage = nextpage.sty
alias nolbreaks = nolbreaks.sty
alias notoccite = notoccite.sty
alias optional = optional.sty
alias oubraces = oubraces.sty
alias parskip = parskip.sty
alias path = path.sty
alias printlen = printlen.sty
alias relsize = relsize.sty
alias romanneg = romanneg.sty
alias sansmath = sansmath.sty
alias secdot = secdot.sty
alias section = section.sty
alias selectp = selectp.sty
alias sepnum = sepnum.sty
alias shadow = shadow.sty
alias showtags = showtags.sty
alias sphack = sphack.sty
alias statex2 = statex2.sty
alias statex = statex.sty
alias subfigmat = subfigmat.sty
alias tabls = tabls.sty
alias texilikecover = texilikecover.sty
alias threeparttable = threeparttable.sty
alias thrmappendix = thrmappendix.sty
alias titleref = titleref.sty
alias topcapt = topcapt.sty
alias truncate = truncate.sty
alias underscore = underscore.sty
alias varwidth = varwidth.sty
alias verbasef = verbasef.sty
alias verbdef = verbdef.sty
alias version = version.sty
alias vertbars = vertbars.sty
alias vrbexin = vrbexin.sty
alias vruler = vruler.sty
alias wrapfig = wrapfig.sty

# the next line has no effect when this file is installed as
# TEXMFMAIN/texdoc/texdoc.cnf but is useful when it is installed as
# TEXMFHOME/texdoc/texdoc-dist.cnf for the purpose of installing a newer
# version of texdoc in one's home (eg, running the development version)
lastfile_switch = true

# vim: ts=8 noexpandtab: