diff options
author | Manuel Pégourié-Gonnard <mpg@elzevir.fr> | 2010-02-22 13:29:41 +0000 |
---|---|---|
committer | Manuel Pégourié-Gonnard <mpg@elzevir.fr> | 2010-02-22 13:29:41 +0000 |
commit | c49d87e1fd943a8309dba938dc8d6900f4295a5e (patch) | |
tree | a51c82a6631869cca9a30988236e70b68ecb2058 /Master/texmf/doc | |
parent | 2cb8796c405b33fe218e514526426f2b5c41c8ee (diff) |
Texdoc 0.66 addressing various problems.
git-svn-id: svn://tug.org/texlive/trunk@17143 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc')
-rw-r--r-- | Master/texmf/doc/man/man1/texdoc.1 | 46 | ||||
-rw-r--r-- | Master/texmf/doc/man/man1/texdoc.man1.pdf | bin | 5498 -> 5506 bytes | |||
-rw-r--r-- | Master/texmf/doc/texdoc/News | 22 | ||||
-rw-r--r-- | Master/texmf/doc/texdoc/texdoc.pdf | bin | 207519 -> 208206 bytes | |||
-rw-r--r-- | Master/texmf/doc/texdoc/texdoc.tex | 30 |
5 files changed, 61 insertions, 37 deletions
diff --git a/Master/texmf/doc/man/man1/texdoc.1 b/Master/texmf/doc/man/man1/texdoc.1 index 940b658f8d0..56a0112a5c8 100644 --- a/Master/texmf/doc/man/man1/texdoc.1 +++ b/Master/texmf/doc/man/man1/texdoc.1 @@ -1,20 +1,27 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH TEXDOC "1" "February 2010" "texdoc 0.65" "User Commands" +.TH TEXDOC "1" "February 2010" "texdoc 0.66" "User Commands" .SH NAME texdoc \- find & view documentation in TeX Live .SH SYNOPSIS .B texdoc -[\fIOPTIONS\fR]... [\fINAME\fR]... +[\fIOPTION\fR]... [\fINAME\fR]... .SH DESCRIPTION -texdoc tries to find appropriate TeX documentation for the specified NAME(s). -With no NAME, it can print configuration information (\fB\-f\fR, \fB\-\-files\fR); -the usual \fB\-\-help\fR and \fB\-\-version\fR options are also accepted. +Try to find appropriate TeX documentation for the specified NAME(s). +The default (view mode) is to display the documentation. +.PP +With no NAME, print information about texdoc (\fB\-\-help\fR, \fB\-\-version\fR, \fB\-\-files\fR). +.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 name of the config files being used. +Print the list of configuration files used. .TP \fB\-w\fR, \fB\-\-view\fR -Use view mode: start a viewer. +Use view mode: start a viewer. (default) .TP \fB\-m\fR, \fB\-\-mixed\fR Use mixed mode (view or list). @@ -25,38 +32,35 @@ Use list mode: show a list of results. \fB\-s\fR, \fB\-\-showall\fR Use showall mode: show also "bad" results. .TP -\fB\-r\fR, \fB\-\-regex\fR -Use regex mode. (Deprecated.) -.TP -\fB\-e\fR, \fB\-\-extensions\fR=\fIL\fR -Set ext_list=L. (Deprecated.) +\fB\-M\fR, \fB\-\-machine\fR +Machine\-readable output (list or showall modes). .TP \fB\-a\fR, \fB\-\-alias\fR -Use the alias table. +Use the alias table. (default) .TP \fB\-A\fR, \fB\-\-noalias\fR Don't use the alias table. .TP \fB\-i\fR, \fB\-\-interact\fR -Use interactive menus. +Use interactive menus. (default) .TP \fB\-I\fR, \fB\-\-nointeract\fR Use plain lists, no interaction required. .TP -\fB\-v\fR, \fB\-\-verbosity\fR=\fIN\fR -Set verbosity level to N. +\fB\-q\fR, \fB\-\-quiet\fR +Suppress warnings and most error messages. .TP -\fB\-d\fR, \fB\-\-debug\fR[=\fIlist\fR] -Activate debug for selected items (default all). +\fB\-v\fR, \fB\-\-verbose\fR +Print additional information (eg, viewer command). .TP -\fB\-M\fR, \fB\-\-machine\fR -Use a more machine\-friendly output format. +\fB\-d\fR, \fB\-\-debug\fR[=\fIlist\fR] +Print debug info for selected items (default: all). .SS "Environment:" .IP PAGER, BROWSER, PDFVIEWER, PSVIEWER, DVIVIEWER. .SS "Files:" .IP -<texmf>/texdoc/texdoc.cnf files, see the \fB\-f\fR option. +<texmf>/texdoc/texdoc.cnf, see output of the \fB\-\-files\fR option. .SS "Homepage:" .IP http://tug.org/texdoc/ diff --git a/Master/texmf/doc/man/man1/texdoc.man1.pdf b/Master/texmf/doc/man/man1/texdoc.man1.pdf Binary files differindex 072a6efaf1d..1e7e8adb0b9 100644 --- a/Master/texmf/doc/man/man1/texdoc.man1.pdf +++ b/Master/texmf/doc/man/man1/texdoc.man1.pdf diff --git a/Master/texmf/doc/texdoc/News b/Master/texmf/doc/texdoc/News index 4111da6b1ca..faca951b308 100644 --- a/Master/texmf/doc/texdoc/News +++ b/Master/texmf/doc/texdoc/News @@ -1,3 +1,17 @@ +Version 0.66 +------------ + +Turn the -v=N, --verbosity=N command-line option into a pair of related options +-v, --verbose and -q, --quiet (more standard, Karl's suggestion). Also remove +uselessly verbose debug items so --debug is usable again. + +Rework help text (Karl's suggestion). + +Issue a warning about DISPLAY not being set on generic Unix before trying to +start a viewer. + +Small internal clean-ups. + Version 0.65 ------------ @@ -27,7 +41,7 @@ Version 0.61 Detect desktop environments (KDE4, KDE, GNOME, XFCE) for viewer selection. Version 0.60 ------------- +============ Changed the search/alias/score logic. See section 2 of the manual for details, but here is a primer: @@ -36,10 +50,10 @@ but here is a primer: The beginning of the manual has been completely rewritten. -Bug have been fixed as usual, and probably some others introduced... +Bugs have been fixed as usual, and probably some others introduced... Version 0.50 ------------- +============ - New option for machine-readable output. - Bugfixes (esp. for zipped file support (Unix only)). @@ -102,7 +116,7 @@ Documentation update. Alias additions and fixes as usual. Various bugfixes. License switched to GPL. Version 0.4 (TeX Live 2008) ---------------------------- +=========================== Use our own configuration files, not texmf.cnf. Rework the way viewers are handled, and add a few configuration options. diff --git a/Master/texmf/doc/texdoc/texdoc.pdf b/Master/texmf/doc/texdoc/texdoc.pdf Binary files differindex 0fa9b3c942e..7eff49cd9a1 100644 --- a/Master/texmf/doc/texdoc/texdoc.pdf +++ b/Master/texmf/doc/texdoc/texdoc.pdf diff --git a/Master/texmf/doc/texdoc/texdoc.tex b/Master/texmf/doc/texdoc/texdoc.tex index 7cc3748fe7c..47d92faf292 100644 --- a/Master/texmf/doc/texdoc/texdoc.tex +++ b/Master/texmf/doc/texdoc/texdoc.tex @@ -163,7 +163,7 @@ \subtitle{Find \& view documentation in \TeX\ Live} \author{\url{http://tug.org/texdoc/}\\ Manuel Pégourié-Gonnard} -\date{v0.62 2010-01-05} +\date{v0.66 2010-02-22} \begin{document} \VerbatimFootnotes @@ -501,12 +501,17 @@ option is deprecated and will likely be removed soon. It is recommended to set ©ext_list© in a configuration file instead. Please protest on the \tdml if you want to keep this command-line option. -\begin{cmdsubsub}{-v, --verbosity}{cl-v} - -v=«n», --verbosity=«n» +\begin{cmdsubsub}{-q, --quiet}{cl-q} + -q, --quiet \end{cmdsubsub} -Set ©verbosity_level© to ©«n»©, see~\ref{cf-verbosity_level}. Be aware that you -must avoid spaces on the command line, and the ©=© sign is optional. +Set ©verbosity_level© to minimum, see~\ref{cf-verbosity_level}. + +\begin{cmdsubsub}{-v, --verbose}{cl-v} + -v, --verbose +\end{cmdsubsub} + +Set ©verbosity_level© to maximum, see~\ref{cf-verbosity_level}. \begin{cmdsubsub}{-d, --debug}{cl-d} -d, -d=«list», --debug, --debug=«list» @@ -661,17 +666,18 @@ shell construct. verbosity_level = «n» \end{cmdsubsub} -Set the verbosity level to ©«n»©. 3 means errors, warnings and informational -message will be printed (on stdout); 2 means only errors and warnings, 1 only -errors and 0 nothing (not recommended). +Set the verbosity level to ©«n»© (default: 2). 3 means errors, warnings and +informational messages will be printed (on stderr); 2 means only errors and +warnings, 1 only errors and 0 nothing except internal errors (obviously not +recommended). \begin{cmdsubsub}{debug_list}{cf-debug_list} debug_list = «list» \end{cmdsubsub} -Set the list of activated debug items (default: none). For a list of available -items, see the source code, file ©constants.tlu©, variable ©known_debugs©. -Debug information is printed on standard error. +Set the list of activated debug items (default: none; if the option is used +without arguments, the list defaults to all known debug items). Implies +©--verbose©. Debug information is printed on standard error. \begin{cmdsubsub}{machine_switch}{cf-machine_switch} machine_switch = «true, false» @@ -694,7 +700,7 @@ of the line, but the first 3 fields will remain unchanged. zipext_list = «list» \end{cmdsubsub} -List of supported extension for zipped files (default: empty). Allows +List of supported extensions for zipped files (default: empty). Allows compressed files with names like ©foobar.«zip»©, with ©«zip»© in the given ©«list»©, to be found and unzipped before the viewer is launched (the temporary file will be destroyed right after). |