diff --git a/apps/cli/executables/null/README.md b/apps/cli/executables/null/README.md index b2cc894843867d2fa2ab8c1a76de9c55036411ac..2840736025b0f9676f061d687d4c28451517db8c 100644 --- a/apps/cli/executables/null/README.md +++ b/apps/cli/executables/null/README.md @@ -1,41 +1,29 @@ +This is the null executable, a baseline test of the functionality of the Workspaces system. -# datafetcher: data-fetcher for the AAT/PPI - -This is an implementation of the NRAO archive's Java-based data-fetcher in Python, as a research experiment on how it could be modularized and re-structured. - -Use cases datafetcher is intended to handle: - * works for both science products and ancillary products - * download a product from the NRAO archive by specifying its product locator - * download a product from the NRAO archive by providing a path to a locator report - * streaming or direct copy downloads based on file location and execution site - -This is intended to be a library wrapped in a command line interface. +It can: +- Print a message to stderr +- Print a message to stdout +- Exit with status code -1 +- Exit with random status code in [-50, 50] +- Sleep for 5 seconds +- Abort and dump the core ``` -usage: datafetcher [-h] - (--product-locator PRODUCT_LOCATOR | --location-file LOCATION_FILE) - [--dry-run] [--output-dir OUTPUT_DIR] [--verbose] - [--profile PROFILE] +usage: null [-h] [-v] [-pe | -g | -ef | -er | -n | -d] + +Workspaces null executable, a status capture test of the system. Version 4.0.0a1.dev1 -Retrieve a product (a science product or an ancillary product) from the NRAO archive, -either by specifying the product's locator or by providing the path to a product -locator report. +optional arguments: + -h, --help show this help message and exit + -pe, --print-error print out aggressive message to stderr + -g, --greeting print out a friendly greeting to stdout + -ef, --exit-fail print error message and exit with status code -1 + -er, --exit-random print error message and exit with random status code within [-50, 50] + -n, --nap take a short nap + -d, --dump abort program and dump core -Optional Arguments: - --dry-run dry run, do not fetch product - --output-dir OUTPUT_DIR - output directory, default current directory - --verbose make a lot of noise - --profile PROFILE CAPO profile to use +options: + settings for altering program behavior -Return Codes: - 1: no CAPO profile provided - 2: missing required setting - 3: request to locator service timed out - 4: too many redirects on locator service - 5: catastrophic error on request service - 6: product locator not found - 7: not able to open specified location file - 8: error fetching file from NGAS server - 9: retrieved file not expected size + -v, --verbose allow the program the gift of speech ```