[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
www/software/help2man help2man.html
|
From: |
Karl Berry |
|
Subject: |
www/software/help2man help2man.html |
|
Date: |
Sun, 29 May 2011 22:12:30 +0000 |
CVSROOT: /web/www
Module name: www
Changes by: Karl Berry <karl> 11/05/29 22:12:30
Modified files:
software/help2man: help2man.html
Log message:
new version
CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/software/help2man/help2man.html?cvsroot=www&r1=1.4&r2=1.5
Patches:
Index: help2man.html
===================================================================
RCS file: /web/www/www/software/help2man/help2man.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- help2man.html 22 Aug 2002 21:29:05 -0000 1.4
+++ help2man.html 29 May 2011 22:12:27 -0000 1.5
@@ -1,152 +1,217 @@
-<!doctype HTML public "-//IETF//DTD HTML 2.0//EN">
+<!-- Parent-Version: 1.55 -->
-<html>
-<head>
-<title>help2man - GNU Project - Free Software Foundation (FSF)</title>
-<link rev="made" href="mailto:address@hidden";>
-<META NAME="keywords" CONTENT="help2man">
-</head>
-
-<body bgcolor="#FFFFFF" text="#000000" link="#1F00FF" alink="#FF0000"
- vlink="#9900DD">
-
-<h3>help2man</h3>
-<a href="/graphics/agnuhead.html"><img src="/graphics/gnu-head-sm.jpg"
- alt=" [image of the Head of a GNU] " width="129" height="122"></a>
+<!--#include virtual="/server/header.html" -->
+<title>help2man - GNU Project - Free Software Foundation</title>
+<!--#include virtual="/server/banner.html" -->
-<hr>
-<h4>Table of contents</h4>
-<ul>
- <li><a href="#overview" name="TOCoverview">Overview</a>
- <li><a href="#invoking" name="TOCinvoking">Invoking <em>help2man</em></a>
- <li><a href="#include" name="TOCinclude">Including text</a>
- <li><a href="#example" name="TOCexample">Example</a>
- <li><a href="#download" name="TOCdownload">Downloading help2man</a>
-</ul>
+<h2 class="settitle">`help2man' Reference Manual</h2>
+<a name="Top"></a>
-<hr>
-<h4><a href="#TOCoverview" name="overview">Overview</a></h4>
-<p><em>help2man</em> is a tool for automatically generating simple
-manual pages from program output.</p>
+<h3 class="unnumbered"><samp><span class="command">help2man</span></samp></h3>
-<p>It is intended to provide an easy way for software authors to
-include a manual page in their distribution without having to maintain
-that document.</p>
+<p><samp><span class="command">help2man</span></samp> produces simple manual
pages from the ‘<samp><span class="samp">--help</span></samp>’
+and ‘<samp><span class="samp">--version</span></samp>’ output of
other commands.
-<p>Given a program which produces resonably standard <tt>--help</tt>
-and <tt>--version</tt> outputs, <em>help2man</em> will attempt to
-re-arrange that output into something which resembles a manual
-page.</p>
+<p><a name="Overview"></a>
-<h4><a href="#TOCinvoking" name="invoking">Invoking <em>help2man</em></a></h4>
-<p>The format for running the <code>help2man</code> program is:
+<h3 class="chapter">Overview of <samp><span
class="command">help2man</span></samp></h3>
-<pre>
- <code>help2man</code> [<var>option</var>]... <var>executable</var>
-</pre>
+<p><samp><span class="command">help2man</span></samp> is a tool for
automatically generating simple
+manual pages from program output.
+
+ <p>Although manual pages are optional for GNU programs other projects,
+such as Debian require them (see <a
href="http://www.gnu.org/prep/standards/standards.html#Man-Pages";>Man Pages</a>)
+
+ <p>This program is intended to provide an easy way for software authors
+to include a manual page in their distribution without having to
+maintain that document.
+
+ <p>Given a program which produces reasonably standard ‘<samp><span
class="samp">--help</span></samp>’ and
+‘<samp><span class="samp">--version</span></samp>’ outputs,
<samp><span class="command">help2man</span></samp> can re-arrange that
+output into something which resembles a manual page.
+
+<p><a name="Invoking-help2man"></a>
-<code>help2man</code> supports the following options:
+<h3 class="chapter">How to Run <samp><span
class="command">help2man</span></samp></h3>
-<dl>
-<dt><samp>-n <var>string</var></samp>
-<dt><samp>--name=<var>string</var></samp>
-<dd>Use <var>string</var> as the description for the <samp>NAME</samp>
paragraph of
+<p>The format for running the <samp><span
class="command">help2man</span></samp> program is:
+
+<pre class="example"> <samp><span class="command">help2man</span></samp>
[<var>option</var>]... <var>executable</var>
+</pre>
+ <p><samp><span class="command">help2man</span></samp> supports the
following options:
+
+ <dl>
+<dt>‘<samp><span class="samp">-n
</span><var>string</var></samp>’<dt>‘<samp><span
class="samp">--name=</span><var>string</var></samp>’<dd>Use
<var>string</var> as the description for the ‘<samp><span
class="samp">NAME</span></samp>’ paragraph of
the manual page.
-<p>By default (for want of anything better) this paragraph contains
-<samp>manual page for <var>program</var> <var>version</var></samp>.
+ <p>By default (for want of anything better) this paragraph contains
+‘<samp><span class="samp">manual page for </span><var>program</var>
<var>version</var></samp>’.
-<p>This option overrides an include file <samp>[name]</samp> section
-(see <a href="#include">Including text</a>).
+ <p>This option overrides an include file ‘<samp><span
class="samp">[name]</span></samp>’ section
+(see <a href="#Including-text">Including text</a>).
-<dt><samp>-s <var>section</var></samp>
-<dt><samp>--section <var>section</var></samp>
-<dd>Use <var>section</var> as the section for the man page. The default
+ <br><dt>‘<samp><span class="samp">-s
</span><var>section</var></samp>’<dt>‘<samp><span
class="samp">--section </span><var>section</var></samp>’<dd>Use
<var>section</var> as the section for the man page. The default
section is 1.
-<dt><samp>-m <var>manual</var></samp>
-<dt><samp>--manual=<var>manual</var></samp>
-<dd>Set the name of the manual section to <var>section</var>, used as a centred
-heading for the manual page. By default <samp>User Commands</samp> is used
-for pages in section 1, <samp>Games</samp> for section 6 and @samp{System
-Administration Utilities} for sections 8 and 1M.
-
-<dt><samp>-S <var>source</var></samp>
-<dt><samp>--source=<var>source</var></samp>
-<dd>The program source is used as a page footer, and often contains the name
+ <br><dt>‘<samp><span class="samp">-m
</span><var>manual</var></samp>’<dt>‘<samp><span
class="samp">--manual=</span><var>manual</var></samp>’<dd>Set the name of
the manual section to <var>section</var>, used as a centred
+heading for the manual page. By default ‘<samp><span class="samp">User
Commands</span></samp>’ is used
+for pages in section 1, ‘<samp><span
class="samp">Games</span></samp>’ for section 6 and ‘<samp><span
class="samp">System
+Administration Utilities</span></samp>’ for sections 8 and 1M.
+
+ <br><dt>‘<samp><span class="samp">-S
</span><var>source</var></samp>’<dt>‘<samp><span
class="samp">--source=</span><var>source</var></samp>’<dd>The program
source is used as a page footer, and often contains the name
of the organisation or a suite of which the program is part. By default
the value is the package name and version.
-<dt><samp>-i <var>file</var></samp>
-<dt><samp>--include=<var>file</var></samp>
-<dd>Include material from <var>file</var> (see <a href="#include">Including
text</a>).
-
-<dt><samp>-I <var>file</var></samp>
-<dt><samp>--opt-include=<var>file</var></samp>
-<dd>A variant of <samp>--include</samp> for use in Makefile pattern rules which
+ <br><dt>‘<samp><span class="samp">-L
</span><var>locale</var></samp>’<dt>‘<samp><span
class="samp">--locale=</span><var>locale</var></samp>’<dd>Select output
locale (default ‘<samp><span class="samp">C</span></samp>’). Both
the program and
+<samp><span class="command">help2man</span></samp> must support the given
<var>locale</var>
+(see <a href="#Localised-man-pages">Localised man pages</a>).
+
+ <br><dt>‘<samp><span class="samp">-i
</span><var>file</var></samp>’<dt>‘<samp><span
class="samp">--include=</span><var>file</var></samp>’<dd>Include material
from <var>file</var> (see <a href="#Including-text">Including text</a>).
+
+ <br><dt>‘<samp><span class="samp">-I
</span><var>file</var></samp>’<dt>‘<samp><span
class="samp">--opt-include=</span><var>file</var></samp>’<dd>A variant of
‘<samp><span class="samp">--include</span></samp>’ for use in
Makefile pattern rules which
does not require <var>file</var> to exist.
-<dt><samp>-o <var>file</var></samp>
-<dt><samp>--output=<var>file</var></samp>
-<dd>Send output to <var>file</var> rather than <code>stdout</code>.
-
-<dt><samp>-N</samp>
-<dt><samp>--no-info</samp>
-<dd>Suppress inclusion of a <samp>SEE ALSO</samp> paragraph directing the
reader
+ <br><dt>‘<samp><span class="samp">-o
</span><var>file</var></samp>’<dt>‘<samp><span
class="samp">--output=</span><var>file</var></samp>’<dd>Send output to
<var>file</var> rather than <code>stdout</code>.
+
+ <br><dt>‘<samp><span class="samp">-p
</span><var>text</var></samp>’<dt>‘<samp><span
class="samp">--info-page=</span><var>text</var></samp>’<dd>Name of
Texinfo manual.
+
+ <br><dt>‘<samp><span
class="samp">-N</span></samp>’<dt>‘<samp><span
class="samp">--no-info</span></samp>’<dd>Suppress inclusion of a
‘<samp><span class="samp">SEE ALSO</span></samp>’ paragraph
directing the reader
to the Texinfo documentation.
-<dt><samp>--help</samp>
-<dt><samp>--version</samp>
-<dd>Show help or version information.
+ <br><dt>‘<samp><span
class="samp">-l</span></samp>’<dt>‘<samp><span
class="samp">--libtool</span></samp>’<dd>Drop <samp><span
class="file">lt-</span></samp> prefix from instances of the program name in the
+synopsis (<samp><span class="command">libtool</span></samp> creates wrapper
scripts in the build
+directory which invoke <samp><span class="command">foo</span></samp> as
<samp><span class="command">.libs/lt-foo</span></samp>).
+
+ <br><dt>‘<samp><span
class="samp">--help</span></samp>’<dt>‘<samp><span
class="samp">--version</span></samp>’<dd>Show help or version
information.
</dl>
-By default <code>help2man</code> passes the standard <samp>--help</samp> and
-<samp>--version</samp> options to the executable although alternatives may
+ <p>By default <samp><span class="command">help2man</span></samp> passes the
standard ‘<samp><span class="samp">--help</span></samp>’ and
+‘<samp><span class="samp">--version</span></samp>’ options to the
executable although alternatives may
be specified using:
-<dl>
-<dt><samp>-h <var>option</var></samp>
-<dt><samp>--help-option=<var>option</var></samp>
-<dd>help option string
-
-<dt><samp>-v <var>option</var></samp>
-<dt><samp>--version-option=<var>option</var></samp>
-<dd>version option string
+ <dl>
+<dt>‘<samp><span class="samp">-h
</span><var>option</var></samp>’<dt>‘<samp><span
class="samp">--help-option=</span><var>option</var></samp>’<dd>Help
option string.
+
+ <br><dt>‘<samp><span class="samp">-v
</span><var>option</var></samp>’<dt>‘<samp><span
class="samp">--version-option=</span><var>option</var></samp>’<dd>Version
option string.
+
+ <br><dt>‘<samp><span
class="samp">--version-string=</span><var>string</var></samp>’<dd>Version
string.
+
+ <br><dt>‘<samp><span
class="samp">--no-discard-stderr</span></samp>’<dd>Include stderr when
parsing option output.
</dl>
-<h4><a href="#TOCinclude" name="include">Including text</a></h4>
+<p><a name="--help-recommendations"></a>
+<a name="g_t_002d_002dhelp-recommendations"></a>
+
+<h3 class="chapter"><samp><span class="option">--help</span></samp>
Recommendations</h3>
+
+<p>Here are some recommendations for what to include in your
+<samp><span class="option">--help</span></samp> output. Including these gives
<samp><span class="command">help2man</span></samp> the
+best chance at generating a respectable man page, as well as
+benefitting users directly.
+
+ <p>See <a
href="http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces";>Command-Line
Interfaces</a>,
+and <a href="http://www.gnu.org/prep/standards/standards.html#Man-Pages";>Man
Pages</a>, for the
+official GNU standards relating to <samp><span
class="option">--help</span></samp> and man pages.
+
+ <ul>
+<li>A synopsis of how to invoke the program. If different usages of the
+program have different invocations, then list them all. For example
+(edited for brevity):
+
+ <pre class="smallexample"> Usage: cp [OPTION]... SOURCE DEST
+ or: cp [OPTION]... SOURCE... DIRECTORY
+ ...
+</pre>
+ <p>Use <code>argv[0]</code> for the program name in these synopses, just
as it
+is, with no directory stripping. This is in contrast to the canonical
+(constant) name of the program which is used in <samp><span
class="option">--version</span></samp>.
+
+ <li>A very brief explanation of what the program does, including default
+and/or typical behaviour. For example, here is <samp><span
class="command">cp</span></samp>'s:
+
+ <pre class="example"> Copy SOURCE to DEST, or multiple SOURCE(s)
to DIRECTORY.
+</pre>
+ <li>A list of options, indented to column 2. If the program supports
+one-character options, put those first, then the equivalent long option
+(if any). If the option takes an argument, include that too, giving it
+a meaningful name. Align the descriptions in a convenient column, if
+desired. Note that to be correctly recognised by <samp><span
class="command">help2man</span></samp>
+the description must be separated from the options by at least two
+spaces and descriptions continued on subsequent lines must start at
+the same column.
+
+ <p>Here again is an (edited) excerpt from <samp><span
class="command">cp</span></samp>, showing a short
+option with an equivalent long option, a long option only, and a short
+option only:
+
+ <pre class="smallexample"> -a, --archive same
as -dpR
+ --backup[=CONTROL] make a backup of each ...
+ -b like --backup but ...
+</pre>
+ <p>For programs that take many options, it may be desirable to split the
+option list into sections such as `Global', `Output control', or
+whatever makes sense in the particular case. It is usually best to
+alphabetise (by short option name first, then long) within each section,
+or the entire list if there are no sections.
+
+ <li>Any useful additional information about program behaviour, such as
+influential environment variables, further explanation of options, etc.
+For example, <samp><span class="command">cp</span></samp> discusses
<samp><span class="env">VERSION_CONTROL</span></samp> and sparse
+files.
+
+ <li>A few examples of typical usage, at your discretion. One good example
+is usually worth a thousand words of description, so this is
+highly recommended.
+
+ <li><a name="index-address-for-bug-reports-1"></a><a
name="index-bug-reports-2"></a>In closing, a line stating how to email bug
reports. Typically,
+<var>mailing-address</var> will be ‘<samp><span
class="samp">bug-</span><var>program</var><span
class="samp">@gnu.org</span></samp>’; please
+use this form for GNU programs whenever possible. It's also good to
+mention the home page of the program, other mailing lists, etc.
+
+ </ul>
+
+ <p>The <code>argp</code> and <code>popt</code> programming interfaces let
you specify
+option descriptions for <samp><span class="option">--help</span></samp> in the
same structure as the
+rest of the option definition; you may wish to consider using these
+routines for option parsing instead of <code>getopt</code>.
+
+<p><a name="Including-text"></a>
+
+<h3 class="chapter">Including Additional Text in the Output</h3>
+
<p>Additional static text may be included in the generated manual page by
-using the <samp>--include</samp> and <samp>--opt-include</samp> options
-(see <a href="#invoking">Invoking help2man</a>).
+using the ‘<samp><span class="samp">--include</span></samp>’ and
‘<samp><span class="samp">--opt-include</span></samp>’ options
+(see <a href="#Invoking-help2man">Invoking help2man</a>). While these files
can be named anything,
+for consistency we suggest to use the extension <code>.h3m</code> for
+help2man include files.
-<p>The format for files included with these option is simple:
+ <p>The format for files included with these option is simple:
-<pre>
- [section]
+<pre class="example"> [section]
text
/pattern/
text
</pre>
+ <p>Blocks of verbatim *roff text are inserted into the output either at
+the start of the given ‘<samp><span
class="samp">[section]</span></samp>’ (case insensitive), or after a
+paragraph matching ‘<samp><span
class="samp">/pattern/</span></samp>’.
-Blocks of verbatim *roff text are inserted into the output either at
-the start of the given <samp>[section]</samp> (case insensitive), or after a
-paragraph matching <samp>/pattern/</samp>.
-
-<p>Patterns use the Perl regular expression syntax and may be followed by
-the <samp>i</samp>, <samp>s</samp> or <samp>m</samp> modifiers (see The
<code>perlre(1)</code> manual page)
+ <p>Patterns use the Perl regular expression syntax and may be followed by
+the ‘<samp><span class="samp">i</span></samp>’, ‘<samp><span
class="samp">s</span></samp>’ or ‘<samp><span
class="samp">m</span></samp>’ modifiers (see <a
href="http://perldoc.perl.org/perlre.html"#perlre";>perlre(1)</a>)
-<p>Lines before the first section or pattern which begin with <samp>-</samp>
+ <p>Lines before the first section or pattern which begin with
‘<samp><span class="samp">-</span></samp>’
are processed as options. Anything else is silently ignored and may
be used for comments, RCS keywords and the like.
-<p>The section output order is:
+ <p>The section output order (for those included) is:
-<pre>
- NAME
+<pre class="example"> NAME
SYNOPSIS
DESCRIPTION
OPTIONS
+ ENVIRONMENT
+ FILES
EXAMPLES
<em>other</em>
AUTHOR
@@ -154,25 +219,102 @@
COPYRIGHT
SEE ALSO
</pre>
-
-Any <samp>[name]</samp> or <samp>[synopsis]</samp> sections appearing in the
+ <p>Any ‘<samp><span class="samp">[name]</span></samp>’ or
‘<samp><span class="samp">[synopsis]</span></samp>’ sections
appearing in the
include file will replace what would have automatically been produced
-(although you can still override the former with <samp>--name</samp> if
+(although you can still override the former with ‘<samp><span
class="samp">--name</span></samp>’ if
required).
-<p>Other sections are prepended to the automatically produced output for
+ <p>Other sections are prepended to the automatically produced output for
the standard sections given above, or included at <em>other</em> (above)
in the order they were encountered in the include file.
-<h4><a href="#TOCexample" name="example">Example</a></h4>
-<p>Given a hypothetical program <em>foo</em> which produces the
-following output:</p>
+<p><a name="Makefile-usage"></a>
+
+<h3 class="chapter">Using <samp><span class="command">help2man</span></samp>
With <samp><span class="command">make</span></samp></h3>
+
+<p>A suggested use of <samp><span class="command">help2man</span></samp> in
Makefiles is to have the
+manual page depend not on the binary, but on the source file(s) in
+which the ‘<samp><span class="samp">--help</span></samp>’ and
‘<samp><span class="samp">--version</span></samp>’ output are
defined.
+
+ <p>This usage allows a manual page to be generated by the maintainer and
+included in the distribution without requiring the end-user to have
+<samp><span class="command">help2man</span></samp> installed.
-<pre>
- <strong>$ foo --version</strong>
+ <p>An example rule for the program <code>prog</code> could be:
+
+<pre class="example"> prog.1: $(srcdir)/main.c
+ -$(HELP2MAN) --output=$@ --name='an example program' ./prog
+</pre>
+ <p>The value of <code>HELP2MAN</code> may be set in
<code>configure.in</code> using
+either of:
+
+<pre class="example"> AM_MISSING_PROG(HELP2MAN, help2man, $missing_dir)
+</pre>
+ <p>for <samp><span class="command">automake</span></samp>, or something
like:
+
+<pre class="example"> AC_PATH_PROG(HELP2MAN, help2man, false // No
help2man //)
+</pre>
+ <p>for <samp><span class="command">autoconf</span></samp> alone.
+
+<p><a name="Localised-man-pages"></a>
+
+<h3 class="chapter">Producing Native Language Manual Pages</h3>
+
+<p>Manual pages may be produced for any locale supported by both the
+program and <samp><span class="command">help2man</span></samp><a
rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> with the
‘<samp><span class="samp">--locale</span></samp>’
(‘<samp><span class="samp">-L</span></samp>’)
+option.
+
+<pre class="example"> help2man -L address@hidden -o cp.fr.1 cp
+</pre>
+ <h4 class="section">Changing the Location of Message Catalogs</h4>
+
+<p>When creating localised manual pages from a program's build directory it
+is probable that the translations installed in the standard location
+will not be (if installed at all) correct for the version of the
+program being built.
+
+ <p>A preloadable library is provided with <samp><span
class="command">help2man</span></samp> which will
+intercept <code>bindtextdomain</code> calls configuring the location of message
+catalogs for the domain given by <samp><span
class="env">$TEXTDOMAIN</span></samp> and override the
+location to the path given by <samp><span class="env">$LOCALEDIR</span></samp>.
+
+ <p>So for example:
+
+<pre class="example"> mkdir -p tmp/fr/LC_MESSAGES
+ cp po/fr.gmo tmp/fr/LC_MESSAGES/<var>prog</var>.mo
+ LD_PRELOAD="/usr/lib/help2man/bindtextdomain.so" \
+ LOCALEDIR=tmp \
+ TEXTDOMAIN=<var>prog</var> \
+ help2man -L address@hidden -i <var>prog</var>.fr.h3m -o
<var>prog</var>.fr.1 <var>prog</var>
+ rm -rf tmp
+</pre>
+ <p>will cause <var>prog</var> to load the message catalog from
‘<samp><span class="samp">tmp</span></samp>’
+rather than ‘<samp><span
class="samp">/usr/share/locale</span></samp>’.
+
+ <p>Notes:
+ <ul>
+<li>The generalisation of ‘<samp><span
class="samp">address@hidden</span></samp>’ to ‘<samp><span
class="samp">fr</span></samp>’ in the example
+above is done by <code>gettext</code>, if a more specific match were available
+it would also have been re-mapped.
+
+ <li>This preload has only been tested against <samp><span
class="command">eglibc</span></samp> 2.11.2 and
+<samp><span class="command">gettext</span></samp> 0.18.1.1 on a GNU/Linux
system; let me know if it
+does (or doesn't) work for you (see <a href="#Reports">Reports</a>).
+</ul>
+
+<p><a name="Example"></a>
+
+<h3 class="chapter">Example <samp><span class="command">help2man</span></samp>
Output</h3>
+
+<p>Given a hypothetical program <samp><span class="command">foo</span></samp>
which produces the following output:
+
+<!-- Default values strong/em to be used in Examples, these are -->
+<!-- overridden for info, which doesn't have real bold/italic. -->
+<!-- No-op version for info: -->
+<pre class="example"> <strong>$ foo --version</strong>
GNU foo 1.1
- Copyright (C) 1999 Free Software Foundation, Inc.
+ Copyright (C) 2011 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@@ -197,23 +339,21 @@
Report bugs to <address@hidden>.
</pre>
+ <p><samp><span class="command">help2man</span></samp> will produce
<samp><span class="command">nroff</span></samp> input for a manual
+page which will be formatted something like this:
-<p><em>help2man</em> will produce nroff for a manual page which will
-be formatted something like this:</p>
-
-<pre>
- FOO(1) FSF FOO(1)
+<pre class="example"> FOO(1) User Commands
FOO(1)
<strong>NAME</strong>
foo - manual page for foo 1.1
<strong>SYNOPSIS</strong>
- <strong>foo</strong> [<em>OPTION</em>]...
+ foo [OPTION]...
<strong>DESCRIPTION</strong>
- GNU `foo' does nothing interesting except serve as an
- example for `help2man'.
+ GNU `foo' does nothing interesting except serve as an example for
+ `help2man'.
<strong>OPTIONS</strong>
<strong>-a</strong>, <strong>--option</strong>
@@ -240,53 +380,134 @@
Report bugs to <address@hidden>.
<strong>COPYRIGHT</strong>
- Copyright (C) 1999 Free Software Foundation, Inc.
- This is free software; see the source for copying condi-
- tions. There is NO warranty; not even for MERCHANTABILITY
- or FITNESS FOR A PARTICULAR PURPOSE.
+ Copyright © 2011 Free Software Foundation, Inc.
+ This is free software; see the source for copying conditions.
+ There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
+ PARTICULAR PURPOSE.
<strong>SEE ALSO</strong>
- The full documentation for <strong>foo</strong> is maintained as a
Texinfo
- manual. If the <strong>info</strong> and <strong>foo</strong>
programs are properly
- installed at your site, the command
+ The full documentation for <strong>foo</strong> is maintained as a
Texinfo manual.
+ If the <strong>info</strong> and <strong>foo</strong> programs
are properly installed at your site,
+ the command
<strong>info foo</strong>
should give you access to the complete manual.
-
- GNU foo 1.1 December 1999 1
+ foo 1.1 May 2011 FOO(1)
</pre>
+ <p><a name="Reports"></a>
-<h4><a href="#TOCdownload" name="download">Downloading
-<em>help2man</em></a></h4>
-<p><em>help2man</em> can be found on
-<a href="http://ftp.gnu.org/gnu/help2man/";>http://ftp.gnu.org/gnu/help2man/</a>
-or one of <a href="/prep/ftp.html">the mirrors</a>.</p>
+<h3 class="chapter">Reporting Bugs or Suggestions</h3>
-<hr>
-Return to <a href="/home.html">GNU's home page</a>.
+<p>If you find problems or have suggestions about this program or
+manual, please report them to <a
href="mailto:address@hidden";>address@hidden</a>.
-<p>Please send FSF & GNU inquiries & questions to
-<a href="mailto:address@hidden";><em>address@hidden</em></a>.
-There are also <a href="/home.html#ContactInfo">other ways to contact</a>
-the FSF.</p>
-
-<p>Please send comments on these web pages to
-<a href="mailto:address@hidden";><em>address@hidden</em></a>,
-send other questions to <a
href="mailto:address@hidden";><EM>address@hidden</em></a>.
+ <p>Note to translators: Translations are handled though the
+<a href="http://translationproject.org/";>Translation Project</a> see
+<a
href="http://translationproject.org/html/translators.html";>http://translationproject.org/html/translators.html</a>
for details.
-<p>Copyright (C) 1999 Free Software Foundation, Inc.,
-59 Temple Place - Suite 330, Boston, MA 02111, USA</p>
+<p><a name="Availability"></a>
-<p>Verbatim copying and distribution of this entire article is
-permitted in any medium, provided this notice is preserved.</p>
+<h3 class="chapter">Obtaining <samp><span
class="command">help2man</span></samp></h3>
-<p>Updated:
-<!-- hhmts start -->
-03 Dec 2001 bod
-<!-- hhmts end -->
+<p>The latest version of this distribution is available online from GNU
+mirrors:
+
+<pre class="example"> <a
href="http://ftpmirror.gnu.org/help2man/";>http://ftpmirror.gnu.org/help2man/</a>
+</pre>
+ <p>If automatic redirection fails, the list of mirrors is at:
+
+<pre class="example"> <a
href="http://www.gnu.org/order/ftp.html";>http://www.gnu.org/order/ftp.html</a>
+</pre>
+ <p>Or if need be you can use the main GNU ftp server:
+<pre class="example"> <a
href="http://ftp.gnu.org/gnu/help2man/";>http://ftp.gnu.org/gnu/help2man/</a>
+</pre>
+ <div class="contents">
+<h3>Table of Contents</h3>
+<ul>
+<li><a name="toc_Top" href="#Top"><samp><span
class="command">help2man</span></samp></a>
+<li><a name="toc_Overview" href="#Overview">Overview of <samp><span
class="command">help2man</span></samp></a>
+<li><a name="toc_Invoking-help2man" href="#Invoking-help2man">How to Run
<samp><span class="command">help2man</span></samp></a>
+<li><a name="toc__002d_002dhelp-recommendations"
href="#_002d_002dhelp-recommendations"><samp><span
class="option">--help</span></samp> Recommendations</a>
+<li><a name="toc_Including-text" href="#Including-text">Including Additional
Text in the Output</a>
+<li><a name="toc_Makefile-usage" href="#Makefile-usage">Using <samp><span
class="command">help2man</span></samp> With <samp><span
class="command">make</span></samp></a>
+<li><a name="toc_Localised-man-pages" href="#Localised-man-pages">Producing
Native Language Manual Pages.</a>
+<ul>
+<li><a href="#Localised-man-pages">Changing the Location of Message
Catalogs</a>
+</li></ul>
+<li><a name="toc_Example" href="#Example">Example <samp><span
class="command">help2man</span></samp> Output</a>
+<li><a name="toc_Reports" href="#Reports">Reporting Bugs or Suggestions</a>
+<li><a name="toc_Availability" href="#Availability">Obtaining <samp><span
class="command">help2man</span></samp></a>
+</li></ul>
+</div>
+
+<div class="footnote">
<hr>
+<a name="texinfo-footnotes-in-document"></a><h4>Footnotes</h4><p
class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> See
+<a
href="http://translationproject.org/domain/help2man.html";>http://translationproject.org/domain/help2man.html</a>
for the
+languages currently supported by <samp><span
class="command">help2man</span></samp>, and see <a href="#Reports">Reports</a>
+for how to submit other translations.</p>
+
+ <hr></div>
+
+</div><!-- for id="content", starts in the include above -->
+<!--#include virtual="/server/footer.html" -->
+<div id="footer">
+
+<p>Please send general FSF & GNU inquiries to
+<a href="mailto:address@hidden";><address@hidden></a>.
+There are also <a href="/contact/">other ways to contact</a>
+the FSF.<br />
+Please send broken links and other corrections or suggestions to
+<a href="mailto:address@hidden";><address@hidden></a>.</p>
+
+<p>Please see the <a
+href="/server/standards/README.translations.html">Translations
+README</a> for information on coordinating and submitting translations
+of this article.</p>
+
+<p>Copyright © 2011 Free Software Foundation, Inc.</p>
+
+<p>Verbatim copying and distribution of this entire article are
+permitted worldwide, without royalty, in any medium, provided this
+notice, and the copyright notice, are preserved.</p>
+
+<p>Updated:
+<!-- timestamp start -->
+$Date: 2011/05/29 22:12:27 $
+<!-- timestamp end -->
+</p>
+</div>
+
+<div id="translations">
+<h4>Translations of this page</h4>
+
+<!-- Please keep this list alphabetical by language code.
+ Comment what the language is for each type, i.e. de is German.
+ Write the language name in its own language (Deutsch) in the text.
+ If you add a new language here, please
+ advise address@hidden and add it to
+ - /home/www/html/server/standards/README.translations.html
+ - one of the lists under the section "Translations Underway"
+ - if there is a translation team, you also have to add an alias
+ to mail.gnu.org:/com/mailer/aliases
+ Please also check you have the language code right; see:
+ http://www.loc.gov/standards/iso639-2/php/code_list.php
+ If the 2-letter ISO 639-1 code is not available,
+ use the 3-letter ISO 639-2.
+ Please use W3C normative character entities.
+
+ See also '(web-trans)Capitalization':
+
http://gnu.org/software/trans-coord/manual/web-trans/html_node/Capitalization.html
+ -->
+
+<ul class="translations-list">
+<!-- English -->
+<li><a href="/server/standards/boilerplate.html">English</a> [en]</li>
+</ul>
+</div>
+</div>
</body>
</html>
- www/software/help2man help2man.html,
Karl Berry <=