From: John Mandereau Date: Wed, 19 Sep 2012 11:07:16 +0000 (+0200) Subject: Update help2man to 1.40.12 X-Git-Tag: release/2.17.4-1~31 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=244ad7cc416a47f1567a3a221fcb05da5d90915e;p=lilypond.git Update help2man to 1.40.12 --- diff --git a/scripts/build/help2man.pl b/scripts/build/help2man.pl index 4c61852024..41d7ac099b 100644 --- a/scripts/build/help2man.pl +++ b/scripts/build/help2man.pl @@ -1,12 +1,12 @@ #!@PERL@ -w # Generate a short man page from --help and --version output. -# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Free Software -# Foundation, Inc. +# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, +# 2010, 2011, 2012 Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2, or (at your option) +# the Free Software Foundation; either version 3, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, @@ -15,54 +15,73 @@ # GNU General Public License for more details. # You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software Foundation, -# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +# along with this program; if not, see . # Written by Brendan O'Dea # Available from ftp://ftp.gnu.org/gnu/help2man/ -use 5.005; +use 5.008; use strict; use Getopt::Long; use Text::Tabs qw(expand); -use POSIX qw(strftime setlocale LC_TIME); +use POSIX qw(strftime setlocale LC_ALL); my $this_program = 'help2man'; -my $this_version = '1.28'; -my $version_info = < +Written by Brendan O'Dea EOT -my $help_info = <. +Report bugs to . EOT my $section = 1; @@ -70,30 +89,33 @@ my $manual = ''; my $source = ''; my $help_option = '--help'; my $version_option = '--version'; -my ($opt_name, @opt_include, $opt_output, $opt_info, $opt_no_info); +my $discard_stderr = 1; +my ($opt_name, @opt_include, $opt_output, $opt_info, $opt_no_info, $opt_libtool, + $version_text); my %opt_def = ( 'n|name=s' => \$opt_name, 's|section=s' => \$section, 'm|manual=s' => \$manual, 'S|source=s' => \$source, + 'L|locale=s' => sub { configure_locale pop }, 'i|include=s' => sub { push @opt_include, [ pop, 1 ] }, 'I|opt-include=s' => sub { push @opt_include, [ pop, 0 ] }, 'o|output=s' => \$opt_output, 'p|info-page=s' => \$opt_info, 'N|no-info' => \$opt_no_info, + 'l|libtool' => \$opt_libtool, + 'help' => sub { print $help_info; exit }, + 'version' => sub { print $version_info; exit }, 'h|help-option=s' => \$help_option, 'v|version-option=s' => \$version_option, + 'version-string=s' => \$version_text, + 'discard-stderr!' => \$discard_stderr, ); # Parse options. Getopt::Long::config('bundling'); -GetOptions (%opt_def, - help => sub { print $help_info; exit }, - version => sub { print $version_info; exit }, -) or die $help_info; - -die $help_info unless @ARGV == 1; +die $help_info unless GetOptions %opt_def and @ARGV == 1; my %include = (); my %append = (); @@ -115,7 +137,7 @@ while (@opt_include) my ($inc, $required) = @{shift @opt_include}; next unless -f $inc or $required; - die "$this_program: can't open `$inc' ($!)\n" + kark N_("%s: can't open `%s' (%s)"), $this_program, $inc, $! unless open INC, $inc; my $key; @@ -123,8 +145,12 @@ while (@opt_include) while () { + # Convert input to internal Perl format, so that multibyte + # sequences are treated as single characters. + $_ = dec $_; + # [section] - if (/^\[([^]]+)\]/) + if (/^\[([^]]+)\]\s*$/) { $key = uc $1; $key =~ s/^\s+//; @@ -135,7 +161,7 @@ while (@opt_include) } # /pattern/ - if (m!^/(.*)/([ims]*)!) + if (m!^/(.*)/([ims]*)\s*$!) { my $pat = $2 ? "(?$2)$1" : $1; @@ -172,7 +198,7 @@ while (@opt_include) close INC; - die "$this_program: no valid information found in `$inc'\n" + kark N_("%s: no valid information found in `%s'"), $this_program, $inc unless $key; } @@ -182,31 +208,28 @@ for my $hash (\(%include, %append)) for (keys %$hash) { $hash->{$_} =~ s/\n+$/\n/ } } -# Turn off localisation of executable's output. -@ENV{qw(LANGUAGE LANG LC_ALL)} = ('C') x 3; - -# Turn off localisation of date (for strftime). -setlocale LC_TIME, 'C'; +sub get_option_value; # Grab help and version info from executable. -my ($help_text, $version_text) = map { - join '', map { s/ +$//; expand $_ } `$ARGV[0] $_` - or die "$this_program: can't get `$_' info from $ARGV[0]\n" -} $help_option, $version_option; - -my $date = strftime "%B %Y", localtime; +my $help_text = get_option_value $ARGV[0], $help_option; +$version_text ||= get_option_value $ARGV[0], $version_option; + +# Translators: the following message is a strftime(3) format string, which in +# the English version expands to the month as a word and the full year. It +# is used on the footer of the generated manual pages. If in doubt, you may +# just use %x as the value (which should be the full locale-specific date). +my $date = enc strftime _("%B %Y"), localtime; (my $program = $ARGV[0]) =~ s!.*/!!; my $package = $program; my $version; if ($opt_output) { - unlink $opt_output - or die "$this_program: can't unlink $opt_output ($!)\n" - if -e $opt_output; + unlink $opt_output or kark N_("%s: can't unlink %s (%s)"), + $this_program, $opt_output, $! if -e $opt_output; open STDOUT, ">$opt_output" - or die "$this_program: can't create $opt_output ($!)\n"; + or kark N_("%s: can't create %s (%s)"), $this_program, $opt_output, $!; } # The first line of the --version information is assumed to be in one @@ -220,7 +243,7 @@ if ($opt_output) # # and separated from any copyright/author details by a blank line. -($_, $version_text) = split /\n+/, $version_text, 2; +($_, $version_text) = ((split /\n+/, $version_text, 2), ''); if (/^(\S+) +\(((?:GNU|Free) +[^)]+)\) +(.*)/ or /^(\S+) +- *((?:GNU|Free) +\S+) +(.*)/) @@ -245,11 +268,25 @@ $program =~ s!.*/!!; # No info for `info' itself. $opt_no_info = 1 if $program eq 'info'; -# --name overrides --include contents. -$include{NAME} = "$program \\- $opt_name\n" if $opt_name; - -# Default (useless) NAME paragraph. -$include{NAME} ||= "$program \\- manual page for $program $version\n"; +# Translators: "NAME", "SYNOPSIS" and other one or two word strings in all +# upper case are manual page section headings. The man(1) manual page in your +# language, if available should provide the conventional translations. +for ($include{_('NAME')}) +{ + if ($opt_name) # --name overrides --include contents. + { + $_ = "$program \\- $opt_name\n"; + } + elsif ($_) # Use first name given as $program + { + $program = $1 if /^([^\s,]+)(?:,?\s*[^\s,\\-]+)*\s+\\?-/; + } + else # Set a default (useless) NAME paragraph. + { + $_ = sprintf _("%s \\- manual page for %s %s") . "\n", $program, + $program, $version; + } +} # Man pages traditionally have the page title in caps. my $PROGRAM = uc $program; @@ -260,21 +297,29 @@ unless ($manual) { for ($section) { - if (/^(1[Mm]|8)/) { $manual = 'System Administration Utilities' } - elsif (/^6/) { $manual = 'Games' } - else { $manual = 'User Commands' } + if (/^(1[Mm]|8)/) { $manual = enc _('System Administration Utilities') } + elsif (/^6/) { $manual = enc _('Games') } + else { $manual = enc _('User Commands') } } } # Extract usage clause(s) [if any] for SYNOPSIS. -if ($help_text =~ s/^Usage:( +(\S+))(.*)((?:\n(?: {6}\1| *or: +\S).*)*)//m) +# Translators: "Usage" and "or" here are patterns (regular expressions) which +# are used to match the usage synopsis in program output. An example from cp +# (GNU coreutils) which contains both strings: +# Usage: cp [OPTION]... [-T] SOURCE DEST +# or: cp [OPTION]... SOURCE... DIRECTORY +# or: cp [OPTION]... -t DIRECTORY SOURCE... +my $PAT_USAGE = _('Usage'); +my $PAT_USAGE_CONT = _('or'); +if ($help_text =~ s/^($PAT_USAGE):( +(\S+))(.*)((?:\n(?: {6}\1| *($PAT_USAGE_CONT): +\S).*)*)//om) { - my @syn = $2 . $3; + my @syn = $3 . $4; - if ($_ = $4) + if ($_ = $5) { s/^\n//; - for (split /\n/) { s/^ *(or: +)?//; push @syn, $_ } + for (split /\n/) { s/^ *(($PAT_USAGE_CONT): +)?//o; push @syn, $_ } } my $synopsis = ''; @@ -282,6 +327,7 @@ if ($help_text =~ s/^Usage:( +(\S+))(.*)((?:\n(?: {6}\1| *or: +\S).*)*)//m) { $synopsis .= ".br\n" if $synopsis; s!^\S*/!!; + s/^lt-// if $opt_libtool; s/^(\S+) *//; $synopsis .= ".B $1\n"; s/\s+$//; @@ -297,11 +343,11 @@ if ($help_text =~ s/^Usage:( +(\S+))(.*)((?:\n(?: {6}\1| *or: +\S).*)*)//m) $synopsis .= "$_\n"; } - $include{SYNOPSIS} ||= $synopsis; + $include{_('SYNOPSIS')} ||= $synopsis; } # Process text, initial section is DESCRIPTION. -my $sect = 'DESCRIPTION'; +my $sect = _('DESCRIPTION'); $_ = "$help_text\n\n$version_text"; # Normalise paragraph breaks. @@ -309,68 +355,80 @@ s/^\n+//; s/\n*$/\n/; s/\n\n+/\n\n/g; +# Join hyphenated lines. +s/([A-Za-z])-\n *([A-Za-z])/$1$2/g; + # Temporarily exchange leading dots, apostrophes and backslashes for # tokens. s/^\./\x80/mg; s/^'/\x81/mg; s/\\/\x82/g; +# Translators: patterns are used to match common program output. In the source +# these strings are all of the form of "my $PAT_something = _('...');" and are +# regular expressions. If there is more than one commonly used string, you +# may separate alternatives with "|". Spaces in these expressions are written +# as " +" to indicate that more than one space may be matched. The string +# "(?:[\\w-]+ +)?" in the bug reporting pattern is used to indicate an +# optional word, so that either "Report bugs" or "Report _program_ bugs" will +# be matched. +my $PAT_BUGS = _('Report +(?:[\w-]+ +)?bugs|Email +bug +reports +to'); +my $PAT_AUTHOR = _('Written +by'); +my $PAT_OPTIONS = _('Options'); +my $PAT_ENVIRONMENT = _('Environment'); +my $PAT_FILES = _('Files'); +my $PAT_EXAMPLES = _('Examples'); +my $PAT_FREE_SOFTWARE = _('This +is +free +software'); + # Start a new paragraph (if required) for these. -s/([^\n])\n(Report +bugs|Email +bug +reports +to|Written +by)/$1\n\n$2/g; +s/([^\n])\n($PAT_BUGS|$PAT_AUTHOR) /$1\n\n$2 /og; + +# Convert iso-8859-1 copyright symbol or (c) to nroff +# character. +s/^Copyright +(?:\xa9|\([Cc]\))/Copyright \\(co/mg; sub convert_option; while (length) { # Convert some standard paragraph names. - if (s/^(Options|Examples): *\n//) + if (s/^($PAT_OPTIONS): *\n//o) + { + $sect = _('OPTIONS'); + next; + } + if (s/^($PAT_ENVIRONMENT): *\n//o) { - $sect = uc $1; + $sect = _('ENVIRONMENT'); + next; + } + if (s/^($PAT_FILES): *\n//o) + { + $sect = _('FILES'); + next; + } + elsif (s/^($PAT_EXAMPLES): *\n//o) + { + $sect = _('EXAMPLES'); next; } # Copyright section - if (/^Copyright +[(\xa9]/) + if (/^Copyright /) { - $sect = 'COPYRIGHT'; - $include{$sect} ||= ''; - $include{$sect} .= ".PP\n" if $include{$sect}; - - my $copy; - ($copy, $_) = split /\n\n/, $_, 2; - - for ($copy) - { - # Add back newline - s/\n*$/\n/; - - # Convert iso9959-1 copyright symbol or (c) to nroff - # character. - s/^Copyright +(?:\xa9|\([Cc]\))/Copyright \\(co/mg; - - # Insert line breaks before additional copyright messages - # and the disclaimer. - s/(.)\n(Copyright |This +is +free +software)/$1\n.br\n$2/g; - - # Join hyphenated lines. - s/([A-Za-z])-\n */$1/g; - } - - $include{$sect} .= $copy; - $_ ||= ''; - next; + $sect = _('COPYRIGHT'); } - # Catch bug report text. - if (/^(Report +bugs|Email +bug +reports +to) /) + # Bug reporting section. + elsif (/^($PAT_BUGS) /o) { - $sect = 'REPORTING BUGS'; + $sect = _('REPORTING BUGS'); } # Author section. - elsif (/^Written +by/) + elsif (/^($PAT_AUTHOR)/o) { - $sect = 'AUTHOR'; + $sect = _('AUTHOR'); } # Examples, indicated by an indented leading $, % or > are @@ -408,7 +466,7 @@ while (length) { $matched .= $& if %append; $indent = length ($4 || "$1$3"); - $content = ".TP\n\x83$2\n\x83$5\n"; + $content = ".TP\n\x84$2\n\x84$5\n"; unless ($4) { # Indent may be different on second line. @@ -420,7 +478,7 @@ while (length) elsif (s/^ {1,10}([+-]\S.*)\n//) { $matched .= $& if %append; - $content = ".HP\n\x83$1\n"; + $content = ".HP\n\x84$1\n"; $indent = 80; # not continued } @@ -429,7 +487,7 @@ while (length) { $matched .= $& if %append; $indent = length $1; - $content = ".TP\n\x83$2\n\x83$3\n"; + $content = ".TP\n\x84$2\n\x84$3\n"; } # Indented paragraph. @@ -437,7 +495,7 @@ while (length) { $matched .= $& if %append; $indent = length $1; - $content = ".IP\n\x83$2\n"; + $content = ".IP\n\x84$2\n"; } # Left justified paragraph. @@ -450,10 +508,10 @@ while (length) } # Append continuations. - while (s/^ {$indent}(\S.*)\n//) + while ($indent ? s/^ {$indent}(\S.*)\n// : s/^(\S.*)\n//) { $matched .= $& if %append; - $content .= "\x83$1\n" + $content .= "\x84$1\n"; } # Move to next paragraph. @@ -462,12 +520,31 @@ while (length) for ($content) { # Leading dot and apostrophe protection. - s/\x83\./\x80/g; - s/\x83'/\x81/g; - s/\x83//g; + s/\x84\./\x80/g; + s/\x84'/\x81/g; + s/\x84//g; # Convert options. - s/(^| )(-[][\w=-]+)/$1 . convert_option $2/mge; + s/(^| |\()(-[][\w=-]+)/$1 . convert_option $2/mge; + + # Escape remaining hyphens + s/-/\x83/g; + + if ($sect eq 'COPYRIGHT') + { + # Insert line breaks before additional copyright messages + # and the disclaimer. + s/\n(Copyright |$PAT_FREE_SOFTWARE)/\n.br\n$1/og; + } + elsif ($sect eq 'REPORTING BUGS') + { + # Handle multi-line bug reporting sections of the form: + # + # Report bugs to + # GNU home page: + # ... + s/\n([[:upper:]])/\n.br\n$1/g; + } } # Check if matched paragraph contains /pat/. @@ -491,19 +568,19 @@ unless ($opt_no_info) { my $info_page = $opt_info || $program; - $sect = 'SEE ALSO'; + $sect = _('SEE ALSO'); $include{$sect} ||= ''; $include{$sect} .= ".PP\n" if $include{$sect}; - $include{$sect} .= <$stderr`; + + unless ($value) + { + my $err = N_("%s: can't get `%s' info from %s%s"); + my $extra = $discard_stderr + ? "\n" . N_("Try `--no-discard-stderr' if option outputs to stderr") + : ''; + + kark $err, $this_program, $opt, $prog, $extra; + } + + return $value; +} + # Convert option dashes to \- to stop nroff from hyphenating 'em, and # embolden. Option arguments get italicised. sub convert_option { local $_ = '\fB' . shift; - s/-/\\-/g; + s/-/\x83/g; unless (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/) { s/=(.)/\\fR=\\fI$1/;