summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJim Meyering <jim@meyering.net>1999-07-10 07:28:05 +0000
committerJim Meyering <jim@meyering.net>1999-07-10 07:28:05 +0000
commit40c0f1464867dd8d94a46020d8c0631aaa449b66 (patch)
treea094dd5a61c9f8bf8e74985722db084387918358 /man
parent7f445793253dcfa48642807fef0a9d1147b260f2 (diff)
downloadcoreutils-40c0f1464867dd8d94a46020d8c0631aaa449b66.tar.xz
Import version 1.011.
Diffstat (limited to 'man')
-rwxr-xr-xman/help2man105
1 files changed, 49 insertions, 56 deletions
diff --git a/man/help2man b/man/help2man
index c4ef0c815..fde8e53fd 100755
--- a/man/help2man
+++ b/man/help2man
@@ -22,10 +22,11 @@
use 5.004;
use strict;
use Getopt::Long;
+use Text::Tabs qw(expand);
use POSIX qw(strftime setlocale LC_TIME);
my $this_program = 'help2man';
-my $this_version = '1.010';
+my $this_version = '1.011';
my $version_info = <<EOT;
$this_program $this_version
@@ -124,11 +125,14 @@ if ($include or $opt_include)
# Turn off localisation of date (for strftime)
setlocale LC_TIME, 'C';
+# Expand tabs, strip trailing spaces and break into paragraphs
+sub paragraphs { split /\n\n+/, join '', expand @_ }
+
# Grab help and version paragraphs from executable
-my @help = split /\n\n+/, `$ARGV[0] --help 2>/dev/null`
+my @help = paragraphs `$ARGV[0] --help 2>/dev/null`
or die "$this_program: can't get `--help' info from $ARGV[0]\n";
-my @version = split /\n\n+/, `$ARGV[0] --version 2>/dev/null`
+my @version = paragraphs `$ARGV[0] --version 2>/dev/null`
or die "$this_program: can't get `--version' info from $ARGV[0]\n";
my $date = strftime "%B %Y", localtime;
@@ -159,14 +163,14 @@ if ($opt_output)
$_ = shift @version;
-if (/^(\S+)\s+\(((?:GNU|Free)\s+[^)]+)\)\s+(.*)/ or
- /^(\S+)\s+-\s*((?:GNU|Free)\s+\S+)\s+(.*)/)
+if (/^(\S+) +\(((?:GNU|Free) +[^)]+)\) +(.*)/ or
+ /^(\S+) +- *((?:GNU|Free) +\S+) +(.*)/)
{
$program = $1;
$package = $2;
$version = $3;
}
-elsif (/^((?:GNU|Free)\s+)?(\S+)\s+(.*)/)
+elsif (/^((?:GNU|Free) +)?(\S+) +(.*)/)
{
$program = $2;
$package = $1 ? "$1$2" : $2;
@@ -209,7 +213,7 @@ for (@help)
{
chomp;
- if (s/^Usage:\s+\S+\s+(.*)\n?//)
+ if (s/^Usage: +\S+ +(.*)\n?//)
{
# Turn the usage clause into a synopsis.
my $synopsis = '';
@@ -219,13 +223,13 @@ for (@help)
$syn =~ s/(([][]|\.\.+)+)/\\fR$1\\fI/g;
$syn =~ s/^/\\fI/ unless $syn =~ s/^\\fR//;
$syn .= '\fR';
- $syn =~ s/\\fI(\s*)\\fR/$1/g;
+ $syn =~ s/\\fI( *)\\fR/$1/g;
$synopsis .= ".br\n" unless $accumulate;
$synopsis .= ".B $program\n";
$synopsis .= "$syn\n";
$accumulate = 0;
- } while s/^(?:Usage|\s*or):\s+\S+\s+(.*)\n?//;
+ } while s/^(?:Usage| *or): +\S+ +(.*)\n?//;
# Include file overrides SYNOPSIS.
print ".SH SYNOPSIS\n", $include{SYNOPSIS} || $synopsis;
@@ -253,7 +257,7 @@ for (@help)
}
# Convert some standard paragraph names
- if (s/^(Options|Examples):\s*\n//)
+ if (s/^(Options|Examples): *\n//)
{
print qq(.SH \U$1\n);
next unless length;
@@ -266,56 +270,45 @@ for (@help)
next;
}
- # Special case for tar 1.12: --label=NAME\nPATTERN.
- s{(\n[ \t]*)(-V,[ \t]+--label=NAME.*)\n[ \t]+PATTERN[ \t]+}
- {$1$2$1\\&...=PATTERN };
-
- # Convert options.
- s/((?:^|,)\s+)(-[][\w=-]+|\\&\S+)/$1 . convert_option $2/mge;
-
# Option subsections have second line indented.
- print qq(.SS "$1"\n) if s/^(\S.*)\n(\s)/$2/;
+ print qq(.SS "$1"\n) if s/^(\S.*)\n / /;
- my $ind = 0;
- for (split /\n/)
+ my $output = '';
+ while (length)
{
- # indented paragraph
- if (/^\s/)
+ my $indent = 0;
+
+ # Tagged paragraph
+ if (s/^( +(\S.*?) +)(\S.*)\n?//)
{
- # Join continued lines when indented to the same point as
- # text following at least two spaces on the previous line.
- if ($ind > 0 and /^ {$ind}\S/)
- {
- s/^\s+//;
- print "$_\n" if $_;
- }
- else
- {
- # use the words(s) before two or more spaces for the
- # tag
- s/^(\s+)//;
- $ind = length $1;
-
- if (s/(\s\s+)/\n/)
- {
- $ind += (length $1) + index $_, "\n";
- }
- else
- {
- $ind = 0;
- }
-
- print ".TP\n$_\n" if $_;
- }
+ $indent = length $1;
+ $output .= ".TP\n$2\n$3\n";
}
- # Anything else.
+
+ # Indented paragraph
+ elsif (s/^( +)(\S.*)\n?//)
+ {
+ $indent = length $1;
+ $output .= ".IP\n$2\n";
+ }
+
+ # Left justified paragraph
else
{
- print ".PP\n" unless $ind < 0;
- print "$_\n";
- $ind = -1;
+ s/(.*)\n?//;
+ $output .= ".PP\n" if $output;
+ $output .= "$1\n";
}
+
+ # Continuations
+ $output .= "$1\n" while s/^ {$indent}(\S.*)\n?//;
}
+
+ $_ = $output;
+
+ # Convert options.
+ s/(^| )(-[][\w=-]+)/$1 . convert_option $2/mge;
+ print;
}
# Print any include items other than the ones we have already dealt
@@ -356,16 +349,16 @@ for (@version)
s/([A-Za-z])-\n */$1/g;
# Convert copyright symbol or (c) to nroff character.
- s/Copyright\s+(?:\xa9|\([Cc]\))/Copyright \\(co/g;
+ s/Copyright +(?:\xa9|\([Cc]\))/Copyright \\(co/g;
# Insert appropriate headings for copyright and author.
- if (/^Copyright\s\\/) { print ".SH COPYRIGHT\n" }
- elsif (/^Written\s+by/) { print ".SH AUTHOR\n" }
- else { print ".PP\n"; }
+ if (/^Copyright \\/) { print ".SH COPYRIGHT\n" }
+ elsif (/^Written +by/) { print ".SH AUTHOR\n" }
+ else { print ".PP\n"; }
# Insert line breaks before additional copyright messages and the
# disclaimer.
- s/(.)\n(Copyright\s|This is free software)/$1\n.br\n$2/g;
+ s/(.)\n(Copyright |This is free software)/$1\n.br\n$2/g;
print "$_\n";
}