Comprehensive TeX Archive Network

Direc­tory tex-archive/info/pstdoc

This package is distributed under the LaTeX Project Public License.

It provides help with syntax and keywords associated with PSTricks commands. See the screenshot for typical output.

Installation of pstdoc.

Python 2.5 or more recent is required. The database file pstCommands.db must be in the same folder as the Python script pstdoc.py.

1. Set up your Terminal Window so that it understands ANSI commands, by setting the following in ~/.profile or ~/.MacOSX/environment.plist.


2. Check that your version of Python is recent enough.

3. Rename pstdoc.py to just pstdoc, and copy it to some folder in your PATH. I copied it to ~/bin, along with the SQLite database file pstCommands.db

4. Enter, for example, 
pstdoc \psarc (or just pstdoc psarc)
to get the syntax and all keywords that might apply. Arguments with yellow background are optional. A red double left arrow indicates a default replacement value. Output look better when the Terminal window is twice as wide as normal.


Install Python (the MSI version) from ActiveState and restart Windows. You invoke it as

python c:\mybin\pstdoc.py \psarc

after installing pstdoc.py and pstCommands.db in some folder in your PATH---say, C:\mybin. A batch file pstdoc.bat in c:\mybin containing just the line

python C:\mybin\pstdoc.py %1

will allow it to be invoked with 

pstdoc \psarc

The output has no color and no double left arrow character---a left pointing double-angle quote is used instead. The presence of this character indicates that the argument is optional, and spells out the default value.


It should work if used in a terminal that understands ANSI color commands.

Apache Web Server:

This is the nicest interface, IMHO.

In the Webserver folder:

Documents <- pstCommands.db, psthelp.css, index.html
CGI-Executables <- parsehelp.py

I keep this running at all times on my Mac OS 10.6.7 (check Web Sharing in System Preferences/Sharing) so that help is available in the browser by browsing to http://localhost.


Name Size Date Notes
README 2072 2011-06-23 20:19
in­dex.html 656 2009-10-02 00:47
parse­help.py 4540 2009-08-24 20:54
pstCom­mands.db 162816 2011-06-24 06:10
pst­doc.py 2526 2009-08-18 00:37
ps­thelp.css 581 2009-08-20 03:58
screen­shot.png 60126 2009-06-30 06:02

Down­load the con­tents of this pack­age in one zip archive (104.6k).

pst­doc – A tool for PSTricks doc­u­men­ta­tion

The bun­dle pro­vides an SQLite database and a Python script that pro­vides ex­ten­sive help with PSTricks com­mands from a ter­mi­nal win­dow.

For ex­am­ple pst­doc \psarc gives the syn­tax of \psarc and all as­so­ci­ated key­words, with short def­i­ni­tions.

The script is known to work on Mac, Win­dows, and Linux sys­tems; it re­quires Python 2.5 or bet­ter.

The database cov­ers pstricks it­self, pst-plot, pst-node, pst-text, pstricks-add, pst-3dplot and re­lated pack­ages.

Pack­age De­tailspst­doc
Ver­sion 2011-06-24
Li­censeThe LaTeX Project Public Li­cense
Main­tainerMichael Sharpe
Topics ‘stand-alone’ doc­u­men­ta­tion
pack­age us­ing PStricks for graph­i­cal out­put
Guest Book Sitemap Contact Contact Author