NAME

       sdfcli - Command Line Interface Utility

PURPOSE

       sdfcli extracts command line interface (CLI) information from applications and formats it into SDF.

USAGE

        usage  : sdfcli [-h[help]] [-o[out_ext]]
                [-l[log_ext]] [-O[out_dir]] [-w wrap]
                utility ...
       purpose: format a utility's command line interface into SDF
       version: 2.000    (SDF 2.001)

       The options are:

        Option       Description
        -h           display help on options
        -o           output file extension
        -l           log file extension
        -O           output to input file's (or explicit) directory
        -w           column at which to wrap option specifications

DESCRIPTION

       The -h option provides help. If it is specified without a parameter, a brief description of each option
       is displayed. To display the attributes for an option, specify the option letter as a parameter.

       By default, generated output goes to standard output. To direct output to a file per input file, use the
       -o option to specify an extension for output files. If the -o option is specified without a parameter, an
       extension of out is assumed.

       Likewise, error messages go to standard error by default. Use the -l option to create a log file per
       input file. If the -l option is specified without a parameter, an extension of log is assumed.

       By default, generated output and log files are created in the current directory. Use the -O option to
       specify an explicit output directory.  If the -O option is specified without a parameter, the input
       file's directory is used.

       sdfcli executes each argument with a -h flag and converts the resultant output to nicely formatted SDF.
       An argument of "-" specifies that the help should be read from standard input.

       Formatting is done as follows:

       1.  lines  are  tagged  as  Example  paragraphs,  with  the  first  line  formatted  to wrap option usage
           specifications nicely

       2.  if a line is found that starts with 'options:', it is replaced with  a  Body  paragraph  saying  "The
           options are:", and the following lines are formatted as a table of codes and descriptions

       3.  if  a  line  is  found  that starts with 'aliases:', it is replaced with a Body paragraph saying "The
           aliases are:", and the following lines are formatted as a table of names and descriptions

       4.  each option code in the table is formatted as a hypertext jump to a tag called cmd_opt where:

           •       cmd is the command name

           •       opt is the option code

       The -w option specifies at what column to wrap option specifications.  The default is 50 -  this  is  the
       best for output imported into the Mincom templates.

LIMITATIONS AND FUTURE DIRECTIONS

       The table formats used are hard coded.

perl v5.24.1                                       2016-12-31                                          SDFCLI(1)