help2man(1)
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.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
