Difference between revisions of "Help2man"

From Free Software Directory
Jump to: navigation, search
m (Text replacement - "'''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 Introdu...)
(help2man-1.48.5)
Line 6: Line 6:
 
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.
 
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.
 
|Homepage URL=https://www.gnu.org/software/help2man/
 
|Homepage URL=https://www.gnu.org/software/help2man/
|Is High Priority Project=No
+
|Version download=https://ftpmirror.gnu.org/help2man/help2man-1.48.5.tar.xz
|VCS checkout command=git clone https://salsa.debian.org/bod/help2man.git
+
}}
|Documentation note=https://www.gnu.org/prep/standards/standards.html#Man-Pages
+
{{Project license
 
+
|License=GPLv3orlater
 
+
|License copyright=Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021 Free Software Foundation, Inc.
|Decommissioned or Obsolete=No
+
|License verified by=Genium
|Donate=https://my.fsf.org/donate/
+
|License verified date=2022-02-01
|Related projects=gnustandards,Cxref,Texinfo
+
}}
|Keywords=help,documentation,editing,man pages,help2man
+
{{Software category
|Version identifier=1.47.12
+
|Interface=command-line
|Version date=2020/01/04
+
|Programming-language=perl
|Version status=stable
+
|Runs-on=BSD, OS X, GNU/Linux
|Version download=https://ftpmirror.gnu.org/help2man/help2man-1.47.12.tar.xz
+
|Text-creation=documentation-tool
|Last review by=Genium
+
|Use=text-creation
|Last review date=2020/01/16
+
|Works-with=text
|Submitted by=Database conversion
+
}}
|Submitted date=2011/04/01
+
{{EntryGNU
|User level=beginner
 
|Paid support=https://www.fsf.org/resources/service/
 
|Accepts cryptocurrency donations=Yes
 
|OpenPGP signature=https://ftpmirror.gnu.org/help2man/help2man-1.47.12.tar.xz.sig
 
|Test entry=No
 
 
|Is GNU=Yes
 
|Is GNU=Yes
 
|GNU package identifier=help2man
 
|GNU package identifier=help2man
 
}}
 
}}
{{Project license
+
{{Software prerequisite
|License=GPLv3orlater
+
|Prerequisite kind=Required to use
|License verified by=Bendikker
+
|Prerequisite description=[[Locale_gettext]] [[Perl]] module
|License verified date=2018/05/17
+
}}
 +
{{Software prerequisite
 +
|Prerequisite kind=Required to use
 +
|Prerequisite description=[[gettext]]
 
}}
 
}}
 
{{Person
 
{{Person
Line 42: Line 40:
 
}}
 
}}
 
{{Resource
 
{{Resource
|Resource audience=Debian (Ref)
+
|Resource audience=FTP
|Resource URL=https://tracker.debian.org/pkg/help2man
 
}}
 
{{Resource
 
|Resource kind=VCS Repository Webview
 
|Resource URL=https://salsa.debian.org/bod/help2man/
 
}}
 
{{Resource
 
 
|Resource kind=Mailing List
 
|Resource kind=Mailing List
|Resource URL=https://lists.gnu.org/mailman/listinfo/gnu-system-discuss/
+
|Resource URL=https://ftpmirror.gnu.org/help2man/
 
}}
 
}}
 
{{Resource
 
{{Resource
 +
|Resource audience=FTP
 
|Resource kind=Download
 
|Resource kind=Download
 
|Resource URL=https://ftp.gnu.org/gnu/help2man/
 
|Resource URL=https://ftp.gnu.org/gnu/help2man/
Line 62: Line 54:
 
}}
 
}}
 
{{Resource
 
{{Resource
|Resource kind=General
+
|Resource audience=Debian
|Resource URL=https://translationproject.org/domain/help2man-texi.html
+
|Resource kind=VCS Repository Webview
 +
|Resource URL=https://salsa.debian.org/bod/help2man/
 
}}
 
}}
{{Software category
+
{{Resource
|Interface=command-line
+
|Resource audience=Debian
|Programming-language=perl
+
|Resource kind=Developer
|Runs-on=GNU/Linux
+
|Resource URL=https://tracker.debian.org/pkg/help2man
|Text-creation=documentation-tool
 
|Use=text-creation
 
|Works-with=text
 
 
}}
 
}}
{{Software prerequisite
+
{{Resource
|Prerequisite kind=Required to use
+
|Resource audience=Wikidata
|Prerequisite description=[[Locale_gettext]] [[Perl]] module
+
|Resource kind=General
 +
|Resource URL=https://www.wikidata.org/wiki/Q60918168
 
}}
 
}}
{{Software prerequisite
+
{{EntryDetails
|Prerequisite kind=Required to use
+
|Is High Priority Project=No
|Prerequisite description=[[gettext]]
+
|Decommissioned or Obsolete=No
 +
|Accepts cryptocurrency donations=No
 +
|Test entry=No
 
}}
 
}}
 
{{Featured}}
 
{{Featured}}

Revision as of 18:05, 1 February 2022


[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
















"FTP" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.


"FTP" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.




"Debian" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.


"Debian" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.


"Wikidata" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.



Property "Submitted by" (as page type) with input value "{{{Submitted by}}}" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process. "{{{Submitted date}}}" contains an extrinsic dash or other characters that are invalid for a date interpretation.








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.