diff options
| author | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-09 18:37:54 -0700 |
|---|---|---|
| committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-03-09 18:37:54 -0700 |
| commit | 2467c3a3bdefd1d06f02afc1a6b9ac5bf272ca0e (patch) | |
| tree | b974fc6787205c75a7d9e9147d2d3dc4d4db6ff8 /docs | |
| parent | 532f5d98c15f091a270e68450112e91ad085f6bf (diff) | |
| download | xnt-2467c3a3bdefd1d06f02afc1a6b9ac5bf272ca0e.tar.gz xnt-2467c3a3bdefd1d06f02afc1a6b9ac5bf272ca0e.tar.xz | |
Update documentation to reflect option changes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/xenant.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/source/xenant.rst b/docs/source/xenant.rst index e9456fa..156883f 100644 --- a/docs/source/xenant.rst +++ b/docs/source/xenant.rst @@ -47,27 +47,27 @@ Xnt has a number of other commands that can be invoked besides those defined in the current directory's `build.py` file. One will need a build file to run. The others, however, do not. -* ``help`` prints a summary message, including information about the version of - Xnt, license, and usage. +* ``-h`` or ``--help`` prints a summary message, including information about + the version of Xnt, license, and usage. Usage:: - $ xnt help + $ xnt --help -* ``list-targets`` does exactly what the name should suggest: it prints a list - of the targets found in the current directory's `build.py` script, along with - any docstrings that may be defined with them. +* ``-l`` or ``--list-targets`` does exactly what the name should suggest: it + prints a list of the targets found in the current directory's `build.py` + script, along with any docstrings that may be defined with them. Usage:: - $ xnt list-targets + $ xnt --list-targets -* ``version`` prints Xnt's installed version. +* ``--version`` prints Xnt's installed version. Usage:: - $ xnt version + $ xnt --version .. _xntOptions: @@ -82,7 +82,7 @@ Usage:: Where options can be any and all of the following (unless otherwise specified): -* ``-v``: add verbose output to the execution of Xnt +* ``-v`` or ``--verbose``: add verbose output to the execution of Xnt .. _xntPropertiesParameters: |