suntouch-manpages.pl revision 70
98N/A#!/usr/perl5/bin/perl -w
98N/A
98N/A#
98N/A# Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
943N/A# Use subject to license terms.
98N/A#
98N/A# Permission is hereby granted, free of charge, to any person obtaining a
919N/A# copy of this software and associated documentation files (the
919N/A# "Software"), to deal in the Software without restriction, including
919N/A# without limitation the rights to use, copy, modify, merge, publish,
919N/A# distribute, and/or sell copies of the Software, and to permit persons
919N/A# to whom the Software is furnished to do so, provided that the above
919N/A# copyright notice(s) and this permission notice appear in all copies of
919N/A# the Software and that both the above copyright notice(s) and this
919N/A# permission notice appear in supporting documentation.
919N/A#
919N/A# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
919N/A# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
919N/A# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
919N/A# OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
919N/A# HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
919N/A# INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
919N/A# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
919N/A# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
98N/A# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
98N/A#
98N/A# Except as contained in this notice, the name of a copyright holder
98N/A# shall not be used in advertising or otherwise to promote the sale, use
493N/A# or other dealings in this Software without prior written authorization
98N/A# of the copyright holder.
970N/A#
970N/A# @(#)suntouch-manpages.pl 1.3 06/10/02
970N/A#
970N/A
98N/A# Updates manual pages to include standard Sun man page sections
851N/A#
98N/A# Arguments:
911N/A# -a '{attribute, value}, ...' - entries for Attributes section table
911N/A# -l libname - add library line to synopsis
911N/A# -p path - add path to command in synopsis
911N/A
98N/Ause Getopt::Std;
98N/Ause integer;
98N/Ause strict;
98N/A
98N/Amy %opts;
493N/Agetopts('a:l:p:', \%opts);
98N/A
970N/Amy $add_attributes = 0;
970N/Amy $attributes;
970N/A
98N/Aif (exists($opts{"a"})) {
$add_attributes = 1;
$attributes = $opts{"a"};
}
my $add_library_to_synopsis = 0;
my $library;
if (exists($opts{"l"})) {
$add_library_to_synopsis = 1;
$library = $opts{"l"};
}
my $add_path_to_synopsis = 0;
my $synpath;
if (exists($opts{"p"})) {
$add_path_to_synopsis = 1;
$synpath = $opts{"p"};
}
my $filename;
while ($filename = shift) {
rename($filename, "$filename.orig")
|| die "Cannot rename $filename to $filename.orig";
open(IN, "<$filename.orig")
|| die "Cannot read $filename.orig";
open(OUT, ">$filename")
|| die "Cannot write to $filename";
my $firstline = <IN>;
if ($add_attributes) {
# Check for man page preprocessor list - if found, make sure t is in it for
# table processing, if not found, add one;
if ($firstline =~ m/\'\\\"/) {
# Found preprocessor list
if ($firstline =~ m/t/) {
# Do nothing - tbl preprocessing already selected
} else {
chomp($firstline);
$firstline .= "t\n";
}
} else {
# No preprocessor list found
print OUT q('\" t), "\n";
}
}
print OUT $firstline;
my $nextline;
while ($nextline = <IN>) {
print OUT $nextline;
if ($nextline =~ m/.SH[\s "]*(SYNOPSIS|SYNTAX)/) {
if ($add_library_to_synopsis) {
print OUT ".nf\n",
q(\fBcc\fR [ \fIflag\fR\&.\&.\&. ] \fIfile\fR\&.\&.\&. \fB\-l),
$library, q(\fR [ \fIlibrary\fR\&.\&.\&. ]), "\n.fi\n";
}
elsif ($add_path_to_synopsis) {
$nextline = <IN>;
$nextline =~ s/^(\.B[IR]*\s+\"?)/$1$synpath/;
print OUT $nextline;
}
}
}
if ($add_attributes) {
print OUT &get_attributes_table($attributes);
}
close(IN);
close(OUT);
}
sub get_attributes_table {
my $attribute_list = $_[0];
my $attributes_table = q{
.\\" Begin Sun update
.SH "ATTRIBUTES"
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.TS
allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPE ATTRIBUTE VALUE
<attributes>
.TE
.sp
.\\" End Sun update
};
# Parse input list of attributes
$attribute_list =~ s/^\s*{//;
$attribute_list =~ s/}\s*$//;
my @attribs = split /}\s*{/, $attribute_list;
my $a;
my $attribute_entries = "";
foreach $a (@attribs) {
my ($name, $value) = split /,\s*/, $a, 2;
$attribute_entries .= $name . "\t" . $value . "\n";
}
$attributes_table =~ s/<attributes>\n/$attribute_entries/;
return $attributes_table;
}