Difference between revisions of "Help2man"

From Free Software Directory
Jump to: navigation, search
(version 1.47.3)
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Entry
 
{{Entry
|Name=Help2man
+
|Name=GNU help2man
 
|Short description=Generates manual pages from program files
 
|Short description=Generates manual pages from program files
|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''' is a program that converts the output of standard <tt>--help</tt> and <tt>--version</tt> command-line arguments into a manual page automatically.  
|User level=none
+
 
|Status=Live
+
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.
|Component programs=
+
|Homepage URL=https://www.gnu.org/software/help2man
|Homepage URL=http://www.gnu.org/software/help2man
+
|User level=beginner
|VCS checkout command=
 
 
|Computer languages=Perl
 
|Computer languages=Perl
|Documentation note=User guide included
+
|Documentation note=User guide included.
|Paid support=
 
|IRC help=
 
|IRC general=
 
|IRC development=
 
 
|Related projects=Cxref,Texinfo
 
|Related projects=Cxref,Texinfo
 
|Keywords=help,documentation,editing,man pages,help2man
 
|Keywords=help,documentation,editing,man pages,help2man
|Is GNU=n
+
|Version identifier=1.47.3
|Last review by=Janet Casey
+
|Version date=2015/11/18
|Last review date=2003-07-22
+
|Version status=stable
 +
|Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.47.3.tar.xz
 +
|Last review by=Genium
 +
|Last review date=2016/02/27
 
|Submitted by=Database conversion
 
|Submitted by=Database conversion
 
|Submitted date=2011-04-01
 
|Submitted date=2011-04-01
|Version identifier=1.38.1
+
|Status=
|Version date=2010-04-26
+
|Is GNU=Yes
|Version status=stable
+
|GNU package identifier=help2man
|Version download=http://ftp.gnu.org/gnu/help2man/help2man-1.38.1.tar.gz
 
 
|License verified date=2010-04-28
 
|License verified date=2010-04-28
|Version comment=
+
}}
 +
{{Project license
 +
|License=GPLv3
 +
|License verified by=arca0
 +
|License verified date=2012/09/08
 
}}
 
}}
 
{{Person
 
{{Person
 +
|Real name=Brendan O'Dea
 
|Role=Maintainer
 
|Role=Maintainer
|Real name=Brendan O'Dea
 
 
|Email=bod@debian.org
 
|Email=bod@debian.org
 
|Resource URL=
 
|Resource URL=
 
}}
 
}}
 
{{Person
 
{{Person
 +
|Real name=See the THANKS file in the distribution for a complete list
 
|Role=Contributor
 
|Role=Contributor
|Real name=See the THANKS file in the distribution for a complete list
 
|Email=
 
 
|Resource URL=
 
|Resource URL=
 
}}
 
}}
Line 51: Line 51:
 
|Use=text-creation
 
|Use=text-creation
 
|Works-with=text
 
|Works-with=text
}}
 
{{Project license
 
|License=GPLv2orlater
 
|License verified by=Kelly Hopkins
 
|License verified date=2010-04-28
 
 
}}
 
}}
 
{{Software prerequisite
 
{{Software prerequisite
Line 65: Line 60:
 
|Prerequisite description=gettext
 
|Prerequisite description=gettext
 
}}
 
}}
 +
{{Featured}}

Revision as of 18:04, 27 February 2016


[edit]

GNU help2man

https://www.gnu.org/software/help2man/
Generate 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.





Licensing

License

Verified by

Verified on

Notes

Verified by

Genium

Verified on

1 February 2022




Leaders and contributors

Contact(s)Role
Brendan O'Dea Maintainer


Resources and communication

AudienceResource typeURI
FTPDownloadhttps://ftp.gnu.org/gnu/help2man/
WikidataGeneralhttps://www.wikidata.org/wiki/Q60918168
Generalhttps://translationproject.org/domain/help2man.html
DebianDeveloperhttps://tracker.debian.org/pkg/help2man
FTPDownloadhttps://ftpmirror.gnu.org/help2man/
DebianVCS Repository Webviewhttps://salsa.debian.org/bod/help2man/


Software prerequisites

KindDescription
Required to useLocale_gettext Perl module
Required to usegettext

This entry (in part or in whole) was last reviewed on 8 January 2023.




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.