texdoc(1)

1texdoc(1)                           TeXLive                          texdoc(1)
2
3
4

NAME

6       texdoc - Utility to look up TeX documentation
7

SYNOPSIS

9       texdoc [ OPTION ... ]  NAME [ ... ]
10

DESCRIPTION

12       texdoc  seaches  for NAME in the TeX documentation and starts an appro‐
13       priate viewer.
14
15       NAME should be the name of a command or package in  the  TeX  distribu‐
16       tion.
17

OPTIONS

19       --help Display a brief summary of options.
20
21       -l     List matching files.  Does not start a viewer.
22
23       -s     Search  the  disk. From all documentation files found by texdoc,
24              the ones whose names match the  remaining  arguments  (as  egrep
25              pattern) will be displayed.
26
27       -v     Sets  verbose mode.  Shows the command being used to display the
28              documentation.
29

ENVIRONMENT

31       $TEXDOCVIEW_dvi
32              DVI viewer. The default is to use the program specified  by  the
33              freedesktop standard.
34
35       $TEXDOCVIEW_pdf
36              PDF  viewer.  The default is to use the program specified by the
37              freedesktop standard.
38
39       $TEXDOCVIEW_ps
40              PostScript viewer. The default is to use the  program  specified
41              by the freedesktop standard.
42
43       $TEXDOCVIEW_html
44              HTML viewer. The default is to use a program through xdg-open.
45
46       $TEXDOCVIEW_txt
47              Text  viewer.   Defaults  is to use the program specified by the
48              freedesktop standard.
49
50       The environment variables should be set with a ``%s'' as a  placeholder
51       for the name of the file.  For example,
52
53       hostname% setenv TEXDOCVIEW_pdf "gv %s"
54
55       or
56
57       hostname$ TEXDOCVIEW_html="mozilla %s"
58
59       hostname$ export TEXDOCVIEW_html
60

SPECIFIC TO DEBIAN AND FEDORA

62       The  Debian  and  Fedora  TeX Live packages texdoc use the mime-support
63       package to determine the appropriate viewer  for  the  respective  file
64       type  except  for  dvi.  texdoc  of Debian and Fedora is able to handle
65       gzip- and bzip2-compressed files. If texdoc finds more than on file for
66       a  string  the first hit is displayed. The file extensions are regarded
67       and the search order can be configured in texmf.cnf (90TeXDoc.cnf).
68

BUGS

75       None known, but report any bugs found  to  <tex-live@tug.org>  (mailing
76       list).
77

AUTHOR

79       texdoc  was  written  by  Thomas  Esser <te@dbs.uni-hannover.de>, David
80       Aspinall <da@dcs.ed.ac.uk>, and Simon Wilkinson <sxw@dcs.ed.ac.uk> dur‐
81       ing 1998 and 1999.  texdoc is in the public domain.
82
83       This  manual  page was written by C.M. Connelly <c@eskimo.com>, for the
84       Debian GNU/Linux system.  It may be used by other distributions without
85       contacting  the  author.   Any mistakes or omissions in the manual page
86       are my fault; inquiries about or corrections to this manual page should
87       be directed to me (and not to the primary author).
88
89
90
91TeXLive                         September 2000                       texdoc(1)