From 6e77b7ed20a768f695648adb24d1497c56ec21f9 Mon Sep 17 00:00:00 2001 From: kennyballou Date: Thu, 14 Feb 2013 15:27:17 -0700 Subject: Update Documentation regarding usage --- docs/source/xenant.rst | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/source/xenant.rst b/docs/source/xenant.rst index 5bd6235..e9456fa 100644 --- a/docs/source/xenant.rst +++ b/docs/source/xenant.rst @@ -38,16 +38,22 @@ example:: Will execute `target1` through `targetN` in order of listing. -.. _specialTargets: +.. _otherCommands: -Special Targets ---------------- +Othes Commands +-------------- + +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. -"Special" targets (for lack of a better name) are targets that do not exist in -the build script, but rather are a part of Xnt. +Usage:: + + $ xnt help -Thus far, I have only defined one "special" target, ``list-targets`` (I don't -think this name is going to change again ...). * ``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 @@ -57,6 +63,12 @@ Usage:: $ xnt list-targets +* ``version`` prints Xnt's installed version. + +Usage:: + + $ xnt version + .. _xntOptions: Options @@ -72,12 +84,6 @@ Where options can be any and all of the following (unless otherwise specified): * ``-v``: add verbose output to the execution of Xnt -* ``--version``: Print the version of Xnt and exit - -* ``--usage``: Print version, license, usage information and quit. [I've - debatted between putting this as a special target and leaving it as an - option.. not sure which is better...] - .. _xntPropertiesParameters: Properties and Parameter Passing -- cgit v1.2.1