1# $Id: manlinks.sed,v 1.12 2003/12/20 13:17:56 tom Exp $
2##############################################################################
3# Copyright (c) 2000-2002,2003 Free Software Foundation, Inc.                #
4#                                                                            #
5# Permission is hereby granted, free of charge, to any person obtaining a    #
6# copy of this software and associated documentation files (the "Software"), #
7# to deal in the Software without restriction, including without limitation  #
8# the rights to use, copy, modify, merge, publish, distribute, distribute    #
9# with modifications, sublicense, and/or sell copies of the Software, and to #
10# permit persons to whom the Software is furnished to do so, subject to the  #
11# following conditions:                                                      #
12#                                                                            #
13# The above copyright notice and this permission notice shall be included in #
14# all copies or substantial portions of the Software.                        #
15#                                                                            #
16# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #
17# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   #
18# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    #
19# THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      #
20# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    #
21# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        #
22# DEALINGS IN THE SOFTWARE.                                                  #
23#                                                                            #
24# Except as contained in this notice, the name(s) of the above copyright     #
25# holders shall not be used in advertising or otherwise to promote the sale, #
26# use or other dealings in this Software without prior written               #
27# authorization.                                                             #
28##############################################################################
29# Given a manpage (nroff) as input, writes a list of the names that are
30# listed in the "NAME" section, i.e., the names that we would like to use
31# as aliases for the manpage -T.Dickey
32#
33# eliminate formatting controls that get in the way
34/^'\\"/d
35/\.\\"/d
36/^\.br/d
37/^\.sp/d
38s/^\.IX//
39s/\\f.//g
40s/[:,]/ /g
41#
42# eliminate unnecessary whitespace, convert multiple blanks to single space
43s/^[ 	][ 	]*//
44s/[ 	][ 	]*$//
45s/[ 	][ 	]*/ /g
46#
47# convert ".SH" into a more manageable form
48s/\.SH[ 	][ 	]*/.SH_(/
49#
50# in ".SH NAME"
51# change "\-" to "-", eliminate text after "-", and split the remaining lines
52# at each space, making a list of names:
53/^\.SH_(NAME/,/^\.SH_(SYNOPSIS/{
54s/\\-.*/ -/
55/ -/{
56s/ -.*//
57s/ /\
58/g
59}
60/^-/{
61d
62}
63s/ /\
64/g
65}
66#
67# in ".SH SYNOPSIS"
68# remove any line that does not contain a '(', since we only want functions.
69# then strip off return-type of each function.
70# finally, remove the parameter list, which begins with a '('.
71/^\.SH_(SYNOPSIS/,/^\.SH_(DESCRIPTION/{
72/^[^(]*$/d
73# reduce
74#	.B "int add_wch( const cchar_t *\fIwch\fB );"
75# to
76#	add_wch( const cchar_t *\fIwch\fB );"
77s/^\([^ (]* [^ (]* [*]*\)//g
78s/^\([^ (]* [*]*\)//g
79# trim blanks in case we have
80#	void (*) (FORM *) field_init(const FORM *form);
81s/) (/)(/g
82# reduce stuff like
83#	void (*)(FORM *) field_init(const FORM *form);
84# to
85#	field_init(const FORM *form);
86s/^\(([^)]*)\)\(([^)]*)\)*[ ]*//g
87# rename marker temporarily
88s/\.SH_(/.SH_/
89# kill lines with ");", and trim off beginning of argument list.
90s/[()].*//
91# rename marker back
92s/\.SH_/.SH_(/
93}
94#
95# delete ".SH DESCRIPTION" and following lines
96/^\.SH_(DESCRIPTION/,${
97d
98}
99#
100# delete any remaining directives
101/^\./d
102