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 categories specified  in
49              LIST.
50              Available  categories:  config,  files,  search, score, texdocs,
51              tlpdb, version, view, and all to activate all of these.
52
53       -c NAME=VALUE
54              Set configuration item NAME to VALUE.
55

ACTIONS

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

ENVIRONMENT

73       The following environment variables can be split by colon and  used  to
74       set viewers:
75
76       BROWSER, BROWSER_texdoc
77              Set the command to be used for HTML documents.
78
79       DVIVIEWER, DVIVIEWER_texdoc
80              Set the command to be used for DVI documents.
81
82       MDVIEWER, MDVIEWER_texdoc
83              Set the command to be used for Markdown documents.
84
85       PAGER, PAGER_texdoc
86              Set the command to be used for text documents.
87
88       PDFVIEWER, PDFVIEWER_texdoc
89              Set the command to be used for PDF documents.
90
91       PSVIEWER, PSVIEWER_texdoc
92              Set the command to be used for PS documents.
93
94       The following environment variables are also used:
95
96       LANG, LC_ALL, LANGUAGE, LANGUAGE_texdoc
97              Set the locale, which will influence on the search results.
98
99       TEXDOCS
100              In  addition to the documents included in the TeX Live database,
101              Texdoc also searches documentation under TEXMF  trees  specified
102              by the kpathsea variable TEXDOCS.
103

FILES

105       <texmf>/texdoc/texdoc.cnf, see output of the --files option.
106

EXIT STATUS

108       The texdoc command exists with one of the following values:
109
110       0      Success.
111
112       1      Internal error.
113
114       2      Usage error.
115
116       3      No documentation found.
117

REPORTING BUGS

119       Report bugs to texdoc@tug.org.
120       Texdoc home page: http://tug.org/texdoc/
121       Source: https://github.com/TeX-Live/texdoc
122

COPYRIGHT

124       Copyright  2008-2023 Manuel Pe´gourie´-Gonnard, Takuto Asakura, the TeX
125       Live Team.
126       License: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html.
127       This is free software: you are free to change and redistribute it.
128