summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/texdoc.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-03-28 20:58:51 +0000
committerKarl Berry <karl@freefriends.org>2019-03-28 20:58:51 +0000
commit58f64f141bad7d97ff02df9375bc53453444ba46 (patch)
tree5d6444f973219154f144330bd86f113510bd6910 /Master/texmf-dist/doc/man/man1/texdoc.1
parentf8c6d58ac3a950c7c156180064a167d575d38576 (diff)
texdoc (28mar19)
git-svn-id: svn://tug.org/texlive/trunk@50627 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/texdoc.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/texdoc.1105
1 files changed, 81 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texdoc.1 b/Master/texmf-dist/doc/man/man1/texdoc.1
index 943cf71478c..cf072bd5fce 100644
--- a/Master/texmf-dist/doc/man/man1/texdoc.1
+++ b/Master/texmf-dist/doc/man/man1/texdoc.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "TEXDOC" "1" "June 2018" "Texdoc 3.0" "Texdoc manual"
+.TH "TEXDOC" "1" "March 2019" "Texdoc 3.1" "Texdoc manual"
.
.SH "NAME"
\fBtexdoc\fR \- find & view documentation in TeX Live
@@ -10,29 +10,11 @@
\fBtexdoc\fR [OPTION\.\.\.] NAME\.\.\.
.
.br
-\fBtexdoc\fR ACTION
+\fBtexdoc\fR [OPTION\.\.\.] ACTION
.
.SH "DESCRIPTION"
Try to find appropriate TeX documentation for the specified NAME(s)\. Alternatively, perform the given ACTION and exit\.
.
-.SH "ACTIONS"
-.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Print this help message\.
-.
-.TP
-\fB\-V\fR, \fB\-\-version\fR
-Print the version number\.
-.
-.TP
-\fB\-f\fR, \fB\-\-files\fR
-Print the list of configuration files used\.
-.
-.TP
-\fB\-\-just\-view FILE\fR
-Display file, given with full path (no searching)\.
-.
.SH "OPTIONS"
.
.TP
@@ -69,22 +51,97 @@ Suppress warnings and most error messages\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
-Print additional information (eg, viewer command)\.
+Print additional information (e\.g\., viewer command)\.
.
.TP
\fB\-D\fR, \fB\-\-debug\fR
Activate all debug output (equal to "\-\-debug=all")\.
.
.TP
-\fB\-d\fRLIST, \fB\-\-debug\fR=LIST
-Activate debug output restricted to LIST\.
+\fB\-d\fR LIST, \fB\-\-debug\fR=LIST
+Activate debug output restricted to the items specified in LIST\.
+.
+.br
+Available items: \fBconfig\fR, \fBfiles\fR, \fBsearch\fR, \fBscore\fR, \fBtexdocs\fR, \fBtlpdb\fR, \fBversion\fR, \fBview\fR, and \fBall\fR to activate all of these\.
+.
+.TP
+\fB\-c\fR NAME=VALUE
+Set configuration item NAME to VALUE\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print this help message\.
+.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Print the version number\.
+.
+.TP
+\fB\-f\fR, \fB\-\-files\fR
+Print the list of configuration files used\.
+.
+.TP
+\fB\-\-just\-view\fR FILE
+Display FILE, given with full path (no searching)\.
.
.SH "ENVIRONMENT"
-PAGER, BROWSER, PDFVIEWER, PSVIEWER, DVIVIEWER, and *_texdoc of each\.
+.
+.TP
+\fBBROWSER\fR, \fBBROWSER_texdoc\fR
+Set the command to be used for HTML documents\.
+.
+.TP
+\fBDVIVIEWER\fR, \fBDVIVIEWER_texdoc\fR
+Set the command to be used for DVI documents\.
+.
+.TP
+\fBMDVIEWER\fR, \fBMDVIEWER_texdoc\fR
+Set the command to be used for Markdown documents\.
+.
+.TP
+\fBPAGER\fR, \fBPAGER_texdoc\fR
+Set the command to be used for text documents\.
+.
+.TP
+\fBPDFVIEWER\fR, \fBPDFVIEWER_texdoc\fR
+Set the command to be used for PDF documents\.
+.
+.TP
+\fBPSVIEWER\fR, \fBPSVIEWER_texdoc\fR
+Set the command to be used for PS documents\.
+.
+.TP
+\fBLANG\fR, \fBLC_ALL\fR and so on
+Set the locale (which will influence on the search results)\.
+.
+.TP
+\fBTEXDOCS\fR
+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\.
.
.SH "FILES"
\fB<texmf>/texdoc/texdoc\.cnf\fR, see output of the \fB\-\-files\fR option\.
.
+.SH "EXIT STATUS"
+The \fBtexdoc\fR command exists with one of the following values:
+.
+.TP
+0
+Success\.
+.
+.TP
+1
+Internal error\.
+.
+.TP
+2
+Usage error\.
+.
+.TP
+3
+No documentation found\.
+.
.SH "REPORTING BUGS"
Report bugs to \fItexdoc@tug\.org\fR\.
.