Difference between revisions of "Help2man"

From Free Software Directory
Jump to: navigation, search
m (new release)
m (Is GNU checkbox)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{Entry
 
{{Entry
−
|Name=Help2man
+
|Name=GNU help2man
−
|Short description=Generates manual pages from program files
+
|Short description=Generate 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.  
−
|Homepage URL=https://www.gnu.org/software/help2man
+
 
−
|User level=none
+
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.
−
|Computer languages=Perl
+
|Homepage URL=https://www.gnu.org/software/help2man/
−
|Documentation note=User guide included
+
|Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.49.3.tar.xz
−
|Related projects=Cxref,Texinfo
+
|Test entry=No
−
|Keywords=help,documentation,editing,man pages,help2man
 
−
|Version identifier=1.44.1
 
−
|Version date=2014/02/01
 
−
|Version status=stable
 
−
|Version download=https://ftp.gnu.org/gnu/help2man/help2man-1.44.1.tar.xz
 
−
|Last review by=Genium
 
−
|Last review date=2014/03/01
 
−
|Submitted by=Database conversion
 
−
|Submitted date=2011-04-01
 
−
|Status=
 
 
|Is GNU=Yes
 
|Is GNU=Yes
 
|GNU package identifier=help2man
 
|GNU package identifier=help2man
−
|License verified date=2010-04-28
 
 
}}
 
}}
 
{{Project license
 
{{Project license
−
|License=GPLv3
+
|License=GPLv3orlater
−
|License verified by=arca0
+
|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=2012/09/08
+
|License verified by=Genium
−
}}
+
|License verified date=2022-02-01
−
{{Person
 
−
|Real name=Brendan O'Dea
 
−
|Role=Maintainer
 
−
|Email=bod@debian.org
 
−
|Resource URL=
 
−
}}
 
−
{{Person
 
−
|Real name=See the THANKS file in the distribution for a complete list
 
−
|Role=Contributor
 
−
|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
 +
|Programming-language=perl
 +
|Runs-on=BSD, OS X, GNU/Linux
 
|Text-creation=documentation-tool
 
|Text-creation=documentation-tool
 
|Use=text-creation
 
|Use=text-creation
 
|Works-with=text
 
|Works-with=text
 +
}}
 +
{{EntryGNU
 +
|Is GNU=Yes
 +
|GNU package identifier=help2man
 
}}
 
}}
 
{{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
 
|Prerequisite kind=Required to use
 
|Prerequisite kind=Required to use
−
|Prerequisite description=gettext
+
|Prerequisite description=[[gettext]]
 +
}}
 +
{{Person
 +
|Real name=Brendan O'Dea
 +
|Role=Maintainer
 +
|Email=bod@debian.org
 +
}}
 +
{{Resource
 +
|Resource audience=FTP
 +
|Resource kind=Download
 +
|Resource URL=https://ftpmirror.gnu.org/help2man/
 +
}}
 +
{{Resource
 +
|Resource audience=FTP
 +
|Resource kind=Download
 +
|Resource URL=https://ftp.gnu.org/gnu/help2man/
 +
}}
 +
{{Resource
 +
|Resource audience=Debian
 +
|Resource kind=VCS Repository Webview
 +
|Resource URL=https://salsa.debian.org/bod/help2man/
 +
}}
 +
{{Resource
 +
|Resource kind=General
 +
|Resource URL=https://translationproject.org/domain/help2man.html
 +
}}
 +
{{Resource
 +
|Resource audience=Debian
 +
|Resource kind=Developer
 +
|Resource URL=https://tracker.debian.org/pkg/help2man
 +
}}
 +
{{Resource
 +
|Resource audience=Wikidata
 +
|Resource kind=General
 +
|Resource URL=https://www.wikidata.org/wiki/Q60918168
 +
}}
 +
{{EntryDetails
 +
|Is High Priority Project=No
 +
|VCS checkout command=git clone https://salsa.debian.org/bod/help2man.git
 +
|Computer languages=Perl
 +
|Decommissioned or Obsolete=No
 +
|Version identifier=1.49.3
 +
|Version date=2022-12-15
 +
|Version status=stable
 +
|Last review by=Genium
 +
|Last review date=2023-01-08
 +
|Accepts cryptocurrency donations=No
 +
|OpenPGP signature=https://ftp.gnu.org/gnu/help2man/help2man-1.49.3.tar.xz.sig
 +
|Test entry=No
 
}}
 
}}
 
{{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.

Heckert gnu.small.png 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

License

GPLv3orlater

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.

Retrieved from "https://directory.fsf.org/wiki?title=Help2man&oldid=88670"