(help2man.info.gz) Invoking help2man

 
 2 How to Run `help2man'
 ***********************
 
 The format for running the `help2man' program is:
 
      `help2man' [OPTION]... EXECUTABLE
 
    `help2man' supports the following options:
 
 `-n STRING'
 `--name=STRING'
      Use STRING as the description for the `NAME' paragraph of the
      manual page.
 
      By default (for want of anything better) this paragraph contains
      `manual page for PROGRAM VERSION'.
 
      This option overrides an include file `[name]' section (
      Including text).
 
 `-s SECTION'
 `--section SECTION'
      Use SECTION as the section for the man page.  The default section
      is 1.
 
 `-m MANUAL'
 `--manual=MANUAL'
      Set the name of the manual section to SECTION, used as a centred
      heading for the manual page.  By default `User Commands' is used
      for pages in section 1, `Games' for section 6 and `System
      Administration Utilities' for sections 8 and 1M.
 
 `-S SOURCE'
 `--source=SOURCE'
      The program source is used as a page footer, and often contains
      the name of the organisation or a suite of which the program is
      part.  By default the value is the package name and version.
 
 `-L LOCALE'
 `--locale=LOCALE'
      Select output locale (default `C').  Both the program and
      `help2man' must support the given LOCALE ( Localised man
      pages).
 
 `-i FILE'
 `--include=FILE'
      Include material from FILE ( Including text).
 
 `-I FILE'
 `--opt-include=FILE'
      A variant of `--include' for use in Makefile pattern rules which
      does not require FILE to exist.
 
 `-o FILE'
 `--output=FILE'
      Send output to FILE rather than `stdout'.
 
 `-N'
 `--no-info'
      Suppress inclusion of a `SEE ALSO' paragraph directing the reader
      to the Texinfo documentation.
 
 `--help'
 `--version'
      Show help or version information.
 
    By default `help2man' passes the standard `--help' and `--version'
 options to the executable although alternatives may be specified using:
 
 `-h OPTION'
 `--help-option=OPTION'
      help option string
 
 `-v OPTION'
 `--version-option=OPTION'
      version option string
Info Catalog
(help2man.info.gz) Overview
(help2man.info.gz) Top
(help2man.info.gz) Including text
automatically generated byinfo2html