Difference between revisions of "Help2man"
| Line 1: | Line 1: | ||
{{Entry | {{Entry | ||
|Name=GNU help2man | |Name=GNU help2man | ||
| − | |Short description= | + | |Short description=Generate manual pages from program files. |
|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. | |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. | ||
| Line 9: | Line 9: | ||
|VCS checkout command=git clone https://salsa.debian.org/bod/help2man.git | |VCS checkout command=git clone https://salsa.debian.org/bod/help2man.git | ||
|Documentation note=https://www.gnu.org/prep/standards/standards.html#Man-Pages | |Documentation note=https://www.gnu.org/prep/standards/standards.html#Man-Pages | ||
| + | |||
| + | '''Selection from the [https://shop.fsf.org/ FSF shop]''' | ||
| + | |||
| + | [https://shop.fsf.org/books/free-freedom-20-richard-stallman Free as in Freedom 2.0, by Richard Stallman] | ||
| + | |||
| + | [https://shop.fsf.org/books-docs/introduction-command-line Introduction to the Command Line] | ||
| + | |||
| + | ---- | ||
| + | ---- | ||
| + | '''[https://www.gnu.org/help/help.html Helping the GNU Project and the Free Software Movement]''' | ||
| + | ---- | ||
| + | ---- | ||
| + | |||
| + | If you have corrections to this entry or questions about it, please contact: mailto:maintainers@gnu.org | ||
| + | ---- | ||
|Decommissioned or Obsolete=No | |Decommissioned or Obsolete=No | ||
|Donate=https://my.fsf.org/donate/ | |Donate=https://my.fsf.org/donate/ | ||
| − | |Related projects=Cxref,Texinfo | + | |Related projects=gnustandards,Cxref,Texinfo |
|Keywords=help,documentation,editing,man pages,help2man | |Keywords=help,documentation,editing,man pages,help2man | ||
| − | |Version identifier=1.47. | + | |Version identifier=1.47.8 |
| − | |Version date=2018/ | + | |Version date=2018/10/13 |
|Version status=stable | |Version status=stable | ||
| − | |Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.47. | + | |Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.47.8.tar.xz |
|Last review by=Bendikker | |Last review by=Bendikker | ||
| − | |Last review date= | + | |Last review date=2019/01/06 |
|Submitted by=Database conversion | |Submitted by=Database conversion | ||
| − | |Submitted date=2011/04/ | + | |Submitted date=2011/04/01 |
|User level=beginner | |User level=beginner | ||
|Paid support=https://www.fsf.org/resources/service/ | |Paid support=https://www.fsf.org/resources/service/ | ||
|Accepts cryptocurrency donations=Yes | |Accepts cryptocurrency donations=Yes | ||
| + | |OpenPGP signature=https://ftp.gnu.org/gnu/help2man/help2man-1.47.8.tar.xz.sig | ||
|Test entry=No | |Test entry=No | ||
|Is GNU=Yes | |Is GNU=Yes | ||
| Line 46: | Line 62: | ||
{{Resource | {{Resource | ||
|Resource kind=VCS Repository Webview | |Resource kind=VCS Repository Webview | ||
| − | |Resource URL=https://salsa.debian.org/bod/help2man | + | |Resource URL=https://salsa.debian.org/bod/help2man/ |
}} | }} | ||
{{Resource | {{Resource | ||
| − | |Resource kind= | + | |Resource kind=Mailing List |
| − | |Resource URL=https:// | + | |Resource URL=https://lists.gnu.org/mailman/listinfo/gnu-system-discuss/ |
}} | }} | ||
{{Resource | {{Resource | ||
| − | |Resource kind= | + | |Resource kind=Download |
| − | |Resource URL=https:// | + | |Resource URL=https://ftp.gnu.org/gnu/help2man/ |
}} | }} | ||
{{Resource | {{Resource | ||
| Line 67: | Line 83: | ||
|Interface=command-line | |Interface=command-line | ||
|Programming-language=perl | |Programming-language=perl | ||
| + | |Runs-on=GNU/Linux | ||
|Text-creation=documentation-tool | |Text-creation=documentation-tool | ||
|Use=text-creation | |Use=text-creation | ||
| Line 73: | Line 90: | ||
{{Software prerequisite | {{Software prerequisite | ||
|Prerequisite kind=Required to use | |Prerequisite kind=Required to use | ||
| − | |Prerequisite description=[[Locale_gettext]] Perl module | + | |Prerequisite description=[[Locale_gettext]] [[Perl]] module |
}} | }} | ||
{{Software prerequisite | {{Software prerequisite | ||
Revision as of 10:04, 6 January 2019
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.
This is a GNU package:help2man
Download
https://ftp.gnu.org/gnu/help2man/help2man-1.49.3.tar.xz
version 1.49.3
(stable)
released on 15 December 2022
OpenPGP signature URL: https://ftp.gnu.org/gnu/help2man/help2man-1.49.3.tar.xz.sig
VCS Checkout
Categories
Licensing
License
Verified by
Verified on
Notes
Leaders and contributors
| Contact(s) | Role |
|---|---|
| Brendan O'Dea | Maintainer |
Resources and communication
| Audience | Resource type | URI |
|---|---|---|
| FTP | Download | https://ftp.gnu.org/gnu/help2man/ |
| Wikidata | General | https://www.wikidata.org/wiki/Q60918168 |
| General | https://translationproject.org/domain/help2man.html | |
| Debian | Developer | https://tracker.debian.org/pkg/help2man |
| FTP | Download | https://ftpmirror.gnu.org/help2man/ |
| Debian | VCS Repository Webview | https://salsa.debian.org/bod/help2man/ |
Software prerequisites
| Kind | Description |
|---|---|
| Required to use | Locale_gettext Perl module |
| Required to use | gettext |
This entry (in part or in whole) was last reviewed on 8 January 2023.
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.