{ "content": [ { "type": "text", "text": "# texdoctk(1) (man)\n\n**Summary:** texdoctk - GUI for easier access of TeX package and program documentations\n\n**Synopsis:** texdoctk -[aq]\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (2 lines)\n- **DESCRIPTION** (13 lines)\n- **OPTIONS** (6 lines)\n- **CONFIGURATION** (4 lines) — 2 subsections\n - The Settings menu and configuration files (50 lines)\n - The databases (61 lines)\n- **FILES** (14 lines)\n- **BUGS** (7 lines)\n- **AUTHOR** (6 lines)\n- **COPYRIGHT** (7 lines)\n\n## Full Content\n\n### NAME\n\ntexdoctk - GUI for easier access of TeX package and program documentations\n\n### SYNOPSIS\n\ntexdoctk -[aq]\n\n### DESCRIPTION\n\ntexdoctk is a GUI for easier access to a large part of the vast amount of package and program\ndocumentations and tutorials for TeX and its different derivatives (mainly LaTeX). It is op‐\ntimized and included in the teTeX and fpTeX distributions and also available with TeXLive.\n\nThe documentation is grouped into 17 categories; the 18th button of the main panel is inac‐\ntive by default and intended for use with local additions (see section CONFIGURATION below).\n\nIn the settings window you see a checkbox in the html->ps and text->ps converter menus for\nswitching on/off output redirect. This is due to the fact that some converters do not write\ntheir output into a file but to stdout by default, so a redirect is needed, e.g.\n\na2ps myfile.txt >myfile.ps\n\n### OPTIONS\n\n-v verbose: enable some viewer messages which are otherwise sent to stderr, as well as\nsome warning popup windows. This can also be set in a configuration file.\n\n-a autoview: autostart viewer if a listbox contains only one item (this will frequently\nhappen in search results). This can also be set in a configuration file.\n\n### CONFIGURATION\n\nThe configuration is controlled by the system default configuration file ($TEXMFMAIN)/tex‐\ndoctk/texdocrc.defaults, most of whose entries can though be overridden by the users' own op‐\ntional ~/.texdocrc files and/or command line options.\n\n#### The Settings menu and configuration files\n\nThe Settings menu is used to change the user-definable settings of texdoctk for the duration\nof the program call or as new defaults. The latter case is the purpose of the Save button,\nwhich generates or rewrites the user's own ~/.texdocrc file. The system defaults cannot be\nedited with the Settings menu.\n\nPaths The TEXMF-type paths on the system are reported, and the user can specify the name of\nthe subdirectory of $HOMETEXMF, where the personal documentation is stored.\n\nGeneral viewer behaviour\n\nSuppress error messages toggle verbose mode (see option -v); default is off.\n\nAutostart viewer for one-item listboxes if a listbox contains only one item (see op‐\ntion -a)\n\nUse text viewer for unknown file format i.e. treat the file as plain text. texdoctk\nshould recognize the usual file formats and also relate names like README to plain\ntext, but some docs may have freely invented names. Default is on; if switched off,\ntrying to view such files will raise an error. The switch does not influence printing:\nunrecognized formats cannot be printed.\n\nChange viewer colours using either RGB triplets in the format #rrggbb or the standard‐\nized names.\n\nDVI/PostScript/PDF/HTML/Plain text\nFor text files, texdoctk provides an own viewer. If this viewer is disabled, but no\nalternative viewer is specified, texdoctk tries to read the content of the environment\nvariable $PAGER.\n\nIf you want to print the documentations, you will need converters to turn non-PS files\ninto PostScript. Here are some suggestions:\n\ndvi->ps: dvips (is part of teTeX) (http://www.radicaleye.com/dvips.html)\n\npdf->ps: pdf2ps (http://www.cs.wisc.edu/~ghost) or Acrobat Reader\n(http://www.adobe.com)\n\nhtml->ps: html2ps (http://user.it.uu.se/~jan/html2ps.html)\n\nplain text->ps: a2ps (http://www-inf.enst.fr/~demaille/a2ps/)\n\nThe html->ps and text->ps converter menus for switching on/off output redirect. This\nis due to the fact that some converters do not write their output into a file but to\nstdout by default, so a redirect is needed, e.g. a2ps myfile.txt >myfile.ps\n\nThe system-wide configuration file is ($TEXMFMAIN)/texdoctk/texdocrc.defaults and should only\nbe writable by the administrator of the installation using any text editor. The optional user\nconfiguration file is ~/.texdocrc and can override all but those system settings which affect\nthe installation as a whole. The preferred way of changing it is through the Settings menu.\n\n#### The databases\n\ntexdoctk comes with a default database file ($TEXMFMAIN)/texdoctk/texdoctk.dat with a special\nformat. It is divided into 17 sections corresponding to the 17 buttons that are active by de‐\nfault. Each section begins with a line\n\n@sectionname\n\nwhere sectionname is the text as it appears in the button. This title is followed by the de‐\nscriptive entries for each documentation, which have this format:\n\npackage-label;Short description for listbox (opt. package-name);path in doc directory;op‐\ntional keywords\n\n(without breaking the line!). Comments (initiated with a #) and empty lines are ignored by\nthe program. The second field is the text displayed in the selection listboxes of texdoctk,\nand you will usually want to mention the name of the package in parens along with it; the\nfirst field is a unique label for the package for internal use of the program which will usu‐\nally be chosen identical to the package name, but can be different if there is more than one\ndocumentation file coming with a package.\n\nThe administrator will probably install additional packages in the local texmf tree. The cor‐\nresponding documentation can be made accessible by an additional database $TEXMFLOCAL/tex‐\ndoctk/texdoctk-local.dat. Furthermore, individual users possibly install additional packages\nin an texmf subdirectory of their $HOME, for which they can make an individual database them‐\nselves as $TEXMFHOME/texdoctk/texdoctk-pers.dat. After creating such files, texhash must be\nexecuted.\n\nBoth types of databases must have the same structure as the system database, although they\nneed (and should) not include all its sections if there are no additional entries. For exam‐\nple, if the the package foo is added to the local tree such that its documentation file is\n($TEXMFLOCAL)/doc/latex/foo/foo.dvi and it is decided that it fits best into the existing\ncategory Graphics, texdoctk-local.dat would look like this:\n\n@Graphics\nfoo;Create bells and whistles (foo);latex/foo/foo.dvi;decoration\n\nThe entry for foo will then be appended to the list of entries in the Graphics category. The\n18th button can be activated in the same way, but using a new category name; possible entries\nat the beginning of the database which have not been assigned to a category will be assigned\nto the default Miscellaneous, making the 18th button active with that label. Note that you\ncannot have more than 18 categories; if there are more, only the one defined last will appear\nand be used.\n\nIf the documentation is included in the .sty file instead of a proper documentation file, the\noptional keywords should start with -?- directly after the semicolon, where ? is 0, 1, 2 or\n3; these are flags which indicate in which part of the .sty the instructions are placed and\nshould help texdoctk to extract the documentation from the style and present it without the\ncode, which would normally be of little use.\n\n0 no specific place, scattered between the code\n\n1 at end, behind \\endinput; some .sty files have well-organized documentation behind the\nend of the actual code, where TeX doesn't see it upon compilation\n\n2 at beginning, terminated by %%%%%%; in some other cases, some usage information is at\nthe beginning of the .sty as a comment terminated by a line full of %\n\n3 as 2, but with a blank line as termination\n\nSee the system database for plenty of examples.\n\n### FILES\n\n$TEXMFMAIN/texdoctk/texdocrc.defaults system-wide configuration file\n\n~/.texdocrc (optional) personal configuration file; can also be created with the Settings\nmenu\n\n$TEXMFMAIN/texdoctk/texdoctk.dat default database file for documentation files of the dis‐\ntribution\n\n$TEXMFLOCAL/texdoctk/texdoctk-local.dat (optional) local database file for documentation\nfiles\n\n$TEXMFHOME/texdoctk/texdoctk-pers.dat (optional) personal database file of individual users\nfor documentation files\n\n### BUGS\n\nWidget placement in topic toplevels becomes ugly when the toplevel is stretched or shrunk.\n\nThe font in the frame labels of the Settings menu are not forced to the default font; this\nwill become visible e.g. at hi-res screens, where the label font is not scaled up.\n\nNetscape and Mozilla error output will be written to stderr even if the quiet mode was set.\n\n### AUTHOR\n\ntexdoctk was written by Thomas Ruedas .\n\nThis manual page was originally written by Adrian Bunk for the Debian\nGNU/Linux system (but may be used by others). It is now maintained by Thomas Ruedas.\n\n### COPYRIGHT\n\nCopyright (C) 2000-2004 Thomas Ruedas\nThis is free software; see the source for copying conditions. There is NO warranty; not even\nfor MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n\n\nTEXDOCTK(1)\n\n" } ], "structuredContent": { "command": "texdoctk", "section": "1", "mode": "man", "summary": "texdoctk - GUI for easier access of TeX package and program documentations", "synopsis": "texdoctk -[aq]", "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 13, "subsections": [] }, { "name": "OPTIONS", "lines": 6, "subsections": [] }, { "name": "CONFIGURATION", "lines": 4, "subsections": [ { "name": "The Settings menu and configuration files", "lines": 50 }, { "name": "The databases", "lines": 61 } ] }, { "name": "FILES", "lines": 14, "subsections": [] }, { "name": "BUGS", "lines": 7, "subsections": [] }, { "name": "AUTHOR", "lines": 6, "subsections": [] }, { "name": "COPYRIGHT", "lines": 7, "subsections": [] } ] } }