diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoc.1 | 136 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoc.man1.pdf | bin | 6004 -> 23940 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoctk.1 | 217 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf | bin | 31500 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/COPYING | 674 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/NEWS (renamed from Master/texmf-dist/doc/texdoc/News) | 46 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/README.md | 104 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/texdoc.pdf | bin | 0 -> 83039 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/texdoc/texdoc.tex (renamed from Master/texmf-dist/doc/texdoc/texdoc.tex) | 408 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/texdoc/texdoc.pdf | bin | 110319 -> 0 bytes |
10 files changed, 1099 insertions, 486 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texdoc.1 b/Master/texmf-dist/doc/man/man1/texdoc.1 index bfaba2396af..943cf71478c 100644 --- a/Master/texmf-dist/doc/man/man1/texdoc.1 +++ b/Master/texmf-dist/doc/man/man1/texdoc.1 @@ -1,80 +1,120 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.9. -.TH TEXDOC "1" "June 2012" "texdoc 0.84" "User Commands" -.SH NAME -texdoc \- find & view documentation in TeX Live -.SH SYNOPSIS -.B texdoc -[\fIOPTION\fR]... \fINAME\fR... +.\" 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" +. +.SH "NAME" +\fBtexdoc\fR \- find & view documentation in TeX Live +. +.SH "SYNOPSIS" +\fBtexdoc\fR [OPTION\.\.\.] NAME\.\.\. +. .br -.B texdoc -\fIACTION\fR -.SH DESCRIPTION -Try to find appropriate TeX documentation for the specified NAME(s). -Alternatively, perform the given ACTION and exit. -.SS "Actions:" +\fBtexdoc\fR 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. +Print this help message\. +. .TP \fB\-V\fR, \fB\-\-version\fR -Print the version number. +Print the version number\. +. .TP \fB\-f\fR, \fB\-\-files\fR -Print the list of configuration files used. +Print the list of configuration files used\. +. .TP -\fB\-\-just\-view\fR file -Display file, given with full path (no searching). -.SH OPTIONS +\fB\-\-just\-view FILE\fR +Display file, given with full path (no searching)\. +. +.SH "OPTIONS" +. .TP \fB\-w\fR, \fB\-\-view\fR -Use view mode: start a viewer. (default) +Use view mode: start a viewer\. \fB(default)\fR +. .TP \fB\-m\fR, \fB\-\-mixed\fR -Use mixed mode (view or list). +Use mixed mode (view or list)\. +. .TP \fB\-l\fR, \fB\-\-list\fR -Use list mode: show a list of results. +Use list mode: show a list of results\. +. .TP \fB\-s\fR, \fB\-\-showall\fR -Use showall mode: show also "bad" results. +Use showall mode: show also "bad" results\. +. .TP \fB\-i\fR, \fB\-\-interact\fR -Use interactive menus. (default) +Use interactive menus\. \fB(default)\fR +. .TP \fB\-I\fR, \fB\-\-nointeract\fR -Use plain lists, no interaction required. +Use plain lists, no interaction required\. +. .TP \fB\-M\fR, \fB\-\-machine\fR -Machine\-readable output for lists (implies \fB\-I\fR). +Machine\-readable output for lists (implies \-I)\. +. .TP \fB\-q\fR, \fB\-\-quiet\fR -Suppress warnings and most error messages. +Suppress warnings and most error messages\. +. .TP \fB\-v\fR, \fB\-\-verbose\fR -Print additional information (eg, viewer command). +Print additional information (eg, viewer command)\. +. .TP -\fB\-d\fR, \fB\-\-debug\fR[=\fIlist\fR] -Activate debug output (restricted to list). -.SH ENVIRONMENT -.IP -PAGER, BROWSER, PDFVIEWER, PSVIEWER, DVIVIEWER. -.SH FILES -.IP -<texmf>/texdoc/texdoc.cnf, see output of the \fB\-\-files\fR option. +\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\. +. +.SH "ENVIRONMENT" +PAGER, BROWSER, PDFVIEWER, PSVIEWER, DVIVIEWER, and *_texdoc of each\. +. +.SH "FILES" +\fB<texmf>/texdoc/texdoc\.cnf\fR, see output of the \fB\-\-files\fR option\. +. .SH "REPORTING BUGS" -Report bugs to <texdoc@tug.org>. +Report bugs to \fItexdoc@tug\.org\fR\. +. +.br +Texdoc home page: \fIhttp://tug\.org/texdoc/\fR +. .br -Texdoc home page: <http://tug.org/texdoc/> +Source: \fIhttps://github\.com/TeX\-Live/texdoc\fR +. +.SH "COPYRIGHT" +Copyright 2018 Manuel Pe\'gourie\'\-Gonnard, Takuto Asakura, Karl Berry, and Norbert Preining\. +. .br -Source: <https://github.com/mpg/texdoc> -.SH COPYRIGHT -Copyright \(co 2008\-2011 Manuel P'egouri'e\-Gonnard. -License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. +License: GNU GPL version 3 or later \fIhttp://gnu\.org/licenses/gpl\.html\fR\. +. .br -This is free software: you are free to change and redistribute it. +This is free software: you are free to change and redistribute it\. +. .SH "SEE ALSO" -The full documentation is maintained as a PDF manual. The command -.IP -.B texdoc texdoc -.PP -should give you access to the complete manual. +The full documentation is maintained as a PDF manual\. The command +. +.IP "" 4 +. +.nf + +texdoc texdoc +. +.fi +. +.IP "" 0 +. +.P +should give you access to the complete manual\. diff --git a/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf Binary files differindex 33a05e4caa9..a1c601652fb 100644 --- a/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texdoctk.1 b/Master/texmf-dist/doc/man/man1/texdoctk.1 deleted file mode 100644 index e7aebb7098a..00000000000 --- a/Master/texmf-dist/doc/man/man1/texdoctk.1 +++ /dev/null @@ -1,217 +0,0 @@ -.TH TEXDOCTK 1 -.SH NAME -texdoctk \- GUI for easier access of TeX package and program documentations -.SH SYNOPSIS -.B texdoctk --[aq] -.SH "DESCRIPTION" -.B texdoctk -is a GUI for easier access to a large part of the vast amount -of package and program documentations and tutorials for TeX and its -different derivatives (mainly LaTeX). It is optimized and included in -the teTeX and fpTeX distributions and also available with TeXLive. -.PP -The documentation is grouped into 17 categories; the 18th button of the main -panel is inactive by default and intended for use with local additions (see -section -.B CONFIGURATION -below). -.PP -In the settings window you see a checkbox in the html->ps and text->ps -converter menus for switching on/off output redirect. This is due to the fact -that some converters do not write their output into a file but to stdout by -default, so a redirect is needed, e.g. -.PP -a2ps myfile.txt >myfile.ps -.SH "OPTIONS" -.TP -.I "\-v" -verbose: enable some viewer messages which are otherwise sent to stderr, -as well as some warning popup windows. This can also be set in a -configuration file. -.TP -.I "\-a" -autoview: autostart viewer if a listbox contains only one item (this will -frequently happen in search results). This can also be set in a configuration -file. -.SH "CONFIGURATION" -.PP -The configuration is controlled by the system default configuration file -($TEXMFMAIN)/texdoctk/texdocrc.defaults, most of whose entries can though be -overridden by the users' own optional ~/.texdocrc files and/or command line -options. -.SS The Settings menu and configuration files -.PP -The Settings menu is used to change the user-definable settings of \fBtexdoctk\fP -for the duration of the program call or as new defaults. The latter case is -the purpose of the Save button, which generates or rewrites the user's own -~/.texdocrc file. The system defaults cannot be edited with the Settings -menu. -.TP -Paths -The TEXMF-type paths on the system are reported, and the user can specify the -name of the subdirectory of $HOMETEXMF, where the personal documentation is -stored. -.TP -General viewer behaviour - -.I Suppress error messages -toggle verbose mode (see option -v); default is off. - -.I Autostart viewer for one-item listboxes -if a listbox contains only one item (see option -a) - -.I Use text viewer for unknown file format -i.e. treat the file as plain text. \fBtexdoctk\fP should recognize the usual file -formats and also relate names like README to plain text, but some docs may have -freely invented names. Default is on; if switched off, trying to view such -files will raise an error. The switch does not influence printing: unrecognized -formats cannot be printed. - -.I Change viewer colours -using either RGB triplets in the format #rrggbb or the standardized names. -.TP -DVI/PostScript/PDF/HTML/Plain text -For text files, \fBtexdoctk\fP provides an own viewer. If this viewer is disabled, -but no alternative viewer is specified, \fBtexdoctk\fP tries to read the content -of the environment variable $PAGER. - -If you want to print the documentations, you will need converters to turn -non-PS files into PostScript. Here are some suggestions: - -\& dvi->ps: -dvips (is part of teTeX) (http://www.radicaleye.com/dvips.html) - -\& pdf->ps: -pdf2ps (http://www.cs.wisc.edu/~ghost) or -Acrobat Reader (http://www.adobe.com) - -\& html->ps: html2ps (http://user.it.uu.se/~jan/html2ps.html) - -\& plain text->ps: a2ps (http://www-inf.enst.fr/~demaille/a2ps/) - -The html->ps and text->ps converter menus for switching on/off output redirect. -This is due to the fact that some converters do not write their output into a -file but to stdout by default, so a redirect is needed, e.g. -.B a2ps myfile.txt >myfile.ps -.PP -The system-wide configuration file is ($TEXMFMAIN)/texdoctk/texdocrc.defaults -and should only be writable by the administrator of the installation using any -text editor. The optional user configuration file is ~/.texdocrc and can -override all but those system settings which affect the installation as a -whole. The preferred way of changing it is through the Settings menu. -.SS The databases -\fBtexdoctk\fP comes with a default database file ($TEXMFMAIN)/texdoctk/texdoctk.dat -with a special format. It is divided into 17 sections corresponding to the -17 buttons that are active by default. Each section begins with a line - -@\fIsection_name\fP - -where -.I section_name -is the text as it appears in the button. This title is -followed by the descriptive entries for each documentation, which have this -format: - -\fIpackage-label\fP;Short description for listbox (opt. \fIpackage-name\fP);path in doc directory;optional keywords - -(without breaking the line!). Comments (initiated with a #) and empty lines -are ignored by the program. The second field is the text displayed in the -selection listboxes of \fBtexdoctk\fP, and you will usually want to mention the name -of the package in parens along with it; the first field is a \fBunique\fP label -for the package for internal use of the program which will usually be chosen -identical to the package name, but can be different if there is more than one -documentation file coming with a package. -.PP -The administrator will probably install additional packages in the local texmf -tree. The corresponding documentation can be made accessible by an additional -database $TEXMFLOCAL/texdoctk/texdoctk-local.dat. Furthermore, individual -users possibly install additional packages in an texmf subdirectory of their -$HOME, for which they can make an individual database themselves as -$TEXMFHOME/texdoctk/texdoctk-pers.dat. After creating such files, texhash -must be executed. -.PP -Both types of databases must have the same structure as the system database, -although they need (and should) not include all its sections if there are no -additional entries. For example, if the the package -.I foo -is added to the local tree such that its documentation file is -($TEXMFLOCAL)/doc/latex/foo/foo.dvi and it is decided that it fits best into -the existing category Graphics, texdoctk-local.dat would look like this: - -@Graphics -.br -foo;Create bells and whistles (foo);latex/foo/foo.dvi;decoration - -The entry for -.I foo -will then be appended to the list of entries in the Graphics category. The 18th -button can be activated in the same way, but using a new category name; -possible entries at the beginning of the database which have not been assigned -to a category will be assigned to the default Miscellaneous, making the 18th -button active with that label. Note that you cannot have more than 18 -categories; if there are more, only the one defined last will appear and be -used. -.PP -If the documentation is included in the .sty file instead of a proper -documentation file, the optional keywords should start with --?- directly after the semicolon, where ? is 0, 1, 2 or 3; these are flags -which indicate in which part of the .sty the instructions are placed and -should help \fBtexdoctk\fP to extract the documentation from the style and present -it without the code, which would normally be of little use. -.TP -0 -no specific place, scattered between the code -.TP -1 -at end, behind \\endinput; some .sty files have well-organized documentation -behind the end of the actual code, where TeX doesn't see it upon compilation -.TP -2 -at beginning, terminated by %%%%%%; in some other cases, some usage information -is at the beginning of the .sty as a comment terminated by a line full of % -.TP -3 -as 2, but with a blank line as termination -.PP -See the system database for plenty of examples. - -.SH "FILES" -.PP -\& $TEXMFMAIN/texdoctk/texdocrc.defaults -system-wide configuration file -.PP -\& ~/.texdocrc -(optional) personal configuration file; can also be created with the Settings menu -.PP -\& $TEXMFMAIN/texdoctk/texdoctk.dat -default database file for documentation files of the distribution -.PP -\& $TEXMFLOCAL/texdoctk/texdoctk-local.dat -(optional) local database file for documentation files -.PP -\& $TEXMFHOME/texdoctk/texdoctk-pers.dat -(optional) personal database file of individual users for documentation files -.SH BUGS -Widget placement in topic toplevels becomes ugly when the toplevel is stretched -or shrunk. -.PP -The font in the frame labels of the Settings menu are not forced to the default -font; this will become visible e.g. at hi-res screens, where the label font is -not scaled up. -.PP -Netscape and Mozilla error output will be written to stderr even if the quiet -mode was set. -.SH AUTHOR -.B texdoctk -was written by Thomas Ruedas <tr@geol.ku.dk>. -.PP -This manual page was originally written by Adrian Bunk <bunk@fs.tum.de> for -the Debian GNU/Linux system (but may be used by others). It is now maintained -by Thomas Ruedas. - -.SH COPYRIGHT -Copyright (C) 2000-2004 Thomas Ruedas -.br -This is free software; see the source for copying conditions. There is NO -warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. diff --git a/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf b/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf Binary files differdeleted file mode 100644 index 13c31ee0f21..00000000000 --- a/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/support/texdoc/COPYING b/Master/texmf-dist/doc/support/texdoc/COPYING new file mode 100644 index 00000000000..94a9ed024d3 --- /dev/null +++ b/Master/texmf-dist/doc/support/texdoc/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/Master/texmf-dist/doc/texdoc/News b/Master/texmf-dist/doc/support/texdoc/NEWS index 31e4f9cb3a2..27c1853677d 100644 --- a/Master/texmf-dist/doc/texdoc/News +++ b/Master/texmf-dist/doc/support/texdoc/NEWS @@ -1,11 +1,31 @@ -$Id: NEWS 14 2017-05-19 21:22:31Z karl $ +NEWS for texdoc +=============== (This file public domain.) +Version 3.0 (TeX Live 2018) +=========================== +This version has two big features: +- Fuzzy search +- New option parser + +And also includes a lot of small improvements: +- Get rid of Data.tlpdb.lua +- Documentation update +- Bug fix around environment variables +- Other small improvements including score adjustments +- Sources moved to https://github.com/TeX-Live/texdoc + +Version 2.0171 +-------------- +- In list mode (-l), just RET views first document in list. +- --help and --version override other specified command-line actions. + Version 2.017 (TeX Live 2017) ============================ - Restore user's LC_CTYPE value if possible (with this year's luatex). - Generic system environment variables, such as BROWSER, accept a colon-separated list of programs. +- Sources moved to https://puszcza.gnu.org.ua/projects/texdoc. Version 0.85 ------------ @@ -30,7 +50,6 @@ ship gnome-open by default any more. Version 0.81 (TeX Live 2011) ============================ - Allow configuration files to be found in all TEXMF trees. The default one should now be installed in TEXMFDIST (in upstream TeX Live) or in a tree search after TEXMFLOCAL (in downstream distros). @@ -47,7 +66,6 @@ Various internal cleanups and rearrangements. Version 0.80 ============ - New 'lang' configuration option (defaults on system locale): now <name>-de.pdf wins over <name>.pdf if German is preferred. Patch kindly provided by Philipp Stephani. Also works with aliases (eg koma-de = scrguide wins over koma = @@ -60,7 +78,6 @@ viewers. Version 0.72 as in TeX Live 2010 -------------------------------- - New (undocumented) settings (bad)basenme_list, parallel to (bad)ext_list. New (undocumented) setting item suffix_list for known documentation suffixes, @@ -70,19 +87,16 @@ New (undocumented) option --just-view for use by front-end programs. Version 0.72 ------------ - Fix stupid bug introduced in 0.70: texdoc would crash if called without arguments. (Reported by Maxime Chupin.) Version 0.71 ------------ - Fix bug introduced in 0.70: some results were duplicated on windows. (Reported by Uwe Siart.) Version 0.70 ============ - Use information from the TeX Live package database (some of it coming from the CTAN catalogue) to improve search results. Display some of this information. @@ -94,7 +108,6 @@ Deprecate -a, --alias, -A, --noalias and alias_switch. 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. @@ -108,35 +121,29 @@ Small internal clean-ups. Version 0.65 ------------ - Make it easier to change the list of configuration files used (eg for downstream distributions). Version 0.64 ------------ - Fix a crash when DISPLAY is unset on Unix by querying xprop more carefully. (Bug introduced in 0.61.) Version 0.63 ------------ - Fix a bug on windows which prevented from viewing sty files. Version 0.62 ------------ - Support for zipped documentation is now an official option. Please read the warnings before using it! 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: - alias now /adds/ patterns to be search, it is no more a substitution @@ -148,20 +155,17 @@ 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)). - Hopefully more sensible default viewer selection. Version 0.49 ------------ - Major code rewrite. No big user-visible change, except a few bugs fixed and new debugging levels. Version 0.47 (TeX Live 2009) ---------------------------- - Adapt for man pages named *.man1.pdf instead of *.pdf. (Temporary hack, done better since version 0.60.) @@ -169,25 +173,21 @@ Warning: zip support probably broken! Version 0.46 ------------ - Avoid using lfs.currentdir() and lfs.chdir() which are broken on Solaris 10 in LuaTeX 0.40 Version 0.45 ------------ - Fix possible line ending problems on windows with certain versions of LuaTeX Version 0.44 ------------ - - fixing viewer problems on Windows - expanding the list of default viewers on generic Unix Version 0.43 ------------ - Improve support for zipped documentation and comments about it in the default configuration file. (Thank Norbert Preining for his help.) @@ -195,7 +195,6 @@ Various fixes, aliases updates as usual. Version 0.42 ------------ - Improvements to default txt viewer on Windows (thanks to Phil Taylor). New debugging levels; new names for debugging options. @@ -211,7 +210,6 @@ 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. @@ -224,7 +222,6 @@ Development passed from Frank Küster to Manuel Pégourié-Gonnard. Version 0.3 ----------- - Various changes including: - added changelog - better OS detection for default viewer settings @@ -233,7 +230,6 @@ Various changes including: Version 0.2 ----------- - Various changes including: - implemented reading of configuration from texmf.cnf - fixed "-s" option diff --git a/Master/texmf-dist/doc/support/texdoc/README.md b/Master/texmf-dist/doc/support/texdoc/README.md new file mode 100644 index 00000000000..19b0208825a --- /dev/null +++ b/Master/texmf-dist/doc/support/texdoc/README.md @@ -0,0 +1,104 @@ +# Texdoc (v3.0) + +[](https://travis-ci.org/TeX-Live/texdoc) + +Texdoc is a command line program to find and view documentation in TeX Live. + +## General Information + +* Website: <https://www.tug.org/texdoc/> +* Repository: <https://github.com/TeX-Live/texdoc/> +* Mailing list: <texdoc@tug.org> + +## Using Texdoc + +Texdoc is part of the TeX Live distribution. Generally, you don't have to install it yourself. + +If you want to try/test the develop version, please see below. + +## How to Install the Develop Version + +### Using Bundler + +The easiest way to install the develop version of Texdoc is using [Bundler](https://bundler.io/) and [Rake](https://github.com/ruby/rake): + +``` +$ bundle install +$ rake install +``` + +If you want to uninstall the develop version (to use the TeX Live version), just try: + +``` +$ rake uninstall +``` + +### Installing manually + +Here, `$TEXDOC` means the path to the texdoc dev sources you cloned (or downloaded), and `$TEXMFHOME` denotes your personal TEXMF tree (you can get its location with `kpsewhich --var-value TEXMFHOME`). + +* **The command.** Symlink or copy `$TEXDOC/script` as `$TEXMFHOME/scripts/texdoc`. +* **The configuration file.** Symlink or copy `$TEXDOC/texdoc.cnf` as `$TEXMFHOME/texdoc/texdoc-dist.cnf` (notice the `-dist` part). It will completely override the other configuration files except `$TEXMFHOME/texdoc/texdoc.cnf` which you can still use for you personal settings. + +You can make sure that the right files are used by running `texdoc --files`: the first line contains the full path to the version of used `texdoclib.tlu`, and the rest lists the configuration files in use. + +## Files in This Repository + +- `doc/` contains the documentation, +- `script/` contains the source code, +- `spec/` is a directory for testing scripts, and +- `texdoc.cnf` is the default configuration file. + +## Building and Testing + +Many building tasks are defined as [Rake](https://github.com/ruby/rake) tasks: + +### Generating all documentation + +This will generate both the PDF and the manpage in `doc/` directory. + +``` +$ rake doc +``` + +### Generating a pre-hashed cache file + +This will generate a pre-hashed cache file `script/Data.tlpdb.lua`. This task have to be done under a TeX Live setup with tlpdb. + +``` +$ rake gen_datafile +``` + +### Running all tests + +This will run all tests in `spec/` directory. + +``` +$ rake test +``` + +### Showing all available tasks + +This will show all available tasks with a short discription. + +``` +$ rake -T +``` + +## Further Information + +More specific information (e.g. TODO) can be found in the Wiki of our GitHub repository. Please visit: + +* <https://github.com/TeX-Live/texdoc/wiki> + +## Copyright and License + +Copyright 2008-2018 Manuel Pégourié-Gonnard, Takuto Asakura, Karl Berry, and Norbert Preining. All rights reserved. + +This package is distributed under the terms of the GNU General Public License as published by the Free Software Foundation, either [version 3](./COPYING) of the License, or (at your option) any later version. + +Previous work (texdoc program) in the public domain: + +* Contributions from Reinhard Kotucha (2008). +* First texlua versions by Frank Küster (2007). +* Original shell script by Thomas Esser, David Aspinall, and Simon Wilkinson. diff --git a/Master/texmf-dist/doc/support/texdoc/texdoc.pdf b/Master/texmf-dist/doc/support/texdoc/texdoc.pdf Binary files differnew file mode 100644 index 00000000000..1606e91d33b --- /dev/null +++ b/Master/texmf-dist/doc/support/texdoc/texdoc.pdf diff --git a/Master/texmf-dist/doc/texdoc/texdoc.tex b/Master/texmf-dist/doc/support/texdoc/texdoc.tex index 817489f697b..a300236ae67 100644 --- a/Master/texmf-dist/doc/texdoc/texdoc.tex +++ b/Master/texmf-dist/doc/support/texdoc/texdoc.tex @@ -1,5 +1,5 @@ -% this is texdoc's user manual -% written by Manuel Pégourié-Gonnard in 2008, 2010 +% Texdoc user manual +% Copyright 2018 Manuel Pégourié-Gonnard and Takuto Asakura % distributed under the terms of GPL v3 or later %!TEX encoding=utf-8 @@ -12,9 +12,9 @@ \usepackage{xunicode} \defaultfontfeatures{Ligatures=TeX} -\setmainfont{DejaVu Serif} -\setsansfont{DejaVu Sans} -\setmonofont{DejaVu Sans Mono} +\setmainfont{DejaVuSerif} +\setsansfont{DejaVuSans} +\setmonofont{DejaVuSansMono} \renewcommand\familydefault{\sfdefault} \normalfont \newcommand\mylangle{$\langle$} \newcommand\myrangle{$\rangle$} @@ -37,24 +37,15 @@ \usepackage{bookmark} \hypersetup{% bookmarksnumbered=true, bookmarksopen=true, bookmarksopenlevel=2, - pdftitle=texdoc: find and view documentation in TeX Live, - pdfauthor=Manuel Pégourié-Gonnard, - pdfsubject=texdoc's user manual, - pdfkeywords={texdoc, TeX Live, manual}} - -\newcommand\CTAN[1]{% - \href{http://mirror.ctan.org/tex-archive/#1}{CTAN:#1}} -\newcommand\mailto[1]{% - \href{mailto:#1}{#1}} -\newcommand\package[1]{% - \href{http://ctan.org/pkg/#1}{#1}} -\newcommand\http[1]{% - \href{http://#1}{#1}} - -\newcommand\texlive{% - \TeX\thinspace Live\xspace} -\newcommand\tex{\TeX\xspace} -\newcommand\latex{\LaTeX\xspace} + pdftitle={Texdoc: find and view documentation in TeX Live}, + pdfauthor={Manuel Pégourié-Gonnard, Takuto Asakura}, + pdfsubject={Texdoc's user manual}, + pdfkeywords={Texdoc, TeX Live, manual, documentation}} + +\usepackage[yyyymmdd]{datetime} +\renewcommand{\dateseparator}{-} + +\newcommand\texlive{\TeX~Live\xspace} \setlength\parindent{\baselineskip} @@ -65,9 +56,9 @@ \definecolor{code}{rgb}{0,0,0.6} \hypersetup{colorlinks=true, linkcolor=links, urlcolor=links, citecolor=links} -\newcommand\cofont{% % code +\newcommand\cofont{% code \color{code}\normalfont\ttfamily} -\newcommand\meta[1]{% % meta elements +\newcommand\meta[1]{% meta elements {\normalfont\color{special}\mylangle\textit{#1}\myrangle}} % take care of non-breakable spaces @@ -136,37 +127,40 @@ \BUseVerbatim{verbmat}% \par\medskip\@endpetrue} \makeatother -\DefineShortVerb{\©} +\DefineShortVerb{\|} \setkomafont{title}{} \setkomafont{subtitle}{\Large} \deffootnote[1.5em]{1.5em}{1em}{\textsuperscript{\thefootnotemark}\thinspace} -\newcommand\tdml{\href{mailto:texdoc@tug.org}{texdoc mailing list}\xspace} +\newcommand\tdml{\href{http://lists.tug.org/texdoc}{texdoc mailing list}\xspace} \title{Texdoc} \subtitle{Find \& view documentation in \texlive\\ - \href{http://tug.org/texdoc/}{http://tug.org/texdoc/}\\ - \mailto{texdoc@tug.org}} -\author{Manuel Pégourié-Gonnard\\ - v0.84 2012-06-01} -\date{} + \href{https://tug.org/texdoc/}{https://tug.org/texdoc/}} +\author{Manuel Pégourié-Gonnard\and Takuto Asakura} +\date{v3.0 \today} \begin{document} \VerbatimFootnotes \maketitle -\section{Quick guide (2 pages only)} +\section{Quick guide} \subsection{Basics} -Open a command line\footnote{On Windows, press Win-R and type ©cmd©. On Mac - OS X, use the ``terminal'' application. If you are using another flavour of - Unix, you probably know what to do.} and type ©texdoc «name»©: the -documentation of the ©«name»© package will pop up. Of course, replace ©«name»© -with the actual name of the package. To look up the documentation of more -than one package at once, just use many ©«name»©s as arguments. +Texdoc is a command line tool which search and view documentations in \texlive. +If you type +% +\begin{quote} +|texdoc «name»| +\end{quote} +% +in your command line, the documentation of the |«name»| package will pop up. Of +course, replace |«name»| with the actual name of the package. To look up the +documentation of more than one package at once, just use multiple |«name»|s as +arguments. \subsection{Modes}\label{ss-modes} @@ -174,64 +168,64 @@ Texdoc has different modes that determine how results will be handled. In the default, ``view'' mode, it opens the first (supposedly the best) result in a viewer. It is rather handy when you know what you want to read, and want to access it quickly. On the other hand, there may be other relevant documents -for the given ©«name»©, which are ignored in view mode. +for the given |«name»|, which are ignored in view mode. -The so-called ``list mode'' makes texdoc list all relevant documentation and +The so-called ``list mode'' makes Texdoc list all relevant documentation and ask you which one you want to view. It is useful when there a other interesting sources of information besides the package's main documentation. There is also a ``mixed'' mode, intended to combine the best of view mode and -list mode: if there is only one relevant result, then texdoc opens it in a +list mode: if there is only one relevant result, then Texdoc opens it in a viewer, else it offers you a menu. -By default, texdoc hides the results it considers less relevant (unless it +By default, Texdoc hides the results it considers less relevant (unless it finds no relevant result at all). In ``showall'' mode, it always shows all results. -To select the mode on the command-line, use ©texdoc «option» «name»© with one -of the following options: ©-w© or ©--view© for view mode, ©-m© or ©--mixed© -for mixed mode, ©-l© or ©--list© for list mode, ©-s© or ©--showall© for +To select the mode on the command-line, use |texdoc «option» «name»| with one +of the following options: |-w| or |--view| for view mode, |-m| or |--mixed| +for mixed mode, |-l| or |--list| for list mode, |-s| or |--showall| for showall mode. If you always (or mostly) use the same mode, you don't want to keep typing the -same option. The next section describes how to customize texdoc using +same option. The next section describes how to customize Texdoc using configurations files. \subsection{Configuration files}\label{ss-quick-file} -Use ©texdoc --files© to know where to put your personal configuration file; +Use |texdoc --files| to know where to put your personal configuration file; you'll need to create this file (an possibly some directories) the first time. (If you want to know the full list of possible configuration files, see~\ref{ss-prec}.) -In order to select you favorite mode, just insert a line ©mode = «yourmode»© -in this file, where ©«yourmode»© is one of ©view©, ©mixed©, ©list© or -©showall©. To set your favorite language, use ©lang = «2-letter code»©, though +In order to select you favorite mode, just insert a line |mode = «yourmode»| +in this file, where |«yourmode»| is one of |view|, |mixed|, |list| or +|showall|. To set your favorite language, use |lang = «2-letter code»|, though it is usually detected automatically. -The configuration file can be used to tweak texdoc in many ways, the most +The configuration file can be used to tweak Texdoc in many ways, the most useful of which is probably the selection of the viewers for various types of documents, explained in the next section. \subsection{Viewers}\label{ss-viewer} Texdoc's mechanism for choosing a viewer varies according to your platform. -On Windows, OS X, or Unix with KDE, Gnome or XFCE, it uses your file +On Windows, macOS, or Unix with KDE, Gnome or XFCE, it uses your file associations like when you double-click files in the Explorer, the Finder or your default file manager (except for the text viewer, which is always a pager). Otherwise, it tries to find a viewer in the path from a list of ``known'' viewers. You may want to select a different viewer for some kind of file. This is -achieved by setting the various ©viewer_«ext»© configuration options, where -©«ext»© is the extension corresponding to the file type. For example, if you +achieved by setting the various |viewer_«ext»| configuration options, where +|«ext»| is the extension corresponding to the file type. For example, if you want to set xpdf as your default PDF viewer, and run it in the background, -insert the line ©viewer_pdf = xpdf %s &© in your configuration file. Here, -©%s© stands for the name of the file to view. +insert the line |viewer_pdf = xpdf %s &| in your configuration file. Here, +|%s| stands for the name of the file to view. \subsection{You can stop reading now} -The next part explains texdoc mechanisms for finding the best results and how +The next part explains Texdoc mechanisms for finding the best results and how to cutomize them. The default configuration file tries hard to set appropriate values so that you normally don't need to fiddle with that, but you may be curious or have special needs. @@ -243,30 +237,32 @@ present and next part. \section{File search, aliases, score} -\subsection{An overview of how texdoc works} +\subsection{An overview of how Texdoc works} -When you type ©texdoc «keyword»©, texdoc first makes a list of files, from two +When you type |texdoc «keyword»|, Texdoc first makes a list of files, from two sources: \begin{enumerate} \item In the trees containing documentation (given by the - \href{http://www.tug.org/kpathsea/} {kpathsea} variable ©TEXDOCS©), it - selects all files containing ©«keyword»© in their name (including the + \href{https://www.tug.org/kpathsea/} {kpathsea} variable |TEXDOCS|), it + selects all files containing |«keyword»| in their name (including the directory name); \item In the \texlive Database, it looks for packages named - ©«keyword»© or containing a file ©«keyword».«ext»© where ©«ext»© may me - ©sty© or ©cls©, and selects all the documentation files from this package. + |«keyword»| or containing a file |«keyword».«ext»| where |«ext»| may me + |sty| or |cls|, and selects all the documentation files from this package. \end{enumerate} Files are filtered by extension: only files with known extensions may be -selected. +selected. In case Texdoc cannot find any documentation here, fuzzy search will +find the closest package name to the |«keyword»| and reselect the files (see +\ref{ss-fuzzy}). The selected files are then score according to some simple heuristics. For -example, a file named ©«keyword».pdf©, is good, ©«keyword»-«lang».pdf© will -score higher if your favorite language ©«lang»© is detected or configured, -©«keyword»-doc© will be preferred over ©«keyword»whatever©, files in a -directory named exactly ©«keyword»© get a bonus, etc. +example, a file named |«keyword».pdf|, is good, |«keyword»-«lang».pdf| will +score higher if your favorite language |«lang»| is detected or configured, +|«keyword»-doc| will be preferred over |«keyword»whatever|, files in a +directory named exactly |«keyword»| get a bonus, etc. Score may also be adjusted base on file extensions or known names (or -subwords): for example, by default, ©Makefile©s get a very bad score since +subwords): for example, by default, |Makefile|s get a very bad score since they are almost never documentation.\footnote{They often end up in the doc tree, since the source of documentation is often in the same directory as the documentation itself in \texlive. Other source files are discriminated @@ -280,17 +276,17 @@ score are displayed, except in showall mode. Results with very bad scores \medskip This model for searching and scoring is quite efficient, but is unfortunately -not perfect: texdoc may sometimes need a hint, either to find a relevant file +not perfect: Texdoc may sometimes need a hint, either to find a relevant file or, more likely, to recognize which of the files found is the most relevant. For example, assume you are looking for the documentation of the shortvrb -\latex package. Texdoc will find ©shortvrb.sty© in the ©latex© \texlive +{\LaTeX} package. Texdoc will find |shortvrb.sty| in the |latex| \texlive package, but since this package contains a lot of documentation files, none of -which contains the string ©shortverb©, it will sort them basically at random. +which contains the string |shortverb|, it will sort them basically at random. Here comes the notion of \emph{alias}: in the default configuration file, -©shortvrb© is aliased to ©base/doc©, so that when you type ©texdoc shortvrb©, -texdoc knows it has to look primarily for ©base/doc©. Note that texdoc will +|shortvrb| is aliased to |base/doc|, so that when you type |texdoc shortvrb|, +Texdoc knows it has to look primarily for |base/doc|. Note that Texdoc will also look for the original name, and that a name can be aliased to more than one new name. @@ -316,16 +312,16 @@ case-insensitive): alias(«score») «original keyword» = «name» \end{htcode} -You can define your own aliases in texdoc's configuration files +You can define your own aliases in Texdoc's configuration files (see~\ref{ss-quick-file} or \ref{ss-prec}). For example, insert\footnote{Actually, you don't need to do this, the default configuration file already includes this directive.} \begin{htcode} alias shortvrb = base/doc \end{htcode} -in order to alias ©shortvrb© to ©base/doc©. Precisely, it means that files in -the doc trees matching exactly ©base/doc© will be added to the result list -when you look for ©shortvrb©, and get a score of 10 (default score for alias +in order to alias |shortvrb| to |base/doc|. Precisely, it means that files in +the doc trees matching exactly |base/doc| will be added to the result list +when you look for |shortvrb|, and get a score of 10 (default score for alias results). This is greater than the results of heuristic scoring: it means that results found via aliases will always rank before results associated to the original keyword. @@ -335,19 +331,19 @@ score instead of the default 10, you can use the optional argument to the alias directive. This can be useful if you associate many aliases to a keyword and want one of them to show up first. -Additionally, starting from with v0.80, aliases for ©«keyword»-«lang»©, where -©«lang»© is your preferred language's 2-letter code (as detected or -configured, see the ©lang© option) are also used for ©«keyword»© and get a -©+1© score upgrade. +Additionally, starting from with v0.80, aliases for |«keyword»-«lang»|, where +|«lang»| is your preferred language's 2-letter code (as detected or +configured, see the |lang| option) are also used for |«keyword»| and get a +|+1| score upgrade. You can have a look at the configuration file provided (the last shown by -©texdoc -f©) for examples. If you feel one of the aliases you defined locally +|texdoc -f|) for examples. If you feel one of the aliases you defined locally should be added to the default configuration, please share it on the \tdml. Aliases are additive: if you define your own aliases for a keyword in your configuration file, and there are also aliases for the same keyword in the default configuration, they will add up. To prevent the default aliases -from begin applied for a particular keyword, include ©stopalias «keyword»© in +from begin applied for a particular keyword, include |stopalias «keyword»| in your personal configuration file. It will preserve the aliases defined before this directive (if any) but prevent all further aliasing on this keyword. @@ -355,7 +351,7 @@ this directive (if any) but prevent all further aliasing on this keyword. only aliases associated to the original keyword are used. \textbf{Warning.} Results found from aliases always have the score defined by -the ©alias© directive (10 by default), regardless of the adjustments described +the |alias| directive (10 by default), regardless of the adjustments described in the next subsections. \subsection{Score directives}\label{ss-score} @@ -368,7 +364,7 @@ in the next subsections. It is possible to adjust the score of results containing some pattern as a subword, either globally (for the result of all searches) or only when searching with a particular keyword. This is done in a configuration file -(\ref{ss-quick-file} or \ref{ss-prec}) using the ©adjustscore© directive. Here +(\ref{ss-quick-file} or \ref{ss-prec}) using the |adjustscore| directive. Here are a few examples from the default configuration file. \begin{htcode} @@ -377,60 +373,70 @@ are a few examples from the default configuration file. adjscore(tex) texdoc = -10 \end{htcode} -All files named ©Makefile© (and also files named ©Makefile-foo© if there are +All files named |Makefile| (and also files named |Makefile-foo| if there are any) are ``killed'' : by adjusting their score with such a large negative value, their final score will most probably be less than -100, so they will -never be displayed. Files from the ©tex-virtual-academy-pl© directory, on the +never be displayed. Files from the |tex-virtual-academy-pl| directory, on the other hand, are not killed but just get a malus, since they are a common source of ``fake'' matches which hide better results (even for the lucky ones who can read polish). -The third directive gives a malus for results containing ©texdoc© only if the -search keyword is ©tex©. Otherwise, such results would get a high score -because the heuristic scoring would think ©texdoc© is the name of \tex's +The third directive gives a malus for results containing |texdoc| only if the +search keyword is |tex|. Otherwise, such results would get a high score +because the heuristic scoring would think |texdoc| is the name of \TeX's documentation. The value -10 is enough to ensure that those results will have a negative score, so wil not be displayed unless ``showall'' mode is active. \textbf{Warning}: Values of scores (like the default score for aliases, the -range of heuristic scoring, etc.) may change in a future version of texdoc. +range of heuristic scoring, etc.) may change in a future version of Texdoc. So, don't be surprised if you need to adapt your scoring directives after a -future update of texdoc. This warning will hopefully disappear at some point. +future update of Texdoc. This warning will hopefully disappear at some point. \subsection{File extensions and names}\label{ss-ext} -The allowed file extensions are defined by the configuration item ©ext_list© +The allowed file extensions are defined by the configuration item |ext_list| (default: pdf, html, htm, txt, ps, dvi, no extension). You can configure it -with a line ©ext_list = «your, list»© in a configuration file. Be aware +with a line |ext_list = «your, list»| in a configuration file. Be aware that it will completely override the default list, not add to it. An empty string in the list means files without extension (no dot in the name), while a star means any extension. -For scoring purposes, there is also a ©badext_list© parameter: files whose +For scoring purposes, there is also a |badext_list| parameter: files whose extension is ``bad'' according to this list will get a lesser score (currently 0). Unfortunately, sometimes what follows a dot in a file name is not a ``real'' -extension. This often happens with readme files, for example ©readme.fr© or -©readme.texlive©. So, in addition to his list of known extensions, texdoc has -a list of known basenames, by default just ©readme©. +extension. This often happens with readme files, for example |readme.fr| or +|readme.texlive|. So, in addition to his list of known extensions, Texdoc has +a list of known basenames, by default just |readme|. -The corresponding settings are ©basename_list© and ©badbasename_list©; both -are similar to ©ext_list© and ©badext_list©. So, a file will be selected if +The corresponding settings are |basename_list| and |badbasename_list|; both +are similar to |ext_list| and |badext_list|. So, a file will be selected if either its extension or its base name is known, and get a lesser score if either is known to be ``bad.'' \subsection{Variants}\label{ss-variants} The documentation for a given package is often found in a file named like -©«package»-doc©. To handle this properlr, texdoc gives a special score files -named ©«package»«suffix»© where ©«suffix»© is one element of the list given by -the configuration setting ©suffix_list©. +|«package»-doc|. To handle this properlr, Texdoc gives a special score files +named |«package»«suffix»| where |«suffix»| is one element of the list given by +the configuration setting |suffix_list|. -To customise this list, add a line with ©suffix_list = «your, list»© in a +To customise this list, add a line with |suffix_list = «your, list»| in a configuration files. Be warned, it will replace the default list, no expand it. You'll find the default list in the shipped configuration file; feel free to suggest additions on the \tdml (with a real-life example). +\subsection{Fuzzy search}\label{ss-fuzzy} + +When the normal search can't find any document in \texlive, Texdoc will execute +fuzzy search without user-interactions. The results of fuzzy search are shown +by as an informational message. (you can see that with option |-v|) + +The default allowance of Levenshtein distance is 5. You can change this +default value by specifying |fuzzy_level| in your |texdoc.cnf| (see +\ref{cf-fuzzy_level}). + \clearpage \section{Full reference} @@ -441,28 +447,28 @@ Values for a particular setting can come from several sources. The sources are treated in the following order and the first value found is always used: \begin{enumerate} \item Command-line options. - \item Environment variables ending with ©_texdoc©. + \item Environment variables ending with |_texdoc|. \item Other environment variables. \item Values from configuration files (see below). \item Hard-coded defaults that may depend on the current machine. \end{enumerate} -The configuration files are found in the directories ©TEXMF/texdoc©, where -©TEXMF© is the kpathsea variable, in the order given by this variable. Inside +The configuration files are found in the directories |TEXMF/texdoc|, where +|TEXMF| is the kpathsea variable, in the order given by this variable. Inside each directory, three files are recognized, in this order: \begin{enumerate} - \item ©texdoc-«platform».cnf© where ©«platform»© is the name of the current + \item |texdoc-«platform».cnf| where |«platform»| is the name of the current platform (defined as the name of the directories where the \texlive - binaries are located, for example ©x86-64-linux©). This may be useful when + binaries are located, for example |x86-64-linux|). This may be useful when an installation is shared across machines with different architectures needing different settings, for example for viewers. Their use is not recommended in any other situation. - \item ©texdoc.cnf© is the recommended file for normal use. - \item ©texdoc-dist.cnf© is useful for installing a newer version of texdoc + \item |texdoc.cnf| is the recommended file for normal use. + \item |texdoc-dist.cnf| is useful for installing a newer version of texdoc (including its default configuration file) in your home while retaining - the use of the previous file for your personal setting; see - \href{http://tug.org/texdoc/dev/}{the web page} for instructions on - running the development version. + the use of the previous file for your personal setting; see + \href{https://github.com/TeX-Live/texdoc}{our GitHub repository} for + instructions on running the development version. \end{enumerate} \subsection{Command-line options}\label{ss-cl} @@ -500,73 +506,75 @@ platform, with their status (active, not found, or disabled Open «file» in the usual viewer. The file should be given with full path, absolutely no searching is done. This option is not really meant for users, but rather intended to be used from another program, like a GUI front-end to -texdoc. +Texdoc. \begin{cmdsubsub}{-w, -l, -m, -s, --view, --list, --mixed, --showall}{cl-mode} -w, --view, -l, --list, -m, --mixed, -s, --showall \end{cmdsubsub} -Set ©mode© to the given value, see~\ref{cf-mode}. +Set |mode| to the given value, see~\ref{cf-mode}. \begin{cmdsubsub}{-i, -I, --interact, --nointeract}{cl-i} -i, --interact, -I, --nointeract \end{cmdsubsub} -Set ©interact_switch© to true (resp. false), see~\ref{cf-interact_switch}. +Set |interact_switch| to true (resp. false), see~\ref{cf-interact_switch}. \begin{cmdsubsub}{-M, --machine}{cl-M} -M, --machine \end{cmdsubsub} -Set ©machine_switch© to true, see~\ref{cf-machine_switch}. +Set |machine_switch| to true, see~\ref{cf-machine_switch}. \begin{cmdsubsub}{-q, --quiet}{cl-q} -q, --quiet \end{cmdsubsub} -Set ©verbosity_level© to minimum, see~\ref{cf-verbosity_level}. +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}. +Set |verbosity_level| to maximum, see~\ref{cf-verbosity_level}. -\begin{cmdsubsub}{-d, --debug}{cl-d} - -d, -d=«list», --debug, --debug=«list» +\begin{cmdsubsub}{-d, -D, --debug}{cl-d} + -d «list», --debug=«list», -D, --debug \end{cmdsubsub} -Set ©debug_list©, see~\ref{cf-debug_list}. If no list is given, activates all -available debug items. +Set |debug_list|, see~\ref{cf-debug_list}. If you specify |-D| or |--debug| +without the list, activates all available debug items. \subsection{Environment variables}\label{ss-envvar} -They all correspond to some ©viewer_«ext»© setting, and the reader is referred -to~\ref{cf-viewer_*} for details. Also, environment variables used by older -versions of texdoc are accepted. You can append ©_texdoc© to every name in -the first column: this wins over every other name. +They all correspond to some |viewer_«ext»| setting, and the reader is referred +to~\ref{cf-viewer_*} for details.\footnote{Old names of environment variables, +namely |TEXDOCVIEW_{txt,html,dvi,ps,pdf}| and +|TEXDOC_VIEWER_{TXT,HTML,DVI,PS,PDF}|, are deprecated but still work.} You can +append |_texdoc| to every name in the first column: this wins over every other +name. \begin{center} - \begin{tabular}{*4l} - New name & Old name 1 & Old name 2 & Config. item \\ - ©PAGER© & ©TEXDOCVIEW_txt© & ©TEXDOC_VIEWER_TXT© & ©viewer_txt© \\ - ©BROWSER© & ©TEXDOCVIEW_html© & ©TEXDOC_VIEWER_HTML© & ©viewer_html© \\ - ©DVIVIEWER© & ©TEXDOCVIEW_dvi© & ©TEXDOC_VIEWER_DVI© & ©viewer_dvi© \\ - ©PSVIEWER© & ©TEXDOCVIEW_ps© & ©TEXDOC_VIEWER_PS© & ©viewer_ps© \\ - ©PDFVIEWER© & ©TEXDOCVIEW_pdf© & ©TEXDOC_VIEWER_PDF© & ©viewer_pdf© \\ - \end{tabular} +\begin{tabular}{ll} +Environment variables & Configuration items \\ +|PAGER| & |viewer_txt| \\ +|BROWSER| & |viewer_html| \\ +|DVIVIEWER| & |viewer_dvi| \\ +|PSVIEWER| & |viewer_ps| \\ +|PDFVIEWER| & |viewer_pdf| \\ +\end{tabular} \end{center} -Also, on Unix systems, locale-related variables such as ©LANG© and ©LC_ALL© -are used for the default value of ©lang©. +Also, on Unix systems, locale-related variables such as |LANG| and |LC_ALL| +are used for the default value of |lang|. \subsection{Configuration items}\label{ss-conf} \subsubsection{Structure of configuration files}\label{sss-sonf-struct} -Configuration files are line-oriented text files. Comments begin with a ©#© +Configuration files are line-oriented text files. Comments begin with a |#| and run to the end of line. Lines containing only space are ignored. Space at -the beginning or end of a line, as well as around an ©=© sign, is ignored. +the beginning or end of a line, as well as around an |=| sign, is ignored. Apart from comments and empty lines, each line must be of one of the following forms. @@ -579,30 +587,30 @@ forms. adjscore(«keyword») «pattern» = «score adjustment» \end{htcode} -We will concentrate on the ©«configuration item»© part here, since other +We will concentrate on the |«configuration item»| part here, since other directives have already been presented (\ref{ss-alias} and \ref{ss-score}). -In the above, ©«value»© never needs to be quoted: quotes would be interpreted +In the above, |«value»| never needs to be quoted: quotes would be interpreted as part of the value, not as quotation marks (this also holds for the other directives). Lines which do not obey these rules raise a warning, as well as unrecognised -values of ©«configuration item»©. The ©«value»© can be an arbitrary string, -except when the name of the ©«configuration item»© ends with: +values of |«configuration item»|. The |«value»| can be an arbitrary string, +except when the name of the |«configuration item»| ends with: \begin{enumerate} - \item ©_list©, then ©«value»© is a coma-separated list of strings. Space + \item |_list|, then |«value»| is a coma-separated list of strings. Space around commas is ignored. Two consecutive comas or a coma at the beginning or end of the list means the empty string at the corresponding place. - \item ©_switch©, then ©«value»© must be either ©true© or ©false© + \item |_switch|, then |«value»| must be either |true| or |false| (lowercase). - \item ©_level©, then ©«value»© is an integer. + \item |_level|, then |«value»| is an integer. \end{enumerate} -In these cases, an improper ©«value»© will raise a warning too. +In these cases, an improper |«value»| will raise a warning too. \begin{cmdsubsub}{mode}{cf-mode} mode = «view, list, mixed, showall» \end{cmdsubsub} -Set the mode to the given value. Default is ©view©. The various modes +Set the mode to the given value. Default is |view|. The various modes have been presented in~\ref{ss-modes}. \begin{cmdsubsub}{interact}{cf-interact_switch} @@ -610,21 +618,21 @@ have been presented in~\ref{ss-modes}. \end{cmdsubsub} Turn on or off interaction. Default is on. Turning interaction off prevents -texdoc from asking you to choose a file to view when there are multiple +Texdoc from asking you to choose a file to view when there are multiple choices, so it just prints the list of files found. \begin{cmdsubsub}{suffix_list}{cf-suffix_list} suffix_list = «list» \end{cmdsubsub} -Set the list of known suffixes to ©«list»© (see~\ref{ss-variants}). Default is +Set the list of known suffixes to |«list»| (see~\ref{ss-variants}). Default is the empty list, but see the shipped configuration file for more. \begin{cmdsubsub}{ext_list}{cf-ext_list} ext_list = «list» \end{cmdsubsub} -Set the list of recognised extensions to ©«list»©. Default is +Set the list of recognised extensions to |«list»|. Default is \begin{htcode} pdf, html, htm, txt, dvi, ps, \end{htcode} @@ -634,45 +642,45 @@ recognised: \begin{itemize} \item \emph{The empty element}. This means files without extensions, or more precisely without a dot in their name. This is meant for files like - ©README©, etc. The file is assumed to be plain text for viewing purpose. - \item ©*© means any extension. Of course if it is present in the list, it + |README|, etc. The file is assumed to be plain text for viewing purpose. + \item |*| means any extension. Of course if it is present in the list, it can be the only element! \end{itemize} -There is a very special case: if the searched ©«name»© has ©.sty© extension, -texdoc enters a special search mode for ©.sty© files (not located in the same -place as real documentation files) for this ©«name»©, independently of the -current value of ©ext_list© and ©mode©. In an ideal world, this wouldn't be +There is a very special case: if the searched |«name»| has |.sty| extension, +Texdoc enters a special search mode for |.sty| files (not located in the same +place as real documentation files) for this |«name»|, independently of the +current value of |ext_list| and |mode|. In an ideal world, this wouldn't be necessary since every sty file would have a proper documentation in pdf, html or plain text, but\dots -For each ©«ext»© in ©ext_list© there should be a corresponding ©viewer_«ext»© -value set. Defaults are defined corresponding to the default ©ext_list©, but -you can add values if you want. For example, if you want texdoc to be able -to find man pages and display them with the ©man© command, you can use +For each |«ext»| in |ext_list| there should be a corresponding |viewer_«ext»| +value set. Defaults are defined corresponding to the default |ext_list|, but +you can add values if you want. For example, if you want Texdoc to be able +to find man pages and display them with the |man| command, you can use \begin{htcode} ext_list = pdf, html, htm, 1, 5, txt, dvi, ps, viewer_1 = man viewer_5 = man \end{htcode} -As a special case, if the extension is ©sty©, then the ©txt© viewer is used; -similarly, if it is ©htm© the ©html© viewer is used. Otherwise, the ©txt© +As a special case, if the extension is |sty|, then the |txt| viewer is used; +similarly, if it is |htm| the |html| viewer is used. Otherwise, the |txt| viewer is used and a warning is issued. \begin{cmdsubsub}{badext_list}{cf-badext_list} badext_list = «list» \end{cmdsubsub} -Set the list of ``bad'' extensions to ©«list»©. Default is ``©txt,©''. Files -with those extensions get a malus of ©1© on their heurisitc score if it was +Set the list of ``bad'' extensions to |«list»|. Default is ``|txt,|''. Files +with those extensions get a malus of |1| on their heurisitc score if it was previously positive. \begin{cmdsubsub}{basename_list}{cf-basename_list} basename_list = «list» \end{cmdsubsub} -Set the list of ``known'' base names to ©«list»©. Default is ``©readme©''. +Set the list of ``known'' base names to |«list»|. Default is ``|readme|''. Files with those base names are selected regardless of their extension. If the extension is unknown, the text viewer will be used to view the file. @@ -680,17 +688,17 @@ extension is unknown, the text viewer will be used to view the file. badbasename_list = «list» \end{cmdsubsub} -Set the list of ``bad'' base names to ©«list»©. Default is ``©readme©''. Files -with those names get a malus of ©1© on their heurisitc score if it was +Set the list of ``bad'' base names to |«list»|. Default is ``|readme|''. Files +with those names get a malus of |1| on their heurisitc score if it was previously positive. \begin{cmdsubsub}{viewer_*}{cf-viewer_*} viewer_«ext» = «cmd» \end{cmdsubsub} -Set the viewer command for files with extension ©«ext»© to ©«cmd»©. For files -without extension, ©viewer_txt© is used, and there's no ©viewer_© variable. -In ©«cmd»©, ©%s© can be used as a placeholder for the file name, which is +Set the viewer command for files with extension |«ext»| to |«cmd»|. For files +without extension, |viewer_txt| is used, and there's no |viewer_| variable. +In |«cmd»|, |%s| can be used as a placeholder for the file name, which is otherwise inserted at the end of the command. The command can be a arbitrary shell construct. @@ -704,7 +712,7 @@ Set you preferred language. Defaults to your system's locale. verbosity_level = «n» \end{cmdsubsub} -Set the verbosity level to ©«n»© (default: 2). At level~3, errors, warnings and +Set the verbosity level to |«n»| (default: 2). At level~3, 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). @@ -715,7 +723,7 @@ recommended). Set the list of activated debug items (default: none; if the command-line option is used without arguments, the list defaults to all known debug items). -Implies ©--verbose©. Debug information is printed on standard error. +Implies |--verbose|. Debug information is printed on standard error. \begin{cmdsubsub}{max_line}{cf-max_lines} max_lines = «number» @@ -730,13 +738,13 @@ is disabled. \end{cmdsubsub} Turn on or off machine-readable output (default: off). With this option -active, the value of ©interact_switch© is forced to ©false©, and each line of +active, the value of |interact_switch| is forced to |false|, and each line of output is \begin{htcode} «argument»\t«score»\t«filename» \end{htcode} -where ©«argument»© is the name of the argument to which the results correspond -(mainly useful if there were many arguments), ©\t© is the tab (ascii 9) +where |«argument»| is the name of the argument to which the results correspond +(mainly useful if there were many arguments), |\t| is the tab (ascii 9) character, and the other entries are pretty self-explanatory. Nothing else is printed on stdout, except if a internal error occurs (in which case exit code will be 1). In the future, more tab-separated fields may be added at the end @@ -745,21 +753,21 @@ of the line, but the first 3 fields will remain unchanged. Currently, there are two additional fields: a two-letter language code, and an unstructured description, both taken from the CTAN catalogue (via the \texlive database). These fields may be empty and they are not guaranteed to keep the -same meaning in future versions of texdoc. +same meaning in future versions of Texdoc. \begin{cmdsubsub}{zipext_list}{cf-zipext_list} zipext_list = «list» \end{cmdsubsub} 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 started (the +compressed files with names like |foobar.«zip»|, with |«zip»| in the given +|«list»|, to be found and unzipped before the viewer is started (the temporary file will be destroyed right after). \textbf{Warning.} Support for zipped documentation is not meant to work on windows, a Unix shell is assumed! If you add anything to this list, please -make sure that you also set a corresponding ©unzip=«ext»© value for each -©«ext»© in the list. Also make sure you are using blocking (i.e. not returning +make sure that you also set a corresponding |unzip=«ext»| value for each +|«ext»| in the list. Also make sure you are using blocking (i.e. not returning immediately) viewers. \textit{Remark.} \texlive doesn't ship compressed documentation files, so @@ -770,9 +778,9 @@ for example in Linux distributions. unzip_«zipext» = «command» \end{cmdsubsub} -The unzipping command for compressed files with extension ©«zipext»© (default: -none). Define one for each item in ©zipext_list©. The command must print -the result on stdout, like ©gzip -d -c© does. +The unzipping command for compressed files with extension |«zipext»| (default: +none). Define one for each item in |zipext_list|. The command must print +the result on stdout, like |gzip -d -c| does. \begin{cmdsubsub}{rm_file, rm_dir}{cf-rm_star} rm_file = «command» @@ -780,17 +788,24 @@ the result on stdout, like ©gzip -d -c© does. \end{cmdsubsub} Commands for removing files (resp. directories) on your system (defaults: -©rm -f© and ©rmdir©). Only useful for zipped documents (see ©zipext_list©). +|rm -f| and |rmdir|). Only useful for zipped documents (see |zipext_list|). \begin{cmdsubsub}{lastfile_switch}{cf-lastfile_switch} lastfile_switch = «true, false» \end{cmdsubsub} -If set to true, prevents texdoc from reading any other configuration file -after this one (they will be reported as ``disabled'' by ©texdoc -f©). Mainly -useful for installing a newer version of texdoc in your home and preventing +If set to true, prevents Texdoc from reading any other configuration file +after this one (they will be reported as ``disabled'' by |texdoc -f|). Mainly +useful for installing a newer version of Texdoc in your home and preventing the default configuration file from older versions to be used (see the -\href{http://tug.org/texdoc/}{web site} for instructions on how to do so). +\href{https://tug.org/texdoc/}{web site} for instructions on how to do so). + +\begin{cmdsubsub}{fuzzy_level}{cf-fuzzy_level} + fuzzy_level = «n» +\end{cmdsubsub} + +Set the allowance of Levenshtein distance to |«n»| for the fuzzy search +(default: 5). At level 0, the fuzzy search feature is disabled. \subsection{Exit codes}\label{ss-exit} @@ -803,8 +818,8 @@ The current exit codes are: \section{Licence}\label{s-licence} -The current texdoc program and its documentation are copyright 2008, 2009 -Manuel Pégourié-Gonnard. +The current Texdoc program and its documentation are copyright 2008--2018 +Manuel Pégourié-Gonnard, Takuto Asakura, Karl Berry, and Norbert Preining. They are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software @@ -821,7 +836,7 @@ this program. If not, see \url{http://www.gnu.org/licenses/}. \bigskip -Previous work (texdoc program) in the public domain: +Previous work (Texdoc program) in the public domain: \begin{itemize} \item Contributions from Reinhard Kotucha (2008). \item First texlua versions by Frank Küster (2007). @@ -831,7 +846,8 @@ Previous work (texdoc program) in the public domain: \bigskip \begin{center}\Large\rmfamily\bfseries - Happy \tex{}ing! + Happy {\TeX}ing! \end{center} \end{document} +% vim: ambiwidth=single spell: diff --git a/Master/texmf-dist/doc/texdoc/texdoc.pdf b/Master/texmf-dist/doc/texdoc/texdoc.pdf Binary files differdeleted file mode 100644 index 9de6754f92c..00000000000 --- a/Master/texmf-dist/doc/texdoc/texdoc.pdf +++ /dev/null |