-# $Id: manlinks.sed,v 1.7 2000/07/01 19:50:06 tom Exp $
+# $Id: manlinks.sed,v 1.21 2024/04/20 22:25:36 tom Exp $
##############################################################################
-# Copyright (c) 2000 Free Software Foundation, Inc. #
+# Copyright 2020-2023,2024 Thomas E. Dickey #
+# Copyright 2000-2003,2008 Free Software Foundation, Inc. #
# #
# Permission is hereby granted, free of charge, to any person obtaining a #
# copy of this software and associated documentation files (the "Software"), #
# Given a manpage (nroff) as input, writes a list of the names that are
# listed in the "NAME" section, i.e., the names that we would like to use
# as aliases for the manpage -T.Dickey
+#
+# workaround for manpages without a SYNOPSIS
+s/^\.\\"SH/.SH/
+#
+# eliminate formatting controls that get in the way
/^'\\"/d
/\.\\"/d
/^\.br/d
/^\.sp/d
+/typedef/d
+s/^\.IX//
s/\\f.//g
+s/\\%//g
s/[:,]/ /g
+#
+# ignore C-style comments
+s%/\*.*\*/%%
+#
+# Eliminate unnecessary whitespace, convert multiple blanks to single space.
s/^[ ][ ]*//
s/[ ][ ]*$//
s/[ ][ ]*/ /g
+/^$/d
+#
+# convert ".SH" into a more manageable form
s/\.SH[ ][ ]*/.SH_(/
#
-/^\.SH_(NAME/,/^\.SH_(SYNOPSIS/{
-s/\\-.*/ -/
-/ -/{
- s/ -.*//
- s/ /\
-/g
-}
-/^-/{
- d
+# in ".SH NAME"
+# Convert a list of names separated from their description by " \-" to a list
+# of names on separate lines. Normally the list is also comma-separated, but
+# we ignore that detail here. The description is on a separate line to make
+# the nroff source more pleasing to some eyes.
+/^\.SH_(NAME/,/ \\-$/{
+s/\\-/-/g
+s/ / /g
+/ -$/{
+s/ -$//
+n
+d
}
s/ /\
/g
}
-:syn
+#
+# in ".SH SYNOPSIS"
+# For readability, the NAME section may not contain all function names, but we
+# still want to make aliases for those. Do this by extracting names from the
+# list of function prototypes in the synopsis.
+#
+# Remove any line that does not contain a '(', since we only want functions.
+# then strip off return-type of each function.
+#
+# Finally, remove the parameter list, which begins with a '('.
/^\.SH_(SYNOPSIS/,/^\.SH_(DESCRIPTION/{
- /^#/d
- /^[^(]*$/d
- s/^\([^ (]\+ [*]*\)\+//g
- s/\.SH_(/.SH_/
- s/(.*//
- s/\.SH_/.SH_(/
+/^\.ti/d
+/^[^(]*$/d
+# reduce
+# .B "int add_wch( const cchar_t *\fIwch\fB );"
+# to
+# add_wch( const cchar_t *\fIwch\fB );"
+s/^\([^ (]* [^ (]* [*]*\)//g
+s/^\([^ (]* [*]*\)//g
+# trim blanks in case we have
+# void (*) (FORM *) field_init(const FORM *form);
+s/) (/)(/g
+# reduce stuff like
+# void (*)(FORM *) field_init(const FORM *form);
+# to
+# field_init(const FORM *form);
+s/^\(([^)]*)\)\(([^)]*)\)*[ ]*//g
+# rename marker temporarily
+s/\.SH_(/.SH_/
+# kill lines with ");", and trim off beginning of argument list.
+s/[()].*//
+# rename marker back
+s/\.SH_/.SH_(/
}
+#
+# delete ".SH DESCRIPTION" and following lines
/^\.SH_(DESCRIPTION/,${
- d
+d
}
+#
+# delete any remaining directives
/^\./d