Difference between revisions of "Help2man"

From Free Software Directory
Jump to: navigation, search
m (Is GNU checkbox)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Entry
 
{{Entry
 
|Name=GNU help2man
 
|Name=GNU help2man
|Short description=generate manual pages from program files
+
|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.  
  
 
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://ftp.gnu.org/gnu/help2man/help2man-1.49.3.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
 
|Decommissioned or Obsolete=No
 
|Donate=https://my.fsf.org/donate/
 
|Related projects=Cxref,Texinfo
 
|Keywords=help,documentation,editing,man pages,help2man
 
|Version identifier=1.47.6
 
|Version date=2018/02/28
 
|Version status=stable
 
|Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.47.6.tar.xz
 
|Last review by=Bendikker
 
|Last review date=2018/11/15
 
|Submitted by=Database conversion
 
|Submitted date=2011/04/12
 
|User level=beginner
 
|Paid support=https://www.fsf.org/resources/service/
 
|Accepts cryptocurrency donations=Yes
 
 
|Test entry=No
 
|Test entry=No
 
|Is GNU=Yes
 
|Is GNU=Yes
 
|GNU package identifier=help2man
 
|GNU package identifier=help2man
|Decommissioned/Obsolete=No
 
|License verified date=2010-04-28
 
 
}}
 
}}
 
{{Project license
 
{{Project license
 
|License=GPLv3orlater
 
|License=GPLv3orlater
|License verified by=Bendikker
+
|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.
|License verified date=2018/05/17
+
|License verified by=Genium
 +
|License verified date=2022-02-01
 +
}}
 +
{{Software category
 +
|Interface=command-line
 +
|Programming-language=perl
 +
|Runs-on=BSD, OS X, GNU/Linux
 +
|Text-creation=documentation-tool
 +
|Use=text-creation
 +
|Works-with=text
 +
}}
 +
{{EntryGNU
 +
|Is GNU=Yes
 +
|GNU package identifier=help2man
 +
}}
 +
{{Software prerequisite
 +
|Prerequisite kind=Required to use
 +
|Prerequisite description=[[Locale_gettext]] [[Perl]] module
 +
}}
 +
{{Software prerequisite
 +
|Prerequisite kind=Required to use
 +
|Prerequisite description=[[gettext]]
 
}}
 
}}
 
{{Person
 
{{Person
Line 41: Line 43:
 
}}
 
}}
 
{{Resource
 
{{Resource
|Resource audience=Debian (Ref)
+
|Resource audience=FTP
|Resource URL=https://tracker.debian.org/pkg/help2man
+
|Resource kind=Download
}}
+
|Resource URL=https://ftpmirror.gnu.org/help2man/
{{Resource
 
|Resource kind=VCS Repository Webview
 
|Resource URL=https://salsa.debian.org/bod/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/
 
}}
 
}}
 
{{Resource
 
{{Resource
|Resource kind=Mailing List
+
|Resource audience=Debian
|Resource URL=https://lists.gnu.org/mailman/listinfo/gnu-system-discuss/
+
|Resource kind=VCS Repository Webview
 +
|Resource URL=https://salsa.debian.org/bod/help2man/
 
}}
 
}}
 
{{Resource
 
{{Resource
Line 61: Line 62:
 
}}
 
}}
 
{{Resource
 
{{Resource
 +
|Resource audience=Debian
 +
|Resource kind=Developer
 +
|Resource URL=https://tracker.debian.org/pkg/help2man
 +
}}
 +
{{Resource
 +
|Resource audience=Wikidata
 
|Resource kind=General
 
|Resource kind=General
|Resource URL=https://translationproject.org/domain/help2man-texi.html
+
|Resource URL=https://www.wikidata.org/wiki/Q60918168
 
}}
 
}}
{{Software category
+
{{EntryDetails
|Documentation-tool=documentation-conversion
+
|Is High Priority Project=No
|Interface=command-line
+
|VCS checkout command=git clone https://salsa.debian.org/bod/help2man.git
|Programming-language=perl
+
|Computer languages=Perl
|Use=text-creation
+
|Decommissioned or Obsolete=No
|Works-with=text
+
|Version identifier=1.49.3
}}
+
|Version date=2022-12-15
{{Software prerequisite
+
|Version status=stable
|Prerequisite kind=Required to use
+
|Last review by=Genium
|Prerequisite description=[[Locale_gettext]] Perl module
+
|Last review date=2023-01-08
}}
+
|Accepts cryptocurrency donations=No
{{Software prerequisite
+
|OpenPGP signature=https://ftp.gnu.org/gnu/help2man/help2man-1.49.3.tar.xz.sig
|Prerequisite kind=Required to use
+
|Test entry=No
|Prerequisite description=[[gettext]]
 
 
}}
 
}}
 
{{Featured}}
 
{{Featured}}

Latest revision as of 05:22, 8 January 2023


[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.