(help2man.info.gz) Including text

Info Catalog

(help2man.info.gz) Invoking help2man

(help2man.info.gz) Top

(help2man.info.gz) --help recommendations

 
 4 Including Additional Text in the Output
 *****************************************
 
 Additional static text may be included in the generated manual page by
 using the `--include' and `--opt-include' options ( Invoking
 help2man).
 
    The format for files included with these option is simple:
 
      [section]
      text
 
      /pattern/
      text
 
    Blocks of verbatim *roff text are inserted into the output either at
 the start of the given `[section]' (case insensitive), or after a
 paragraph matching `/pattern/'.
 
    Patterns use the Perl regular expression syntax and may be followed
 by the `i', `s' or `m' modifiers ( perlre(1) (*manpages*)perlre.)
 
    Lines before the first section or pattern which begin with `-' are
 processed as options.  Anything else is silently ignored and may be
 used for comments, RCS keywords and the like.
 
    The section output order is:
 
      NAME
      SYNOPSIS
      DESCRIPTION
      OPTIONS
      EXAMPLES
      _other_
      AUTHOR
      REPORTING BUGS
      COPYRIGHT
      SEE ALSO
 
    Any `[name]' or `[synopsis]' sections appearing in the include file
 will replace what would have automatically been produced (although you
 can still override the former with `--name' if required).
 
    Other sections are prepended to the automatically produced output for
 the standard sections given above, or included at _other_ (above) in
 the order they were encountered in the include file.
 

Info Catalog

(help2man.info.gz) Invoking help2man

(help2man.info.gz) Top

(help2man.info.gz) --help recommendations