// Code Synthesis CLI configuration
// see http://codesynthesis.com/projects/cli
//
// cli must be run every time this file is modified:
// cli CommandLineOptions.cli
//
// to update the manpage:
// cli --stdout --man-prologue resources/manpage-prologue.1.in --man-epilogue resources/manpage-epilogue.1.in --generate-man CommandLineOptions.cli > resources/camitk-config.1.in

include <string>;

class options {
  bool --help | -h 
  {"Print usage information and exit."};
  
  bool --version | -v 
  {"Print CamiTK version message"};
  
  bool --config | -c                             
  {"Print all information for a complete CamiTK diagnosis and exit"};
  
  bool --config-json | -cj
  {"Export all CamiTK diagnosis information to JSON and exit"};
  
  bool --print-paths | -p                        
  {"Print CamiTK paths on the standard output and exit"};
  
  bool --camitk-dir | -d | --camitkDir           
  {"Print CAMITK_DIR (the installation directory) and exit"};
  
  bool --short-version | -s | --shortVersion     
  {"Print CamiTK short version string"};
  
  bool --complete-version | -vv                  
  {"Print CamiTK complete version number (including patch number)"};
  
  bool --time-stamp | -t                         
  {"Generate a time stamp in format YYYY-MM-DDTHH:mm:ss from current system date and time"};
  
  bool --bug-report-info | -b                    
  {"Generate a report bug template with the CamiTK diagnosis in it"};

  std::string --check-hotplug-extension | -e             
  {"<camitk-file>",
    "CamiTK extension file describing the python or C++ hotplug extension to check.                                         
    This should be a valid .camitk JSON document describing a python or C++ hotplug extension, in a valid extension directory containing all the source code (python scripts or C++ user actions depending on the extension language). 
    This means that calling camitk-config will fail if camitk-extensiongenerator was not previously called on the CamiTK extension file using the same directory.

    For python extension, the virtual environment will be automatically created, if not already present, using the requirements given in the CamiTK extension file.

    The input .camitk <file> is \b{mandatory} for this option. The directory of the script should also be the base directory for the action source code."};
};
