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: 2020-07-02 21:56+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=UTF-8\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, 2015, 2020 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 "
86 msgid "A utility for generating simple manual pages"
92 "Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, "
93 "2011, 2012, 2013, 2014, 2015, 2020 Free Software Foundation, Inc."
99 "@command{help2man} produces simple manual pages from the @samp{--help} and "
100 "@samp{--version} output of other commands."
104 #: help2man.texi:87 help2man.texi:90
111 msgid "Overview of @command{help2man}."
115 #: help2man.texi:87 help2man.texi:108
117 msgid "Invoking help2man"
122 msgid "How to run @command{help2man}."
126 #: help2man.texi:87 help2man.texi:208
128 msgid "--help recommendations"
133 msgid "Recommended formatting for --help output."
137 #: help2man.texi:87 help2man.texi:304
139 msgid "Including text"
144 msgid "Including additional text in the output."
148 #: help2man.texi:87 help2man.texi:366
150 msgid "Makefile usage"
155 msgid "Using @command{help2man} with @command{make}."
159 #: help2man.texi:87 help2man.texi:401
161 msgid "Localised man pages"
166 msgid "Producing native language manual pages."
170 #: help2man.texi:87 help2man.texi:456
177 msgid "Example @command{help2man} output."
181 #: help2man.texi:87 help2man.texi:572
188 msgid "Reporting bugs or suggestions."
192 #: help2man.texi:87 help2man.texi:582
199 msgid "Obtaining @command{help2man}."
205 msgid "Overview of @command{help2man}"
211 "@command{help2man} is a tool for automatically generating simple manual "
212 "pages from program output."
218 "Although manual pages are optional for GNU programs other projects, such as "
219 "Debian require them (@pxref{Man Pages, , , standards, GNU Coding Standards})"
225 "This program is intended to provide an easy way for software authors to "
226 "include a manual page in their distribution without having to maintain that "
233 "Given a program which produces reasonably standard @samp{--help} and "
234 "@samp{--version} outputs, @command{help2man} can re-arrange that output into "
235 "something which resembles a manual page."
241 msgid "How to Run @command{help2man}"
246 msgid "The format for running the @command{help2man} program is:"
252 msgid "@command{help2man} [@var{option}]@dots{} @var{executable}\n"
257 msgid "@command{help2man} supports the following options:"
263 msgid "-n @var{string}"
269 msgid "--name=@var{string}"
275 "Use @var{string} as the description for the @samp{NAME} paragraph of the "
282 "By default (for want of anything better) this paragraph contains "
283 "@samp{manual page for @var{program} @var{version}}."
286 #. Translators: the translated cross-reference "Including text" here must
287 #. match the target (type: node) translation elsewhere in this file.
291 "This option overrides an include file @samp{[name]} section "
292 "(@pxref{Including text})."
298 msgid "-s @var{section}"
304 msgid "--section @var{section}"
310 "Use @var{section} as the section for the man page. The default section is "
317 msgid "-m @var{manual}"
323 msgid "--manual=@var{manual}"
329 "Set the name of the manual section to @var{section}, used as a centred "
330 "heading for the manual page. By default @samp{User Commands} is used for "
331 "pages in section 1, @samp{Games} for section 6 and @samp{System "
332 "Administration Utilities} for sections 8 and 1M."
338 msgid "-S @var{source}"
344 msgid "--source=@var{source}"
350 "The program source is used as a page footer, and often contains the name of "
351 "the organisation or a suite of which the program is part. By default the "
352 "value is the package name and version."
358 msgid "-L @var{locale}"
364 msgid "--locale=@var{locale}"
367 #. Translators: the translated cross-reference "Localised man pages" here
368 #. must match the target (type: node) translation elsewhere in this file.
372 "Select output locale (default @samp{C}). Both the program and "
373 "@command{help2man} must support the given @var{locale} (@pxref{Localised man "
380 msgid "-i @var{file}"
386 msgid "--include=@var{file}"
389 #. Translators: the translated cross-reference "Including text" here must
390 #. match the target (type: node) translation elsewhere in this file.
393 msgid "Include material from @var{file} (@pxref{Including text})."
399 msgid "-I @var{file}"
405 msgid "--opt-include=@var{file}"
411 "A variant of @samp{--include} for use in Makefile pattern rules which does "
412 "not require @var{file} to exist."
418 msgid "-o @var{file}"
424 msgid "--output=@var{file}"
429 msgid "Send output to @var{file} rather than @code{stdout}."
435 msgid "-p @var{text}"
441 msgid "--info-page=@var{text}"
446 msgid "Name of Texinfo manual."
452 "Suppress inclusion of a @samp{SEE ALSO} paragraph directing the reader to "
453 "the Texinfo documentation."
459 "Drop @file{lt-} prefix from instances of the program name in the synopsis "
460 "(@command{libtool} creates wrapper scripts in the build directory which "
461 "invoke @command{foo} as @command{.libs/lt-foo})."
466 msgid "Show help or version information."
472 "By default @command{help2man} passes the standard @samp{--help} and "
473 "@samp{--version} options to the executable although alternatives may be "
480 msgid "-h @var{option}"
486 msgid "--help-option=@var{option}"
491 msgid "Help option string."
497 msgid "-v @var{option}"
503 msgid "--version-option=@var{option}"
508 msgid "Version option string."
514 msgid "--version-string=@var{string}"
519 msgid "Version string."
524 msgid "Include stderr when parsing option output."
530 msgid "@option{--help} Recommendations"
536 "Here are some recommendations for what to include in your @option{--help} "
537 "output. Including these gives @command{help2man} the best chance at "
538 "generating a respectable man page, as well as benefitting users directly."
544 "See @ref{Command-Line Interfaces, , , standards, GNU Coding Standards} and "
545 "@ref{Man Pages, , , standards, GNU Coding Standards}, for the official GNU "
546 "standards relating to @option{--help} and man pages."
552 "A synopsis of how to invoke the program. If different usages of the program "
553 "have different invocations, then list them all. For example (edited for "
557 #. type: smallexample
561 "Usage: cp [OPTION]... SOURCE DEST\n"
562 " or: cp [OPTION]... SOURCE... DIRECTORY\n"
569 "Use @code{argv[0]} for the program name in these synopses, just as it is, "
570 "with no directory stripping. This is in contrast to the canonical "
571 "(constant) name of the program which is used in @option{--version}."
577 "A very brief explanation of what the program does, including default and/or "
578 "typical behaviour. For example, here is @command{cp}'s:"
584 msgid "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n"
590 "A list of options, indented to column 2. If the program supports "
591 "one-character options, put those first, then the equivalent long option (if "
592 "any). If the option takes an argument, include that too, giving it a "
593 "meaningful name. Align the descriptions in a convenient column, if "
594 "desired. Note that to be correctly recognised by @command{help2man} the "
595 "description must be separated from the options by at least two spaces and "
596 "descriptions continued on subsequent lines must start at the same column."
602 "Here again is an (edited) excerpt from @command{cp}, showing a short option "
603 "with an equivalent long option, a long option only, and a short option only:"
606 #. type: smallexample
610 " -a, --archive same as -dpR\n"
611 " --backup[=CONTROL] make a backup of each ...\n"
612 " -b like --backup but ...\n"
618 "For programs that take many options, it may be desirable to split the option "
619 "list into sections such as @samp{Global}, @samp{Output control}, or whatever "
620 "makes sense in the particular case. It is usually best to alphabetise (by "
621 "short option name first, then long) within each section, or the entire list "
622 "if there are no sections."
628 "Any useful additional information about program behaviour, such as "
629 "influential environment variables, further explanation of options, etc. For "
630 "example, @command{cp} discusses @env{VERSION_CONTROL} and sparse files."
636 "A few examples of typical usage, at your discretion. One good example is "
637 "usually worth a thousand words of description, so this is highly "
644 msgid "address for bug reports"
656 "In closing, a line stating how to email bug reports. Typically, "
657 "@var{mailing-address} will be @samp{bug-@var{program}@@gnu.org}; please use "
658 "this form for GNU programs whenever possible. It's also good to mention the "
659 "home page of the program, other mailing lists, etc."
665 "The @code{argp} and @code{popt} programming interfaces let you specify "
666 "option descriptions for @option{--help} in the same structure as the rest of "
667 "the option definition; you may wish to consider using these routines for "
668 "option parsing instead of @code{getopt}."
674 "By default @command{help2man} has some heuristics for identifying manual "
675 "page sections: a line consisting of @samp{Options:} for example will cause "
676 "the following text to appear in the @code{OPTIONS} section, and a line "
677 "beginning with @samp{Copyright} will appear in the @code{COPYRIGHT} "
678 "section. Outside of these heuristics, a line consisting of @samp{*Words*} "
679 "will start a new section, and @samp{Words:} a new sub-section."
685 msgid "Including Additional Text in the Output"
688 #. Translators: the translated cross-reference "Invoking help2man" here
689 #. must match the target (type: node) translation elsewhere in this file.
693 "Additional static text may be included in the generated manual page by using "
694 "the @samp{--include} and @samp{--opt-include} options (@pxref{Invoking "
695 "help2man}). While these files can be named anything, for consistency we "
696 "suggest to use the extension @code{.h2m} for @command{help2man} include "
702 msgid "The format for files included with these option is simple:"
725 "Blocks of verbatim *roff text are inserted into the output either at the "
726 "start of the given @samp{[section]} (case insensitive), or after a paragraph "
727 "matching @samp{/pattern/}."
733 "Patterns use the Perl regular expression syntax and may be followed by the "
734 "@samp{i}, @samp{s} or @samp{m} modifiers (@pxref{perlre, , perlre(1), "
735 "*manpages*, The @code{perlre(1)} manual page})"
741 "Lines before the first section or pattern which begin with @samp{-} are "
742 "processed as options. Anything else is silently ignored and may be used for "
743 "comments, RCS keywords and the like."
748 msgid "The section output order (for those included) is:"
772 "Any @samp{[name]} or @samp{[synopsis]} sections appearing in the include "
773 "file will replace what would have automatically been produced (although you "
774 "can still override the former with @samp{--name} if required)."
780 "Other sections are prepended to the automatically produced output for the "
781 "standard sections given above, or included at @emph{other} (above) in the "
782 "order they were encountered in the include file."
788 "Placement of the text within the section may be explicitly requested by "
789 "using the syntax @samp{[<section]}, @samp{[=section]} or @samp{[>section]} "
790 "to place the additional text before, in place of, or after the default "
791 "output respectively."
797 msgid "Using @command{help2man} With @command{make}"
803 "A suggested use of @command{help2man} in Makefiles is to have the manual "
804 "page depend not on the binary, but on the source file(s) in which the "
805 "@samp{--help} and @samp{--version} output are defined."
811 "This usage allows a manual page to be generated by the maintainer and "
812 "included in the distribution without requiring the end-user to have "
813 "@command{help2man} installed."
818 msgid "An example rule for the program @code{prog} could be:"
825 "prog.1: $(srcdir)/main.c\n"
826 " -$(HELP2MAN) --output=$@@ --name='an example program' ./prog\n"
832 "The value of @code{HELP2MAN} may be set in @code{configure.in} using either "
839 msgid "AM_MISSING_PROG(HELP2MAN, help2man)\n"
844 msgid "for @command{automake}, or something like:"
850 msgid "AC_PATH_PROG(HELP2MAN, help2man, false // No help2man //)\n"
855 msgid "for @command{autoconf} alone."
861 msgid "Producing Native Language Manual Pages"
867 "Manual pages may be produced for any locale supported by both the program "
868 "and @command{help2man} with the @samp{--locale} (@samp{-L}) option."
874 msgid "help2man -L fr_FR@@euro -o cp.fr.1 cp\n"
877 #. Translators: the translated cross-reference "Reports" here must match
878 #. the target (type: node) translation elsewhere in this file.
882 "See @url{http://translationproject.org/domain/help2man.html} for the "
883 "languages currently supported by @command{help2man}, and @pxref{Reports} for "
884 "how to submit other translations."
890 msgid "Changing the Location of Message Catalogs"
896 "When creating localised manual pages from a program's build directory it is "
897 "probable that the translations installed in the standard location will not "
898 "be (if installed at all) correct for the version of the program being built."
904 "A preloadable library is provided with @command{help2man} which will "
905 "intercept @code{bindtextdomain} calls configuring the location of message "
906 "catalogs for the domain given by @env{$TEXTDOMAIN} and override the location "
907 "to the path given by @env{$LOCALEDIR}."
912 msgid "So for example:"
919 "mkdir -p tmp/fr/LC_MESSAGES\n"
920 "cp po/fr.gmo tmp/fr/LC_MESSAGES/@var{prog}.mo\n"
921 "LD_PRELOAD=\"/usr/lib/help2man/bindtextdomain.so\" \\\n"
922 " LOCALEDIR=tmp \\\n"
923 " TEXTDOMAIN=@var{prog} \\\n"
924 " help2man -L fr_FR@@euro -i @var{prog}.fr.h2m -o @var{prog}.fr.1 "
932 "will cause @var{prog} to load the message catalog from @samp{tmp} rather "
933 "than @samp{/usr/share/locale}."
944 "The generalisation of @samp{fr_FR@@euro} to @samp{fr} in the example above "
945 "is done by @code{gettext}, if a more specific match were available it would "
946 "also have been re-mapped."
949 #. Translators: the translated cross-reference "Reports" here must match
950 #. the target (type: node) translation elsewhere in this file.
954 "This preload has only been tested against @command{eglibc} 2.11.2 and "
955 "@command{gettext} 0.18.1.1 on a GNU/Linux system; let me know if it does (or "
956 "doesn't) work for you (@pxref{Reports})."
962 msgid "Example @command{help2man} Output"
968 "Given a hypothetical program @command{foo} which produces the following "
976 "@exstrong{$ foo --version}\n"
985 "Copyright (C) 2011 Free Software Foundation, Inc.\n"
986 "This is free software; see the source for copying conditions. There is NO\n"
987 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR "
996 "Written by A. Programmer.\n"
997 "@exstrong{$ foo --help}\n"
998 "GNU `foo' does nothing interesting except serve as an example for\n"
1004 #: help2man.texi:496
1007 "Usage: foo [OPTION]...\n"
1012 #: help2man.texi:501
1016 " -a, --option an option\n"
1017 " -b, --another-option[=VALUE]\n"
1023 #: help2man.texi:504
1026 " --help display this help and exit\n"
1027 " --version output version information and exit\n"
1032 #: help2man.texi:508
1037 " foo --option the same thing, giving `--option'\n"
1042 #: help2man.texi:510
1044 msgid "Report bugs to <bug-gnu-utils@@gnu.org>.\n"
1048 #: help2man.texi:514
1050 "@command{help2man} will produce @command{nroff} input for a manual page "
1051 "which will be formatted something like this:"
1055 #: help2man.texi:517
1058 "FOO(1) User Commands FOO(1)\n"
1063 #: help2man.texi:521
1067 " foo - manual page for foo 1.1\n"
1072 #: help2man.texi:524
1075 "@exstrong{SYNOPSIS}\n"
1076 " foo [OPTION]...\n"
1081 #: help2man.texi:528
1084 "@exstrong{DESCRIPTION}\n"
1085 " GNU `foo' does nothing interesting except serve as an example for\n"
1091 #: help2man.texi:532
1094 "@exstrong{OPTIONS}\n"
1095 " @exstrong{-a}, @exstrong{--option}\n"
1101 #: help2man.texi:535
1104 " @exstrong{-b}, @exstrong{--another-option}[=@exemph{VALUE}]\n"
1110 #: help2man.texi:537
1113 " @exstrong{--help} display this help and exit\n"
1118 #: help2man.texi:540
1121 " @exstrong{--version}\n"
1122 " output version information and exit\n"
1127 #: help2man.texi:543
1130 "@exstrong{EXAMPLES}\n"
1136 #: help2man.texi:546
1139 " foo @exstrong{--option}\n"
1140 " the same thing, giving `--option'\n"
1145 #: help2man.texi:549
1148 "@exstrong{AUTHOR}\n"
1149 " Written by A. Programmer.\n"
1154 #: help2man.texi:552
1157 "@exstrong{REPORTING BUGS}\n"
1158 " Report bugs to <bug-gnu-utils@@gnu.org>.\n"
1163 #: help2man.texi:558
1166 "@exstrong{COPYRIGHT}\n"
1167 " Copyright @copyright{} 2011 Free Software Foundation, Inc.\n"
1168 " This is free software; see the source for copying conditions.\n"
1169 " There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A\n"
1170 " PARTICULAR PURPOSE.\n"
1175 #: help2man.texi:563
1178 "@exstrong{SEE ALSO}\n"
1179 " The full documentation for @exstrong{foo} is maintained as a Texinfo "
1181 " If the @exstrong{info} and @exstrong{foo} programs are properly "
1182 "installed at your site,\n"
1188 #: help2man.texi:565
1191 " @exstrong{info foo}\n"
1196 #: help2man.texi:567
1199 " should give you access to the complete manual.\n"
1204 #: help2man.texi:570
1206 msgid "foo 1.1 May 2011 FOO(1)\n"
1210 #: help2man.texi:573
1212 msgid "Reporting Bugs or Suggestions"
1216 #: help2man.texi:577
1218 "If you find problems or have suggestions about this program or manual, "
1219 "please report them to @email{bug-help2man@@gnu.org}."
1223 #: help2man.texi:581
1225 "Note to translators: Translations are handled though the "
1226 "@uref{http://translationproject.org/, Translation Project} see "
1227 "@url{http://translationproject.org/html/translators.html} for details."
1231 #: help2man.texi:583
1233 msgid "Obtaining @command{help2man}"
1237 #: help2man.texi:587
1239 "The latest version of this distribution is available online from GNU "
1244 #: help2man.texi:593
1245 msgid "If automatic redirection fails, the list of mirrors is at:"
1249 #: help2man.texi:599
1250 msgid "Or if need be you can use the main GNU ftp server:"