1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "Report-Msgid-Bugs-To: Brendan O'Dea <bug-help2man@gnu.org>\n"
11 "POT-Creation-Date: 2014-07-26 20:47+1000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=CHARSET\n"
18 "Content-Transfer-Encoding: 8bit\n"
23 msgid "@command{help2man} Reference Manual"
28 msgid "@documentencoding UTF-8"
34 msgid "Software development"
39 msgid "Automatic manual page generation."
45 "This file documents the GNU @command{help2man} command which produces simple "
46 "manual pages from the @samp{--help} and @samp{--version} output of other "
53 "Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, "
54 "2012, 2013, 2014 Free Software Foundation, Inc."
58 #: help2man.texi:24 help2man.texi:56
60 "Permission is granted to make and distribute verbatim copies of this manual "
61 "provided the copyright notice and this permission notice are preserved on "
66 #: help2man.texi:36 help2man.texi:61
68 "Permission is granted to copy and distribute modified versions of this "
69 "manual under the conditions for verbatim copying, provided that the entire "
70 "resulting derived work is distributed under the terms of a permission notice "
71 "identical to this one."
75 #: help2man.texi:41 help2man.texi:66
77 "Permission is granted to copy and distribute translations of this manual "
78 "into another language, under the above conditions for modified versions, "
79 "except that this permission notice may be stated in a translation approved "
84 #: help2man.texi:44 help2man.texi:70
92 msgid "A utility for generating simple manual pages"
98 msgid "Brendan O'Dea @email{bod@@debian.org}"
104 "Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, "
105 "2011, 2012, 2013, 2014 Free Software Foundation, Inc."
111 "@command{help2man} produces simple manual pages from the @samp{--help} and "
112 "@samp{--version} output of other commands."
116 #: help2man.texi:85 help2man.texi:88
123 msgid "Overview of @command{help2man}."
127 #: help2man.texi:85 help2man.texi:106
129 msgid "Invoking help2man"
134 msgid "How to run @command{help2man}."
138 #: help2man.texi:85 help2man.texi:206
140 msgid "--help recommendations"
145 msgid "Recommended formatting for --help output."
149 #: help2man.texi:85 help2man.texi:302
151 msgid "Including text"
156 msgid "Including additional text in the output."
160 #: help2man.texi:85 help2man.texi:364
162 msgid "Makefile usage"
167 msgid "Using @command{help2man} with @command{make}."
171 #: help2man.texi:85 help2man.texi:399
173 msgid "Localised man pages"
178 msgid "Producing native language manual pages."
182 #: help2man.texi:85 help2man.texi:454
189 msgid "Example @command{help2man} output."
193 #: help2man.texi:85 help2man.texi:570
200 msgid "Reporting bugs or suggestions."
204 #: help2man.texi:85 help2man.texi:580
211 msgid "Obtaining @command{help2man}."
217 msgid "Overview of @command{help2man}"
223 "@command{help2man} is a tool for automatically generating simple manual "
224 "pages from program output."
230 "Although manual pages are optional for GNU programs other projects, such as "
231 "Debian require them (@pxref{Man Pages, , , standards, GNU Coding Standards})"
237 "This program is intended to provide an easy way for software authors to "
238 "include a manual page in their distribution without having to maintain that "
245 "Given a program which produces reasonably standard @samp{--help} and "
246 "@samp{--version} outputs, @command{help2man} can re-arrange that output into "
247 "something which resembles a manual page."
253 msgid "How to Run @command{help2man}"
258 msgid "The format for running the @command{help2man} program is:"
264 msgid "@command{help2man} [@var{option}]@dots{} @var{executable}\n"
269 msgid "@command{help2man} supports the following options:"
275 msgid "-n @var{string}"
281 msgid "--name=@var{string}"
287 "Use @var{string} as the description for the @samp{NAME} paragraph of the "
294 "By default (for want of anything better) this paragraph contains "
295 "@samp{manual page for @var{program} @var{version}}."
301 "This option overrides an include file @samp{[name]} section "
302 "(@pxref{Including text})."
308 msgid "-s @var{section}"
314 msgid "--section @var{section}"
320 "Use @var{section} as the section for the man page. The default section is "
327 msgid "-m @var{manual}"
333 msgid "--manual=@var{manual}"
339 "Set the name of the manual section to @var{section}, used as a centred "
340 "heading for the manual page. By default @samp{User Commands} is used for "
341 "pages in section 1, @samp{Games} for section 6 and @samp{System "
342 "Administration Utilities} for sections 8 and 1M."
348 msgid "-S @var{source}"
354 msgid "--source=@var{source}"
360 "The program source is used as a page footer, and often contains the name of "
361 "the organisation or a suite of which the program is part. By default the "
362 "value is the package name and version."
368 msgid "-L @var{locale}"
374 msgid "--locale=@var{locale}"
380 "Select output locale (default @samp{C}). Both the program and "
381 "@command{help2man} must support the given @var{locale} (@pxref{Localised man "
388 msgid "-i @var{file}"
394 msgid "--include=@var{file}"
399 msgid "Include material from @var{file} (@pxref{Including text})."
405 msgid "-I @var{file}"
411 msgid "--opt-include=@var{file}"
417 "A variant of @samp{--include} for use in Makefile pattern rules which does "
418 "not require @var{file} to exist."
424 msgid "-o @var{file}"
430 msgid "--output=@var{file}"
435 msgid "Send output to @var{file} rather than @code{stdout}."
441 msgid "-p @var{text}"
447 msgid "--info-page=@var{text}"
452 msgid "Name of Texinfo manual."
470 "Suppress inclusion of a @samp{SEE ALSO} paragraph directing the reader to "
471 "the Texinfo documentation."
489 "Drop @file{lt-} prefix from instances of the program name in the synopsis "
490 "(@command{libtool} creates wrapper scripts in the build directory which "
491 "invoke @command{foo} as @command{.libs/lt-foo})."
508 msgid "Show help or version information."
514 "By default @command{help2man} passes the standard @samp{--help} and "
515 "@samp{--version} options to the executable although alternatives may be "
522 msgid "-h @var{option}"
528 msgid "--help-option=@var{option}"
533 msgid "Help option string."
539 msgid "-v @var{option}"
545 msgid "--version-option=@var{option}"
550 msgid "Version option string."
556 msgid "--version-string=@var{string}"
561 msgid "Version string."
567 msgid "--no-discard-stderr"
572 msgid "Include stderr when parsing option output."
578 msgid "@option{--help} Recommendations"
584 "Here are some recommendations for what to include in your @option{--help} "
585 "output. Including these gives @command{help2man} the best chance at "
586 "generating a respectable man page, as well as benefitting users directly."
592 "See @ref{Command-Line Interfaces, , , standards, GNU Coding Standards} and "
593 "@ref{Man Pages, , , standards, GNU Coding Standards}, for the official GNU "
594 "standards relating to @option{--help} and man pages."
600 "A synopsis of how to invoke the program. If different usages of the program "
601 "have different invocations, then list them all. For example (edited for "
605 #. type: smallexample
609 "Usage: cp [OPTION]... SOURCE DEST\n"
610 " or: cp [OPTION]... SOURCE... DIRECTORY\n"
617 "Use @code{argv[0]} for the program name in these synopses, just as it is, "
618 "with no directory stripping. This is in contrast to the canonical "
619 "(constant) name of the program which is used in @option{--version}."
625 "A very brief explanation of what the program does, including default and/or "
626 "typical behaviour. For example, here is @command{cp}'s:"
632 msgid "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n"
638 "A list of options, indented to column 2. If the program supports "
639 "one-character options, put those first, then the equivalent long option (if "
640 "any). If the option takes an argument, include that too, giving it a "
641 "meaningful name. Align the descriptions in a convenient column, if "
642 "desired. Note that to be correctly recognised by @command{help2man} the "
643 "description must be separated from the options by at least two spaces and "
644 "descriptions continued on subsequent lines must start at the same column."
650 "Here again is an (edited) excerpt from @command{cp}, showing a short option "
651 "with an equivalent long option, a long option only, and a short option only:"
654 #. type: smallexample
658 " -a, --archive same as -dpR\n"
659 " --backup[=CONTROL] make a backup of each ...\n"
660 " -b like --backup but ...\n"
666 "For programs that take many options, it may be desirable to split the option "
667 "list into sections such as @samp{Global}, @samp{Output control}, or whatever "
668 "makes sense in the particular case. It is usually best to alphabetise (by "
669 "short option name first, then long) within each section, or the entire list "
670 "if there are no sections."
676 "Any useful additional information about program behaviour, such as "
677 "influential environment variables, further explanation of options, etc. For "
678 "example, @command{cp} discusses @env{VERSION_CONTROL} and sparse files."
684 "A few examples of typical usage, at your discretion. One good example is "
685 "usually worth a thousand words of description, so this is highly "
692 msgid "address for bug reports"
704 "In closing, a line stating how to email bug reports. Typically, "
705 "@var{mailing-address} will be @samp{bug-@var{program}@@gnu.org}; please use "
706 "this form for GNU programs whenever possible. It's also good to mention the "
707 "home page of the program, other mailing lists, etc."
713 "The @code{argp} and @code{popt} programming interfaces let you specify "
714 "option descriptions for @option{--help} in the same structure as the rest of "
715 "the option definition; you may wish to consider using these routines for "
716 "option parsing instead of @code{getopt}."
722 "By default @command{help2man} has some heuristics for identifying manual "
723 "page sections: a line consisting of @samp{Options:} for example will cause "
724 "the following text to appear in the @code{OPTIONS} section, and a line "
725 "beginning with @samp{Copyright} will appear in the @code{COPYRIGHT} "
726 "section. Outside of these heuristics, a line consisting of @samp{*Words*} "
727 "will start a new section, and @samp{Words:} a new sub-section."
733 msgid "Including Additional Text in the Output"
739 "Additional static text may be included in the generated manual page by using "
740 "the @samp{--include} and @samp{--opt-include} options (@pxref{Invoking "
741 "help2man}). While these files can be named anything, for consistency we "
742 "suggest to use the extension @code{.h2m} for @command{help2man} include "
748 msgid "The format for files included with these option is simple:"
771 "Blocks of verbatim *roff text are inserted into the output either at the "
772 "start of the given @samp{[section]} (case insensitive), or after a paragraph "
773 "matching @samp{/pattern/}."
779 "Patterns use the Perl regular expression syntax and may be followed by the "
780 "@samp{i}, @samp{s} or @samp{m} modifiers (@pxref{perlre, , perlre(1), "
781 "*manpages*, The @code{perlre(1)} manual page})"
787 "Lines before the first section or pattern which begin with @samp{-} are "
788 "processed as options. Anything else is silently ignored and may be used for "
789 "comments, RCS keywords and the like."
794 msgid "The section output order (for those included) is:"
818 "Any @samp{[name]} or @samp{[synopsis]} sections appearing in the include "
819 "file will replace what would have automatically been produced (although you "
820 "can still override the former with @samp{--name} if required)."
826 "Other sections are prepended to the automatically produced output for the "
827 "standard sections given above, or included at @emph{other} (above) in the "
828 "order they were encountered in the include file."
834 "Placement of the text within the section may be explicitly requested by "
835 "using the syntax @samp{[<section]}, @samp{[=section]} or @samp{[>section]} "
836 "to place the additional text before, in place of, or after the default "
837 "output respectively."
843 msgid "Using @command{help2man} With @command{make}"
849 "A suggested use of @command{help2man} in Makefiles is to have the manual "
850 "page depend not on the binary, but on the source file(s) in which the "
851 "@samp{--help} and @samp{--version} output are defined."
857 "This usage allows a manual page to be generated by the maintainer and "
858 "included in the distribution without requiring the end-user to have "
859 "@command{help2man} installed."
864 msgid "An example rule for the program @code{prog} could be:"
871 "prog.1: $(srcdir)/main.c\n"
872 " -$(HELP2MAN) --output=$@@ --name='an example program' ./prog\n"
878 "The value of @code{HELP2MAN} may be set in @code{configure.in} using either "
885 msgid "AM_MISSING_PROG(HELP2MAN, help2man)\n"
890 msgid "for @command{automake}, or something like:"
896 msgid "AC_PATH_PROG(HELP2MAN, help2man, false // No help2man //)\n"
901 msgid "for @command{autoconf} alone."
907 msgid "Producing Native Language Manual Pages"
913 "Manual pages may be produced for any locale supported by both the program "
914 "and @command{help2man} with the @samp{--locale} (@samp{-L}) option."
920 msgid "help2man -L fr_FR@@euro -o cp.fr.1 cp\n"
926 "See @url{http://translationproject.org/domain/help2man.html} for the "
927 "languages currently supported by @command{help2man}, and @pxref{Reports} for "
928 "how to submit other translations."
934 msgid "Changing the Location of Message Catalogs"
940 "When creating localised manual pages from a program's build directory it is "
941 "probable that the translations installed in the standard location will not "
942 "be (if installed at all) correct for the version of the program being built."
948 "A preloadable library is provided with @command{help2man} which will "
949 "intercept @code{bindtextdomain} calls configuring the location of message "
950 "catalogs for the domain given by @env{$TEXTDOMAIN} and override the location "
951 "to the path given by @env{$LOCALEDIR}."
956 msgid "So for example:"
963 "mkdir -p tmp/fr/LC_MESSAGES\n"
964 "cp po/fr.gmo tmp/fr/LC_MESSAGES/@var{prog}.mo\n"
965 "LD_PRELOAD=\"/usr/lib/help2man/bindtextdomain.so\" \\\n"
966 " LOCALEDIR=tmp \\\n"
967 " TEXTDOMAIN=@var{prog} \\\n"
968 " help2man -L fr_FR@@euro -i @var{prog}.fr.h2m -o @var{prog}.fr.1 "
976 "will cause @var{prog} to load the message catalog from @samp{tmp} rather "
977 "than @samp{/usr/share/locale}."
988 "The generalisation of @samp{fr_FR@@euro} to @samp{fr} in the example above "
989 "is done by @code{gettext}, if a more specific match were available it would "
990 "also have been re-mapped."
996 "This preload has only been tested against @command{eglibc} 2.11.2 and "
997 "@command{gettext} 0.18.1.1 on a GNU/Linux system; let me know if it does (or "
998 "doesn't) work for you (@pxref{Reports})."
1002 #: help2man.texi:455
1004 msgid "Example @command{help2man} Output"
1008 #: help2man.texi:458
1010 "Given a hypothetical program @command{foo} which produces the following "
1015 #: help2man.texi:483
1018 "@exstrong{$ foo --version}\n"
1024 #: help2man.texi:487
1027 "Copyright (C) 2011 Free Software Foundation, Inc.\n"
1028 "This is free software; see the source for copying conditions. There is NO\n"
1029 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR "
1035 #: help2man.texi:492
1038 "Written by A. Programmer.\n"
1039 "@exstrong{$ foo --help}\n"
1040 "GNU `foo' does nothing interesting except serve as an example for\n"
1046 #: help2man.texi:494
1049 "Usage: foo [OPTION]...\n"
1054 #: help2man.texi:499
1058 " -a, --option an option\n"
1059 " -b, --another-option[=VALUE]\n"
1065 #: help2man.texi:502
1068 " --help display this help and exit\n"
1069 " --version output version information and exit\n"
1074 #: help2man.texi:506
1079 " foo --option the same thing, giving `--option'\n"
1084 #: help2man.texi:508
1086 msgid "Report bugs to <bug-gnu-utils@@gnu.org>.\n"
1090 #: help2man.texi:512
1092 "@command{help2man} will produce @command{nroff} input for a manual page "
1093 "which will be formatted something like this:"
1097 #: help2man.texi:515
1100 "FOO(1) User Commands FOO(1)\n"
1105 #: help2man.texi:519
1109 " foo - manual page for foo 1.1\n"
1114 #: help2man.texi:522
1117 "@exstrong{SYNOPSIS}\n"
1118 " foo [OPTION]...\n"
1123 #: help2man.texi:526
1126 "@exstrong{DESCRIPTION}\n"
1127 " GNU `foo' does nothing interesting except serve as an example for\n"
1133 #: help2man.texi:530
1136 "@exstrong{OPTIONS}\n"
1137 " @exstrong{-a}, @exstrong{--option}\n"
1143 #: help2man.texi:533
1146 " @exstrong{-b}, @exstrong{--another-option}[=@exemph{VALUE}]\n"
1152 #: help2man.texi:535
1155 " @exstrong{--help} display this help and exit\n"
1160 #: help2man.texi:538
1163 " @exstrong{--version}\n"
1164 " output version information and exit\n"
1169 #: help2man.texi:541
1172 "@exstrong{EXAMPLES}\n"
1178 #: help2man.texi:544
1181 " foo @exstrong{--option}\n"
1182 " the same thing, giving `--option'\n"
1187 #: help2man.texi:547
1190 "@exstrong{AUTHOR}\n"
1191 " Written by A. Programmer.\n"
1196 #: help2man.texi:550
1199 "@exstrong{REPORTING BUGS}\n"
1200 " Report bugs to <bug-gnu-utils@@gnu.org>.\n"
1205 #: help2man.texi:556
1208 "@exstrong{COPYRIGHT}\n"
1209 " Copyright @copyright{} 2011 Free Software Foundation, Inc.\n"
1210 " This is free software; see the source for copying conditions.\n"
1211 " There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A\n"
1212 " PARTICULAR PURPOSE.\n"
1217 #: help2man.texi:561
1220 "@exstrong{SEE ALSO}\n"
1221 " The full documentation for @exstrong{foo} is maintained as a Texinfo "
1223 " If the @exstrong{info} and @exstrong{foo} programs are properly "
1224 "installed at your site,\n"
1230 #: help2man.texi:563
1233 " @exstrong{info foo}\n"
1238 #: help2man.texi:565
1241 " should give you access to the complete manual.\n"
1246 #: help2man.texi:568
1248 msgid "foo 1.1 May 2011 FOO(1)\n"
1252 #: help2man.texi:571
1254 msgid "Reporting Bugs or Suggestions"
1258 #: help2man.texi:575
1260 "If you find problems or have suggestions about this program or manual, "
1261 "please report them to @email{bug-help2man@@gnu.org}."
1265 #: help2man.texi:579
1267 "Note to translators: Translations are handled though the "
1268 "@uref{http://translationproject.org/, Translation Project} see "
1269 "@url{http://translationproject.org/html/translators.html} for details."
1273 #: help2man.texi:581
1275 msgid "Obtaining @command{help2man}"
1279 #: help2man.texi:585
1281 "The latest version of this distribution is available online from GNU "
1286 #: help2man.texi:588
1288 msgid "@url{http://ftpmirror.gnu.org/help2man/}\n"
1292 #: help2man.texi:591
1293 msgid "If automatic redirection fails, the list of mirrors is at:"
1297 #: help2man.texi:594
1299 msgid "@url{http://www.gnu.org/order/ftp.html}\n"
1303 #: help2man.texi:597
1304 msgid "Or if need be you can use the main GNU ftp server:"
1308 #: help2man.texi:599
1310 msgid "@url{http://ftp.gnu.org/gnu/help2man/}\n"