Difference between revisions of "Help2man"

From Free Software Directory
Jump to: navigation, search
(Created page with "{{Entry |Name=Help2man |Short description=Generates manual pages from program files |Full description='help2man' automatically generates simple manual pages from program files by...")
 
Line 4: Line 4:
 
|Full description='help2man' automatically generates simple manual pages from program files by reasonably rearranging standard --help and --version outputs into something that resembles a manual page. It lets developers include a manual page in their distribution without having to maintain that document.
 
|Full description='help2man' automatically generates simple manual pages from program files by reasonably rearranging standard --help and --version outputs into something that resembles a manual page. It lets developers include a manual page in their distribution without having to maintain that document.
 
|User level=none
 
|User level=none
 +
|Status=Live
 +
|Component programs=
 +
|Homepage URL=http://www.gnu.org/software/help2man
 +
|VCS checkout command=
 +
|Computer languages=Perl
 +
|Documentation note=User guide included
 +
|Paid support=
 +
|IRC help=
 +
|IRC general=
 +
|IRC development=
 +
|Related projects=Cxref,Texinfo
 +
|Keywords=help,documentation,editing,man pages,help2man
 +
|Is GNU=n
 +
|Last review by=Janet Casey
 +
|Last review date=2003-07-22
 
|Submitted by=Database conversion
 
|Submitted by=Database conversion
 
|Submitted date=2011-04-01
 
|Submitted date=2011-04-01
|Version identifier=1.33.1
+
|Version identifier=1.38.1
|Version date=2003-07-21
+
|Version date=2010-04-26
 
|Version status=stable
 
|Version status=stable
|Version download=ftp://ftp.gnu.org/gnu/help2man/help2man-1.33.1.tar.gz
+
|Version download=http://ftp.gnu.org/gnu/help2man/help2man-1.38.1.tar.gz
|License verified date=2001-01-31
+
|License verified date=2010-04-28
|Version comment=1.33.1 stable released 2003-07-21
+
|Version comment=
 +
}}
 +
{{Person
 +
|Role=Maintainer
 +
|Real name=Brendan O'Dea
 +
|Email=bod@debian.org
 +
|Resource URL=
 +
}}
 +
{{Person
 +
|Role=Contributor
 +
|Real name=See the THANKS file in the distribution for a complete list
 +
|Email=
 +
|Resource URL=
 +
}}
 +
{{Resource
 +
|Resource audience=Bug Tracking
 +
|Resource kind=E-mail
 +
|Resource URL=mailto:bug-help2man@gnu.org
 
}}
 
}}
 
{{Software category
 
{{Software category
 +
|Documentation-tool=documentation-conversion
 
|Interface=command-line
 
|Interface=command-line
 +
|Text-creation=documentation-tool
 +
|Use=text-creation
 +
|Works-with=text
 
}}
 
}}
 
{{Project license
 
{{Project license
 
|License=GPLv2orlater
 
|License=GPLv2orlater
|License verified by=Janet Casey
+
|License verified by=Kelly Hopkins
|License verified date=2001-01-31
+
|License verified date=2010-04-28
 
}}
 
}}
 
{{Software prerequisite
 
{{Software prerequisite

Revision as of 11:03, 12 April 2011

[edit]

GNU help2man

https://www.gnu.org/software/help2man
Generates manual pages from program files

Help2man is a program that converts the output of standard --help and --version command-line arguments into a manual page automatically.

It lets developers include a manual page in their distribution without having to maintain that document. Since Texinfo is the official documentation format of the GNU project, this also provides a way to generate a placeholder man page pointing to that resource while still providing some useful information.

Documentation

User guide included.

Related Projects




Licensing

LicenseVerified byVerified onNotes
GPLv3arca08 September 2012



Leaders and contributors

Contact(s)Role
Brendan O'Dea Maintainer
See the THANKS file in the distribution for a complete list Contributor


Resources and communication

AudienceResource typeURI
Bug TrackingE-mailmailto:bug-help2man@gnu.org


Software prerequisites

KindDescription
Required to useLocale_gettext Perl module
Required to usegettext

This entry (in part or in whole) was last reviewed on 27 February 2016.



Entry



























Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.