diff options
| author | rhoerbe <rainer@hoerbe.at> | 2014-07-31 15:41:09 +0200 |
|---|---|---|
| committer | rhoerbe <rainer@hoerbe.at> | 2014-07-31 15:41:09 +0200 |
| commit | 781fbe4393a7f7323ece023c10a8d74094943e50 (patch) | |
| tree | 9ead10f755708eb1feb6b80d54a33e9e183c5d1d /doc | |
| parent | 5ee6ebc897335e7ee7f71078733d012bfe3fa38f (diff) | |
| download | pysaml2-781fbe4393a7f7323ece023c10a8d74094943e50.tar.gz | |
clarified helptext on options -H, -i, etc.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/howto.rst | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/howto.rst b/doc/howto.rst index 618cc683..a3da5571 100644 --- a/doc/howto.rst +++ b/doc/howto.rst @@ -221,7 +221,7 @@ Synopsis:: -c TD_CONFIG, --config Test driver configuration module at the current directory or the path specified with the -P option. Do not use relative paths or the .py filename extension -d, --debug Print debug information to stderr - -H, --prettyprint Human readable status output + -H, --prettyprint Status output as human readable python dictionary -h, --help show this help message and exit -J TT_CONFIG_FILE Test target configuration in JSON format -L, --log Print HTTP log information # TODO: update documentation @@ -232,7 +232,11 @@ Synopsis:: -t, --testpackage Module describing tests (e.g. idp_samlbase.py generated from repository) -Y, --pysamllog Print pySAML2 logs to stderr -Remember to generate the + Output on stdout is a JSON dicitionary containing the test summary (overwrite with -H). + Output to stderr is the log file + + +Remember to generate the test target's config file in json format from python. Running the script testing an SP @@ -241,7 +245,7 @@ Running the script testing an SP Synopsis:: $ sp_testdrv.py --help - usage: sp_testdrv.py [-h] [-d] [-C CA_CERTS] [-J TT_CONFIG_FILE] [-m] [-l] [-c TD_CONFIG] [oper] + usage: sp_testdrv.py [-h] [-H] [-d] [-C CA_CERTS] [-J TT_CONFIG_FILE] [-m] [-l] [-c TD_CONFIG] [oper] positional arguments: oper Which test to run (mandatory except for options -h, -l and -m) @@ -255,6 +259,7 @@ Synopsis:: with the -P option. Do not use relative paths or filename extension -d, --debug Print debug information to stderr -h, --help show this help message and exit + -H, --prettyprint Status output as human readable python dictionary -J TT_CONFIG_FILE Test target configuration in JSON format -L, --log Print HTTP log information # TODO: update documentation -l, --list List all the test flows as a JSON object @@ -264,6 +269,8 @@ Synopsis:: -t, --testpackage Module describing tests (e.g. sp_testbase.py generated from repository) -Y, --pysamllog Print pySAML2 logs to stderr + Output on stdout is a JSON dicitionary containing the test summary (overwrite with -H). + Output to stderr is the log file Examples :::::::: |