Debian Codegraph @

texmf-dist/doc/man/man1/texdoc.1

raw
1 .\" generated with Ronn-NG/v0.10.1
2 .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3 .TH "TEXDOC" "1" "February 2025" "Texdoc 4.1.1" "Texdoc manual"
4 .SH "NAME"
5 \fBtexdoc\fR \- find & view documentation in TeX Live
6 .SH "SYNOPSIS"
7 \fBtexdoc\fR [OPTION]\|\.\|\.\|\. NAME\|\.\|\.\|\.
8 .br
9 \fBtexdoc\fR [OPTION]\|\.\|\.\|\. ACTION
10 .SH "DESCRIPTION"
11 Try to find appropriate TeX documentation for the specified NAME(s)\. Alternatively, perform the given ACTION and exit\.
12 .SH "OPTIONS"
13 .TP
14 \fB\-w\fR, \fB\-\-view\fR
15 Use view mode: start a viewer\. \fB(default)\fR
16 .TP
17 \fB\-m\fR, \fB\-\-mixed\fR
18 Use mixed mode (view or list)\.
19 .TP
20 \fB\-l\fR, \fB\-\-list\fR
21 Use list mode: show a list of results\.
22 .TP
23 \fB\-s\fR, \fB\-\-showall\fR
24 Use showall mode: show also "bad" results\.
25 .TP
26 \fB\-i\fR, \fB\-\-interact\fR
27 Use interactive menus\. \fB(default)\fR
28 .TP
29 \fB\-I\fR, \fB\-\-nointeract\fR
30 Use plain lists, no interaction required\.
31 .TP
32 \fB\-M\fR, \fB\-\-machine\fR
33 Machine\-readable output for lists (implies \-I)\.
34 .TP
35 \fB\-q\fR, \fB\-\-quiet\fR
36 Suppress warnings and most error messages\.
37 .TP
38 \fB\-v\fR, \fB\-\-verbose\fR
39 Print additional information (e\.g\., viewer command)\.
40 .TP
41 \fB\-D\fR, \fB\-\-debug\fR
42 Activate all debug output (equal to "\-\-debug=all")\.
43 .TP
44 \fB\-d\fR LIST, \fB\-\-debug\fR=LIST
45 Activate debug output restricted to the categories specified in LIST\.
46 .br
47 Available categories: \fBconfig\fR, \fBfiles\fR, \fBsearch\fR, \fBdocfile\fR, \fBscore\fR, \fBtexdocs\fR, \fBtlpdb\fR, \fBversion\fR, \fBview\fR, and \fBall\fR to activate all of these\.
48 .TP
49 \fB\-c\fR NAME=VALUE
50 Set configuration item NAME to VALUE\.
51 .SH "ACTIONS"
52 .TP
53 \fB\-h\fR, \fB\-\-help\fR
54 Print this help message\.
55 .TP
56 \fB\-V\fR, \fB\-\-version\fR
57 Print the version number\.
58 .TP
59 \fB\-f\fR, \fB\-\-files\fR
60 Print the list of configuration files used\.
61 .TP
62 \fB\-\-just\-view\fR FILE
63 Display FILE, given with full path (no searching)\.
64 .TP
65 \fB\-\-print\-completion\fR SHELL
66 Print SHELL completion\.
67 .SH "ENVIRONMENT"
68 The following environment variables can be split by colon and used to set viewers:
69 .TP
70 \fBBROWSER\fR, \fBBROWSER_texdoc\fR
71 Set the command to be used for HTML documents\.
72 .TP
73 \fBDVIVIEWER\fR, \fBDVIVIEWER_texdoc\fR
74 Set the command to be used for DVI documents\.
75 .TP
76 \fBMDVIEWER\fR, \fBMDVIEWER_texdoc\fR
77 Set the command to be used for Markdown documents\.
78 .TP
79 \fBPAGER\fR, \fBPAGER_texdoc\fR
80 Set the command to be used for text documents\.
81 .TP
82 \fBPDFVIEWER\fR, \fBPDFVIEWER_texdoc\fR
83 Set the command to be used for PDF documents\.
84 .TP
85 \fBPSVIEWER\fR, \fBPSVIEWER_texdoc\fR
86 Set the command to be used for PS documents\.
87 .P
88 The following environment variables are also used:
89 .TP
90 \fBLANG\fR, \fBLC_ALL\fR, \fBLANGUAGE\fR, \fBLANGUAGE_texdoc\fR
91 Set the locale, which will influence on the search results\.
92 .TP
93 \fBTEXDOCS\fR
94 In addition to the documents included in the TeX Live database, Texdoc also searches documentation under TEXMF trees specified by the kpathsea variable \fBTEXDOCS\fR\.
95 .SH "FILES"
96 \fB<texmf>/texdoc/texdoc\.cnf\fR, see output of the \fB\-\-files\fR option\.
97 .SH "EXIT STATUS"
98 The \fBtexdoc\fR command exists with one of the following values:
99 .TP
100 0
101 Success\.
102 .TP
103 1
104 Internal error\.
105 .TP
106 2
107 Usage error\.
108 .TP
109 3
110 No documentation found\.
111 .SH "REPORTING BUGS"
112 Report bugs to \fItexdoc@tug\.org\fR\.
113 .br
114 Texdoc home page: \fIhttp://tug\.org/texdoc/\fR
115 .br
116 Source: \fIhttps://github\.com/TeX\-Live/texdoc\fR
117 .SH "COPYRIGHT"
118 Copyright 2008\-2025 Manuel Pe'gourie'\-Gonnard, Takuto Asakura, the TeX Live Team\.
119 .br
120 License: GNU GPL version 3 or later \fIhttp://gnu\.org/licenses/gpl\.html\fR\.
121 .br
122 This is free software: you are free to change and redistribute it\.
123 .SH "SEE ALSO"
124 The full documentation is maintained as a PDF manual\. The command
125 .IP "" 4
126 .nf
127 texdoc texdoc
128 .fi
129 .IP "" 0
130 .P
131 should give you access to the complete manual\.