Skip to content

UserInput/XLALUserVarPrintHelp(): improve help synopsis

Karl Wette requested to merge (removed):UserInput-improve-help-synopsis into master
  • Explicitly document -h|--help and -v|--version options
  • Explicitly document configuration file @ option

Addresses https://git.ligo.org/CW/software/lalsuite/issues/37

Example output:

NAME
       lalapps_Weave - search for gravitational-wave pulsars

SYNOPSIS
       lalapps_Weave --help
           Display this help page.

       lalapps_Weave -h
           Display a short usage string of available options.

       lalapps_Weave -v|--version[=verbose]
           Display (verbose) version information.

       lalapps_Weave [@<config-file>] [<options>...]
           Run the program. Options are parsed first from an INI-style configuration file
           <config-file>, if given, and then from the command line as <options>.

OPTIONS
...

/cc @david-keitel

Merge request reports