summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorkennyballou <kballou@onyx.boisestate.edu>2013-03-09 18:37:54 -0700
committerkennyballou <kballou@onyx.boisestate.edu>2013-03-09 20:30:52 -0700
commitdc48af934f5f5db12faddf9fd9419635d1e80368 (patch)
tree3dc70acbd4d27e6a846eed9749933b8ac1b63a5b /README.rst
parent532f5d98c15f091a270e68450112e91ad085f6bf (diff)
downloadxnt-dc48af934f5f5db12faddf9fd9419635d1e80368.tar.gz
xnt-dc48af934f5f5db12faddf9fd9419635d1e80368.tar.xz
Update documentation to reflect option changes
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index a9b66f2..b76b82d 100644
--- a/README.rst
+++ b/README.rst
@@ -224,7 +224,7 @@ Command Usage:
Where ``[options]`` are one of the following:
-* ``-v``: verbose, turn on logging
+* ``-v`` or ``--verbose``: verbose, turn on logging
And where ``[target]+`` are any target(s) method in your ``build.py``
file or:
@@ -235,13 +235,14 @@ file or:
Other Commands
--------------
-* ``list-targets``: Xnt will print all targets marked by the
- ``@target`` decorator and possibly their docstrings if they are
+* ``-l`` or ``--list-targets``: Xnt will print all targets marked by
+ the ``@target`` decorator and possibly their docstrings if they are
defined
-* ``version``: Print the current version of Xnt and quit
+* ``--version``: Print the current version of Xnt and quit
-* ``help``: Print summary information about Xnt and command usage
+* ``-h`` or ``--help``: Print summary information about Xnt and
+ command usage
For more information about Xnt and the build in functions, see the
`Package Documentation`_.