diff options
author | Karl Berry <karl@freefriends.org> | 2018-06-06 22:25:01 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-06-06 22:25:01 +0000 |
commit | 67a3b03c3f11c14b811b04447baf2b464e157e98 (patch) | |
tree | f5f8050ce90286fcd75ee2161c1dad78116bf50d /Master/texmf-dist/doc/man | |
parent | 0654b7aef1ec8948c0a7cc81fbaf9fc707782d44 (diff) |
texdoc 3.0 from CTAN
git-svn-id: svn://tug.org/texlive/trunk@47946 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man')
-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 |
4 files changed, 88 insertions, 265 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 |