summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2008-09-17 21:54:56 (GMT)
committerBenjamin Peterson <benjamin@python.org>2008-09-17 21:54:56 (GMT)
commitb8966ab7538c4a4739a78a93bdeee508ed663d53 (patch)
tree5eeb979a600485d0cd3b5a29ca4d917d11557128
parentb34c3f402405645962831ea60d49c247db7ecaec (diff)
downloadcpython-b8966ab7538c4a4739a78a93bdeee508ed663d53.zip
cpython-b8966ab7538c4a4739a78a93bdeee508ed663d53.tar.gz
cpython-b8966ab7538c4a4739a78a93bdeee508ed663d53.tar.bz2
document compileall command flags
-rw-r--r--Doc/library/compileall.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index d62b785..86f60fb 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -11,8 +11,13 @@ libraries. These functions compile Python source files in a directory tree,
allowing users without permission to write to the libraries to take advantage of
cached byte-code files.
-The source file for this module may also be used as a script to compile Python
-sources in directories named on the command line or in ``sys.path``.
+This module may also be used as a script (using the :option:`-m` Python flag) to
+compile Python sources. Directories to recursively traverse (passing
+:option:`-l` stops the recursive behavior) for sources are listed on the command
+line. If no arguments are given, the invocation is equivalent to ``-l
+sys.path``. Printing lists of the files compiled can be disabled with the
+:option:`-q` flag. In addition, the :option:`-x` option takes a regular
+expression argument. All files that match the expression will be skipped.
.. function:: compile_dir(dir[, maxlevels[, ddir[, force[, rx[, quiet]]]]])