[py-svn] r36512 - py/dist/py/documentation

[cfbolz at codespeak.net]

Author: cfbolz
Date: Thu Jan 11 17:04:53 2007
New Revision: 36512

Added:
   py/dist/py/documentation/binary.txt
Log:
a start of documenting the things in py/bin


Added: py/dist/py/documentation/binary.txt
==============================================================================
--- (empty file)
+++ py/dist/py/documentation/binary.txt	Thu Jan 11 17:04:53 2007
@@ -0,0 +1,49 @@
+==================
+py-lib executables
+==================
+
+The py-lib contains some executables which are described here. Most of them are
+relatively small scripts (apart from ``py.test``). We are open for feature
+requests!
+
+``py.test``
+===========
+
+The ``py.test`` executable is the main entry point into the py-lib testing tool,
+see the `py.test documentation`_.
+
+.. _`py.test documentation`: test.html
+
+``py.cleanup``
+==============
+
+Usage: ``py.cleanup [PATH]``
+
+Delete pyc file recursively, starting from ``PATH`` (which defaults to the
+current working directory). Don't follow links and don't recurse into
+directories with a ".".
+
+
+``py.countloc``
+===============
+
+Usage: ``py.countloc [PATHS]``
+
+Count (non-empty) lines of python code and number of python files recursively
+starting from a ``PATHS`` given on the command line (starting from the current
+working directory). Distinguish between test files and normal ones and report
+them separately.
+
+``py.lookup``
+=============
+
+Usage: ``py.lookup SEARCH_STRING [options]``
+
+Looks recursively at Python files for a ``SEARCH_STRING``, starting from the
+present working directory. Prints the line, with the filename and line-number
+prepended.
+
+``py.rest``
+===========
+
+XXX to be documented