4 # Self extracting help2man script.
6 # -q, --quiet Suppress extraction message
7 # -s, --stdout Extract to stdout
8 # -w, --with-gettext Add support for localized man pages
9 # -n, --name Print name only*
10 # -v, --version Print version only*
19 my ($program, $version) = ('help2man', '1.43.1');
22 die "Usage: $0 [--quiet] [--stdout] [--with-gettext] [--name] [--version]\n"
23 unless GetOptions \%opts, qw(quiet stdout with-gettext name version)
26 print "$program\n" if $opts{name};
27 print "$version\n" if $opts{version};
28 exit if $opts{name} or $opts{version};
40 $target =~ s/\.PL$// or die "$0: can't determine target name\n";
41 $tmp = "$target.tmp$$";
42 unlink $tmp or die "$0: can't unlink $tmp ($!)\n" if -e $tmp;
43 open OUT, ">$tmp" or die "$0: can't create $tmp ($!)\n";
46 print "Extracting $target (with variable substitutions)\n"
50 print OUT "$Config{startperl} -w\n";
52 # For systems without the crash-bang hack also add:
53 print OUT <<"!GROK!THIS!" if $Config{sharpbang} !~ /^#!/;
54 eval 'exec $Config{perlpath} -wS \$0 \${1+"\$@"}'
55 if \$running_under_some_shell;
57 \$running_under_some_shell = 0; # for -w
60 # No substitutions for this chunk:
61 print OUT <<'!NO!SUBS!';
63 # Generate a short man page from --help and --version output.
64 # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
65 # 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
67 # This program is free software; you can redistribute it and/or modify
68 # it under the terms of the GNU General Public License as published by
69 # the Free Software Foundation; either version 3, or (at your option)
72 # This program is distributed in the hope that it will be useful,
73 # but WITHOUT ANY WARRANTY; without even the implied warranty of
74 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
75 # GNU General Public License for more details.
77 # You should have received a copy of the GNU General Public License
78 # along with this program; if not, see <http://www.gnu.org/licenses/>.
80 # Written by Brendan O'Dea <bod@debian.org>
81 # Available from ftp://ftp.gnu.org/gnu/help2man/
86 use Text::Tabs qw(expand);
87 use POSIX qw(strftime setlocale LC_ALL);
90 print OUT <<'!NO!SUBS!' if $opts{'with-gettext'};
92 use Encode qw(decode encode);
93 use I18N::Langinfo qw(langinfo CODESET);
96 # Interpolate program name and version:
97 print OUT <<"!GROK!THIS!";
99 my \$this_program = '$program';
100 my \$this_version = '$version';
103 # Conditionally include gettext support:
104 print OUT $opts{'with-gettext'} ? <<'!WITH!GETTEXT!' : <<'!NO!GETTEXT!';
108 my $gettext = Locale::gettext->domain($this_program);
109 sub _ { $gettext->get($_[0]) }
111 my ($user_locale) = grep defined && length,
112 (map $ENV{$_}, qw(LANGUAGE LC_ALL LC_MESSAGES LANG)), 'C';
114 my $user_encoding = langinfo CODESET;
116 # Set localisation of date and executable's output.
119 delete @ENV{qw(LANGUAGE LC_MESSAGES LANG)};
120 setlocale LC_ALL, $ENV{LC_ALL} = shift || 'C';
121 $encoding = langinfo CODESET;
124 sub dec { $encoding ? decode $encoding, $_[0] : $_[0] }
125 sub enc { $encoding ? encode $encoding, $_[0] : $_[0] }
126 sub enc_user { encode $user_encoding, $_[0] }
127 sub kark # die with message formatted in the invoking user's locale
129 setlocale LC_ALL, $user_locale;
130 my $fmt = $gettext->get(shift);
131 my $errmsg = enc_user sprintf $fmt, @_;
142 die "$this_program: no locale support (Locale::gettext required)\n"
143 unless $locale eq 'C';
148 sub enc_user { $_[0] }
149 sub kark { die +(sprintf shift, @_), "\n" }
152 # No substitutions for this chunk:
153 print OUT <<'!NO!SUBS!';
156 sub program_basename;
157 sub get_option_value;
160 my $version_info = enc_user sprintf _(<<'EOT'), $this_program, $this_version;
163 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
164 2011, 2012, 2013 Free Software Foundation, Inc.
165 This is free software; see the source for copying conditions. There is NO
166 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
168 Written by Brendan O'Dea <bod@debian.org>
171 my $help_info = enc_user sprintf _(<<'EOT'), $this_program, $this_program;
172 `%s' generates a man page out of `--help' and `--version' output.
174 Usage: %s [OPTION]... EXECUTABLE
176 -n, --name=STRING description for the NAME paragraph
177 -s, --section=SECTION section number for manual page (1, 6, 8)
178 -m, --manual=TEXT name of manual (User Commands, ...)
179 -S, --source=TEXT source of program (FSF, Debian, ...)
180 -L, --locale=STRING select locale (default "C")
181 -i, --include=FILE include material from `FILE'
182 -I, --opt-include=FILE include material from `FILE' if it exists
183 -o, --output=FILE send output to `FILE'
184 -p, --info-page=TEXT name of Texinfo manual
185 -N, --no-info suppress pointer to Texinfo manual
186 -l, --libtool exclude the `lt-' from the program name
187 --help print this help, then exit
188 --version print version number, then exit
190 EXECUTABLE should accept `--help' and `--version' options and produce output on
191 stdout although alternatives may be specified using:
193 -h, --help-option=STRING help option string
194 -v, --version-option=STRING version option string
195 --version-string=STRING version string
196 --no-discard-stderr include stderr when parsing option output
198 Report bugs to <bug-help2man@gnu.org>.
204 my $help_option = '--help';
205 my $version_option = '--version';
206 my $discard_stderr = 1;
207 my ($opt_name, @opt_include, $opt_output, $opt_info, $opt_no_info, $opt_libtool,
211 'n|name=s' => \$opt_name,
212 's|section=s' => \$section,
213 'm|manual=s' => \$manual,
214 'S|source=s' => \$source,
215 'L|locale=s' => sub { configure_locale pop },
216 'i|include=s' => sub { push @opt_include, [ pop, 1 ] },
217 'I|opt-include=s' => sub { push @opt_include, [ pop, 0 ] },
218 'o|output=s' => \$opt_output,
219 'p|info-page=s' => \$opt_info,
220 'N|no-info' => \$opt_no_info,
221 'l|libtool' => \$opt_libtool,
222 'help' => sub { print $help_info; exit },
223 'version' => sub { print $version_info; exit },
224 'h|help-option=s' => \$help_option,
225 'v|version-option=s' => \$version_option,
226 'version-string=s' => \$version_text,
227 'discard-stderr!' => \$discard_stderr,
231 Getopt::Long::config('bundling');
232 die $help_info unless GetOptions %opt_def and @ARGV == 1;
236 print OUT <<'!NO!SUBS!' if $opts{'with-gettext'};
237 configure_locale unless $encoding;
241 # No substitutions for the remainder of the script:
242 print OUT <<'!NO!SUBS!';
246 my %append_match = ();
247 my @include = (); # retain order given in include file
249 # Process include file (if given). Format is:
251 # Optional initial text, ignored. May include lines starting with `-'
252 # which are processed as options.
255 # Verbatim text to be included in the named section. By default at
256 # the start, but in the case of `name' and `synopsis' the content
257 # will replace the autogenerated contents.
260 # Verbatim text to be inserted at the start of the named section.
263 # Verbatim text to replace the named section.
266 # Verbatim text to be appended to the end of the named section.
269 # Verbatim text for inclusion below a paragraph matching `pattern'.
274 my ($inc, $required) = @{shift @opt_include};
276 next unless -f $inc or $required;
277 kark N_("%s: can't open `%s' (%s)"), $this_program, $inc, $!
278 unless open INC, $inc;
285 # Convert input to internal Perl format, so that multibyte
286 # sequences are treated as single characters.
290 if (/^\[([^]]+)\]\s*$/)
296 # Handle explicit [<section], [=section] and [>section]
297 if ($key =~ s/^([<>=])\s*//)
299 if ($1 eq '>') { $hash = \%append; }
300 elsif ($1 eq '=') { $hash = \%replace; }
302 # NAME/SYNOPSIS replace by default
303 elsif ($key eq _('NAME') or $key eq _('SYNOPSIS'))
313 unless $include{$key} or $replace{$key} or $append{$key};
319 if (m!^/(.*)/([ims]*)\s*$!)
321 my $pat = $2 ? "(?$2)$1" : $1;
324 eval { $key = qr($pat) };
327 $@ =~ s/ at .*? line \d.*//;
331 $hash = \%append_match;
335 # Check for options before the first section--anything else is
336 # silently ignored, allowing the first for comments and
355 kark N_("%s: no valid information found in `%s'"), $this_program, $inc
359 # Compress trailing blank lines.
360 for my $hash (\(%include, %replace, %append, %append_match))
362 for (keys %$hash) { $hash->{$_} =~ s/\n+$/\n/ }
365 # Grab help and version info from executable.
366 my $help_text = get_option_value $ARGV[0], $help_option;
367 $version_text ||= get_option_value $ARGV[0], $version_option;
369 # Translators: the following message is a strftime(3) format string, which in
370 # the English version expands to the month as a word and the full year. It
371 # is used on the footer of the generated manual pages. If in doubt, you may
372 # just use %x as the value (which should be the full locale-specific date).
373 my $date = enc strftime _("%B %Y"), localtime;
374 my $program = program_basename $ARGV[0];
375 my $package = $program;
380 unlink $opt_output or kark N_("%s: can't unlink %s (%s)"),
381 $this_program, $opt_output, $! if -e $opt_output;
383 open STDOUT, ">$opt_output"
384 or kark N_("%s: can't create %s (%s)"), $this_program, $opt_output, $!;
387 # The first line of the --version information is assumed to be in one
388 # of the following formats:
391 # <program> <version>
392 # {GNU,Free} <program> <version>
393 # <program> ({GNU,Free} <package>) <version>
394 # <program> - {GNU,Free} <package> <version>
396 # and separated from any copyright/author details by a blank line.
398 ($_, $version_text) = ((split /\n+/, $version_text, 2), '');
400 if (/^(\S+) +\(((?:GNU|Free) +[^)]+)\) +(.*)/ or
401 /^(\S+) +- *((?:GNU|Free) +\S+) +(.*)/)
403 $program = program_basename $1;
407 elsif (/^((?:GNU|Free) +)?(\S+) +(.*)/)
409 $program = program_basename $2;
410 $package = $1 ? "$1$program" : $program;
418 # No info for `info' itself.
419 $opt_no_info = 1 if $program eq 'info';
423 # --name overrides --include contents.
424 $replace{_('NAME')} = "$program \\- $opt_name\n";
427 # Translators: "NAME", "SYNOPSIS" and other one or two word strings in all
428 # upper case are manual page section headings. The man(1) manual page in your
429 # language, if available should provide the conventional translations.
430 for ($replace{_('NAME')} || ($include{_('NAME')} ||= ''))
432 if ($_) # Use first name given as $program
434 $program = $1 if /^([^\s,]+)(?:,?\s*[^\s,\\-]+)*\s+\\?-/;
436 else # Set a default (useless) NAME paragraph.
438 $_ = sprintf _("%s \\- manual page for %s %s") . "\n", $program,
443 # Man pages traditionally have the page title in caps.
444 my $PROGRAM = uc $program;
446 # Set default page head/footers
447 $source ||= "$program $version";
452 if (/^(1[Mm]|8)/) { $manual = enc _('System Administration Utilities') }
453 elsif (/^6/) { $manual = enc _('Games') }
454 else { $manual = enc _('User Commands') }
458 # Extract usage clause(s) [if any] for SYNOPSIS.
459 # Translators: "Usage" and "or" here are patterns (regular expressions) which
460 # are used to match the usage synopsis in program output. An example from cp
461 # (GNU coreutils) which contains both strings:
462 # Usage: cp [OPTION]... [-T] SOURCE DEST
463 # or: cp [OPTION]... SOURCE... DIRECTORY
464 # or: cp [OPTION]... -t DIRECTORY SOURCE...
465 my $PAT_USAGE = _('Usage');
466 my $PAT_USAGE_CONT = _('or');
467 if ($help_text =~ s/^($PAT_USAGE):( +(\S+))(.*)((?:\n(?: {6}\1| *($PAT_USAGE_CONT): +\S).*)*)//om)
474 for (split /\n/) { s/^ *(($PAT_USAGE_CONT): +)?//o; push @syn, $_ }
480 $synopsis .= ".br\n" if $synopsis;
482 s/^lt-// if $opt_libtool;
484 $synopsis .= ".B $1\n";
486 s/(([][]|\.\.+)+)/\\fR$1\\fI/g;
487 s/^/\\fI/ unless s/^\\fR//;
498 $include{_('SYNOPSIS')} .= $synopsis;
501 # Process text, initial section is DESCRIPTION.
502 my $sect = _('DESCRIPTION');
503 $_ = "$help_text\n\n$version_text";
505 # Normalise paragraph breaks.
510 # Join hyphenated lines.
511 s/([A-Za-z])-\n *([A-Za-z])/$1$2/g;
513 # Temporarily exchange leading dots, apostrophes and backslashes for
519 # Translators: patterns are used to match common program output. In the source
520 # these strings are all of the form of "my $PAT_something = _('...');" and are
521 # regular expressions. If there is more than one commonly used string, you
522 # may separate alternatives with "|". Spaces in these expressions are written
523 # as " +" to indicate that more than one space may be matched. The string
524 # "(?:[\\w-]+ +)?" in the bug reporting pattern is used to indicate an
525 # optional word, so that either "Report bugs" or "Report _program_ bugs" will
527 my $PAT_BUGS = _('Report +(?:[\w-]+ +)?bugs|Email +bug +reports +to');
528 my $PAT_AUTHOR = _('Written +by');
529 my $PAT_OPTIONS = _('Options');
530 my $PAT_ENVIRONMENT = _('Environment');
531 my $PAT_FILES = _('Files');
532 my $PAT_EXAMPLES = _('Examples');
533 my $PAT_FREE_SOFTWARE = _('This +is +free +software');
535 # Start a new paragraph (if required) for these.
536 s/([^\n])\n($PAT_BUGS|$PAT_AUTHOR) /$1\n\n$2 /og;
538 # Convert iso-8859-1 copyright symbol or (c) to nroff
540 s/^Copyright +(?:\xa9|\([Cc]\))/Copyright \\(co/mg;
544 # Convert some standard paragraph names.
545 if (s/^($PAT_OPTIONS): *\n//o)
547 $sect = _('OPTIONS');
550 if (s/^($PAT_ENVIRONMENT): *\n//o)
552 $sect = _('ENVIRONMENT');
555 if (s/^($PAT_FILES): *\n//o)
560 elsif (s/^($PAT_EXAMPLES): *\n//o)
562 $sect = _('EXAMPLES');
569 $sect = _('COPYRIGHT');
572 # Bug reporting section.
573 elsif (/^($PAT_BUGS) /o)
575 $sect = _('REPORTING BUGS');
579 elsif (/^($PAT_AUTHOR)/o)
584 # Examples, indicated by an indented leading $, % or > are
585 # rendered in a constant width font.
586 if (/^( +)([\$\%>] )\S/)
591 while (s/^$indent\Q$prefix\E(\S.*)\n*//)
593 $include{$sect} .= "$break\n\\f(CW$prefix$1\\fR\n";
602 # Sub-sections have a trailing colon and the second line indented.
603 if (s/^(\S.*:) *\n / /)
605 $matched .= $& if %append_match;
606 $include{$sect} .= qq(.SS "$1"\n);
612 # Option with description.
613 if (s/^( {1,10}([+-]\S.*?))(?:( +(?!-))|\n( {20,}))(\S.*)\n//)
615 $matched .= $& if %append_match;
616 $indent = length ($4 || "$1$3");
617 $content = ".TP\n\x84$2\n\x84$5\n";
620 # Indent may be different on second line.
621 $indent = length $& if /^ {20,}/;
625 # Option without description.
626 elsif (s/^ {1,10}([+-]\S.*)\n//)
628 $matched .= $& if %append_match;
629 $content = ".HP\n\x84$1\n";
630 $indent = 80; # not continued
633 # Indented paragraph with tag.
634 elsif (s/^( +(\S.*?) +)(\S.*)\n//)
636 $matched .= $& if %append_match;
638 $content = ".TP\n\x84$2\n\x84$3\n";
641 # Indented paragraph.
642 elsif (s/^( +)(\S.*)\n//)
644 $matched .= $& if %append_match;
646 $content = ".IP\n\x84$2\n";
649 # Left justified paragraph.
653 $matched .= $& if %append_match;
654 $content = ".PP\n" if $include{$sect};
658 # Append continuations.
659 while ($indent ? s/^ {$indent}(\S.*)\n// : s/^(\S.*)\n//)
661 $matched .= $& if %append_match;
662 $content .= "\x84$1\n";
665 # Move to next paragraph.
670 # Leading dot and apostrophe protection.
675 # Examples should be verbatim.
676 unless ($sect eq _('EXAMPLES'))
679 s/(^|[ (])(-[][\w=-]+)/$1 . convert_option $2/mge;
681 # Italicise filenames: /a/b, $VAR/c/d, ~/e/f
683 (^|[ (]) # space/punctuation before
685 (?:\$\w+|~)? # leading variable, or tilde
686 (?:/\w(?:[\w.-]*\w)?)+ # path components
688 ($|[ ,;.)]) # space/punctuation after
692 # Escape remaining hyphens.
695 if ($sect eq _('COPYRIGHT'))
697 # Insert line breaks before additional copyright messages
698 # and the disclaimer.
699 s/\n(Copyright |$PAT_FREE_SOFTWARE)/\n.br\n$1/og;
701 elsif ($sect eq _('REPORTING BUGS'))
703 # Handle multi-line bug reporting sections of the form:
705 # Report <program> bugs to <addr>
706 # GNU <package> home page: <url>
708 s/\n([[:upper:]])/\n.br\n$1/g;
712 # Check if matched paragraph contains /pat/.
715 for my $pat (keys %append_match)
717 if ($matched =~ $pat)
719 $content .= ".PP\n" unless $append_match{$pat} =~ /^\./;
720 $content .= $append_match{$pat};
725 $include{$sect} .= $content;
728 # Refer to the real documentation.
729 unless ($opt_no_info)
731 my $info_page = $opt_info || $program;
733 $sect = _('SEE ALSO');
734 $include{$sect} .= ".PP\n" if $include{$sect};
735 $include{$sect} .= sprintf _(<<'EOT'), $program, $program, $info_page;
736 The full documentation for
738 is maintained as a Texinfo manual. If the
742 programs are properly installed at your site, the command
746 should give you access to the complete manual.
750 # Append additional text.
751 while (my ($sect, $text) = each %append)
753 $include{$sect} .= $append{$sect};
757 while (my ($sect, $text) = each %replace)
759 $include{$sect} = $replace{$sect};
764 .\\" DO NOT MODIFY THIS FILE! It was generated by $this_program $this_version.
765 .TH $PROGRAM "$section" "$date" "$source" "$manual"
769 my @pre = (_('NAME'), _('SYNOPSIS'), _('DESCRIPTION'), _('OPTIONS'),
770 _('ENVIRONMENT'), _('FILES'), _('EXAMPLES'));
772 my @post = (_('AUTHOR'), _('REPORTING BUGS'), _('COPYRIGHT'), _('SEE ALSO'));
773 my $filter = join '|', @pre, @post;
776 for my $sect (@pre, (grep ! /^($filter)$/o, @include), @post)
780 my $quote = $sect =~ /\W/ ? '"' : '';
781 print enc ".SH $quote$sect$quote\n";
783 for ($include{$sect})
785 # Replace leading dot, apostrophe, backslash and hyphen
792 # Convert some latin1 chars to troff equivalents
793 s/\xa0/\\ /g; # non-breaking space
800 close STDOUT or kark N_("%s: error writing to %s (%s)"), $this_program,
801 $opt_output || 'stdout', $!;
805 # Get program basename, and strip libtool "lt-" prefix if required.
810 s/^lt-// if $opt_libtool;
814 # Call program with given option and return results.
817 my ($prog, $opt) = @_;
818 my $stderr = $discard_stderr ? '/dev/null' : '&1';
820 map { s/ +$//; expand $_ }
822 `$prog $opt 2>$stderr`;
826 my $err = N_("%s: can't get `%s' info from %s%s");
827 my $extra = $discard_stderr
828 ? "\n" . N_("Try `--no-discard-stderr' if option outputs to stderr")
831 kark $err, $this_program, $opt, $prog, $extra;
837 # Convert option dashes to \- to stop nroff from hyphenating 'em, and
838 # embolden. Option arguments get italicised.
841 local $_ = '\fB' . shift;
844 unless (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/)
855 # Rename output and fix permissions
856 unless ($opts{stdout})
859 rename $tmp, $target or die "$0: can't rename $tmp to $target ($!)\n";
860 chmod 0555, $target or warn "$0: can't change mode of $target ($!)\n";