texdoc(1)

1TEXDOC(1)                        Texdoc manual                       TEXDOC(1)
2
3
4

NAME

6       texdoc - find & view documentation in TeX Live
7

SYNOPSIS

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

DESCRIPTION

13       Try  to  find  appropriate TeX documentation for the specified NAME(s).
14       Alternatively, perform the given ACTION and exit.
15

OPTIONS

17       -w, --view
18              Use view mode: start a viewer. (default)
19
20       -m, --mixed
21              Use mixed mode (view or list).
22
23       -l, --list
24              Use list mode: show a list of results.
25
26       -s, --showall
27              Use showall mode: show also "bad" results.
28
29       -i, --interact
30              Use interactive menus. (default)
31
32       -I, --nointeract
33              Use plain lists, no interaction required.
34
35       -M, --machine
36              Machine-readable output for lists (implies -I).
37
38       -q, --quiet
39              Suppress warnings and most error messages.
40
41       -v, --verbose
42              Print additional information (e.g., viewer command).
43
44       -D, --debug
45              Activate all debug output (equal to "--debug=all").
46
47       -d LIST, --debug=LIST
48              Activate debug output restricted to the items specified in LIST.
49              Available items: config, files, search, score,  texdocs,  tlpdb,
50              version, view, and all to activate all of these.
51
52       -c NAME=VALUE
53              Set configuration item NAME to VALUE.
54

ACTIONS

56       -h, --help
57              Print this help message.
58
59       -V, --version
60              Print the version number.
61
62       -f, --files
63              Print the list of configuration files used.
64
65       --just-view FILE
66              Display FILE, given with full path (no searching).
67

ENVIRONMENT

69       BROWSER, BROWSER_texdoc
70              Set the command to be used for HTML documents.
71
72       DVIVIEWER, DVIVIEWER_texdoc
73              Set the command to be used for DVI documents.
74
75       MDVIEWER, MDVIEWER_texdoc
76              Set the command to be used for Markdown documents.
77
78       PAGER, PAGER_texdoc
79              Set the command to be used for text documents.
80
81       PDFVIEWER, PDFVIEWER_texdoc
82              Set the command to be used for PDF documents.
83
84       PSVIEWER, PSVIEWER_texdoc
85              Set the command to be used for PS documents.
86
87       LANG, LC_ALL and so on
88              Set the locale (which will influence on the search results).
89
90       TEXDOCS
91              In  addition to the documents included in the TeX Live database,
92              Texdoc also searches documentation under TEXMF  trees  specified
93              by the kpathsea variable TEXDOCS.
94

FILES

96       <texmf>/texdoc/texdoc.cnf, see output of the --files option.
97

EXIT STATUS

99       The texdoc command exists with one of the following values:
100
101       0      Success.
102
103       1      Internal error.
104
105       2      Usage error.
106
107       3      No documentation found.
108

REPORTING BUGS

110       Report bugs to texdoc@tug.org.
111       Texdoc home page: http://tug.org/texdoc/
112       Source: https://github.com/TeX-Live/texdoc
113

COPYRIGHT

115       Copyright  2018  Manuel Pe´gourie´-Gonnard, Takuto Asakura, Karl Berry,
116       and Norbert Preining.
117       License: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html.
118       This is free software: you are free to change and redistribute it.
119