libsim  Versione 7.2.6

◆ optionparser_add_help()

subroutine, public optionparser_class::optionparser_add_help ( type(optionparser), intent(inout)  this,
character(len=*), intent(in)  short_opt,
character(len=*), intent(in)  long_opt,
character(len=*), optional  help 
)

Add a new help option, with an optional argument.

When parsing will be performed, the full help message will be printed if this option is encountered. The message can be directly printed as well by calling the optparser_printhelp method. The optional argument given by the user to the option specifies the format of the help message, it can be one fo the following:

  • txt or no extra argument: generic plain-text format suitable for printing to screen and to be fed to the help2man command for generating man pages
  • md or markdown: print help in markdown format, suitable for wiki/github/doxygen etc. pages
  • htmlform: print help as an html form suitable for providing the options through a web interface (experimental)
    Parametri
    [in,out]thisoptionparser object
    [in]short_optthe short option (may be empty)
    [in]long_optthe long option (may be empty)
    helpthe help message that will be formatted and pretty-printed on screen

Definizione alla linea 1475 del file optionparser_class.F90.


Generated with Doxygen.