From f9562e035b3f33144aaa26018a1dee46f02769c5 Mon Sep 17 00:00:00 2001 From: Thomas Levine <_@thomaslevine.com> Date: Sun, 28 Feb 2016 14:12:21 +0000 Subject: [PATCH] update help --- urchin | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/urchin b/urchin index 896966e..29b9ba0 100755 --- a/urchin +++ b/urchin @@ -332,19 +332,33 @@ On each run, 2. If the test file has a shebang line of "#!/bin/sh" or no shebang line at all, the test script is also executed in that shell. --s Specify which shells Urchin should test in rather than using the - default list. --n Disable the cycling of shells; Urchin will execute test files - directly, and it will not manipulate the TEST_SHELL environment - variable. --e Stop running if any single test fails. This is helpful if you want - to use Urchin to run things other than tests, such as a set of - configuration scripts. --f Force running even if the test directory's name does not - contain the word "test". --t Format output in Test Anything Protocol (TAP) --h, --help This help. --v Display the version number. +The following flags affect how this multiple-shell testing is handled. + +-s, --shell Tell Urchin to use a different list of shells. + (You can pass this flag multiple times.) + +-n, --disable-cycling Disable the cycling of shells; Urchin will execute + test files directly, and it will not manipulate the + TEST_SHELL environment variable. + +Urchin can run any Unix-style programs for any purpose, not just for testing. +If you are using Urchin for automatally running periodic jobs or for running +lots of configuration files, you may find these options helpful. + +-e, --exit-on-fail Stop running if any single test fails. +-f, --force Force running even if the test directory's name + does not contain the word "test". + +These options affect how results are formatted. + +-t, --tap Format output in Test Anything Protocol (TAP) +-v, --verbose Print stdout from all tests, not just failed tests. + XXX Not yet implemented + +The remaining flags provide information about urchin. + +-h, --help Display this help. +--version Display the version number. Go to https://github.com/tlevine/urchin for documentation on writing tests. @@ -408,7 +422,7 @@ do -t) tap_format=true;; -h|--help) urchin_help exit 0;; - -v) echo "$VERSION" + --version) echo "$VERSION" urchin_exit;; -*) urchin_help >&2 exit 1;;