from small one page howto to huge articles all in one place
 

search text in:





Poll
Which kernel version do you use?





poll results

Last additions:
using iotop to find disk usage hogs

using iotop to find disk usage hogs

words:

887

views:

85690

userrating:

average rating: 1.7 (82 votes) (1=very good 6=terrible)


May 25th. 2007:
Words

486

Views

202123

why adblockers are bad


Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

84137

userrating:

average rating: 1.3 (27 votes) (1=very good 6=terrible)


April, 26th. 2006:

Druckversion
You are here: manpages





HELP2MAN

Section: User Commands (1)
Updated: January 2015
Index Return to Main Contents
 

NAME

help2man - generate a simple manual page  

SYNOPSIS

help2man [,OPTION/]... ,EXECUTABLE/  

DESCRIPTION

`help2man' generates a man page out of `--help' and `--version' output.
-n, --name=,STRING/
description for the NAME paragraph
-s, --section=,SECTION/
section number for manual page (1, 6, 8)
-m, --manual=,TEXT/
name of manual (User Commands, ...)
-S, --source=,TEXT/
source of program (FSF, Debian, ...)
-L, --locale=,STRING/
select locale (default "C")
-i, --include=,FILE/
include material from `FILE'
-I, --opt-include=,FILE/
include material from `FILE' if it exists
-o, --output=,FILE/
send output to `FILE'
-p, --info-page=,TEXT/
name of Texinfo manual
-N, --no-info
suppress pointer to Texinfo manual
-l, --libtool
exclude the `lt-' from the program name
--help
print this help, then exit
--version
print version number, then exit

EXECUTABLE should accept `--help' and `--version' options and produce output on stdout although alternatives may be specified using:

-h, --help-option=,STRING/
help option string
-v, --version-option=,STRING/
version option string
--version-string=,STRING/
version string
--no-discard-stderr
include stderr when parsing option output
 

INCLUDE FILES

Additional material may be included in the generated output with the --include and --opt-include options. The format 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 (see perlre(1)).

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 (for those included) is:


    NAME
    SYNOPSIS
    DESCRIPTION
    OPTIONS
    ENVIRONMENT
    FILES
    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.

Placement of the text within the section may be explicitly requested by using the syntax [<section], [=section] or [>section] to place the additional text before, in place of, or after the default output respectively.  

AVAILABILITY

The latest version of this distribution is available on-line from:


    ftp://ftp.gnu.org/gnu/help2man/  

AUTHOR

Written by Brendan O'Dea <bod@debian.org>  

REPORTING BUGS

Report bugs to <bug-help2man@gnu.org>.  

COPYRIGHT

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

SEE ALSO

The full documentation for help2man is maintained as a Texinfo manual. If the info and help2man programs are properly installed at your site, the command
info help2man

should give you access to the complete manual.


 

Index

NAME
SYNOPSIS
DESCRIPTION
INCLUDE FILES
AVAILABILITY
AUTHOR
REPORTING BUGS
COPYRIGHT
SEE ALSO


Please read "Why adblockers are bad".



Other free services
toURL.org
Shorten long
URLs to short
links like
http://tourl.org/2
tourl.org
.
Reverse DNS lookup
Find out which hostname(s)
resolve to a
given IP or other hostnames for the server
www.reversednslookup.org
rdf newsfeed | rss newsfeed | Atom newsfeed
- Powered by LeopardCMS - Running on Gentoo -
Copyright 2004-2013 Sascha Nitsch Unternehmensberatung UG(haftungsbeschränkt)
Valid XHTML1.1 : Valid CSS : buttonmaker
- Level Triple-A Conformance to Web Content Accessibility Guidelines 1.0 -
- Copyright and legal notices -
Time to create this page: 3.2 ms