Updated manpage generation (and information stored to it).

diff --git a/configure.ac b/configure.ac
index 39278d83b08f2827b0ca9ed12511e36814c8a6df..38c210473736bff53ec296b1ec9ea2178f54b16e 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -58,6 +58,7 @@ AC_SUBST(MAJOR_VERSION, `echo $PACKAGE_VERSION | sed 's/\(.*\)\..*\..*/\1/g'`)
 AC_SUBST(MINOR_VERSION, `echo $PACKAGE_VERSION | sed 's/.*\.\(.*\)\..*/\1/g'`)
 AC_SUBST(PATCH_VERSION, `echo $PACKAGE_VERSION | sed 's/.*\..*\.\(.*\)/\1/g'`)
 AC_SUBST(NUMBER_VERSION, `printf "0x%02x%02x%02x" $MAJOR_VERSION $MINOR_VERSION $PATCH_VERSION`)
+AC_SUBST([PACKAGE_BUGREPORT],[bugs@gnutls.org])
 
 touch suppressions.valgrind
 dnl C and C++ capabilities

diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am
index d3cda83d9fce5b62acb102853c210f5f1f7c10e5..6c3edd4d6d94a8547e5424c123b57b0606456aa0 100644 (file)
--- a/doc/manpages/Makefile.am
+++ b/doc/manpages/Makefile.am
@@ -965,6 +965,8 @@ dist_man_MANS += $(APIMANS)
 
 $(APIMANS): stamp_mans
 
+YEAR=`date +%Y`
+
 compare-makefile:
        FUNCS=`cat $(top_srcdir)/lib/includes/gnutls/*.h | $(top_srcdir)/doc/scripts/getfuncs.pl|sort -d`; \
        MANS=""; \
@@ -983,10 +985,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/gnutls.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -997,10 +999,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/compat.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1011,10 +1013,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/dane.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1025,10 +1027,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/x509.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1039,10 +1041,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/ocsp.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1053,10 +1055,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/abstract.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1067,10 +1069,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/pkcs12.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1081,10 +1083,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/pkcs11.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1095,10 +1097,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/dtls.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1109,10 +1111,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/openpgp.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1123,10 +1125,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/crypto.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1137,10 +1139,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/tpm.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \
@@ -1151,10 +1153,10 @@ stamp_mans: $(HEADER_FILES)
                $(top_srcdir)/doc/scripts/gdoc -man \
                        -module $(PACKAGE) -sourceversion $(VERSION) \
                        -bugsto $(PACKAGE_BUGREPORT) \
-                       -pkg-name "$(PACKAGE_NAME)" \
+                       -pkg-site "http://www.gnutls.org" \
                        -include "gnutls/xssl.h" \
                        -seeinfo $(PACKAGE) -verbatimcopying \
-                       -copyright "2001-2013 Free Software Foundation, Inc." \
+                       -copyright "2001-$(YEAR) Free Software Foundation, Inc" \
                        -function $$i \
                        $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \
                echo $(ECHO_N) "."; \

diff --git a/doc/scripts/gdoc b/doc/scripts/gdoc
index e3db7624dfb50881d3f03166f9c473630ce55d03..62196c5203f9c186ee61e1f1b3ec9c6b7635bef4 100755 (executable)
--- a/doc/scripts/gdoc
+++ b/doc/scripts/gdoc
@@ -3,11 +3,11 @@ eval '(exit $?0)' && eval 'exec perl "$0" ${1+"$@"}'
     if 0;
 
 ## Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon Josefsson
-##                    added -texinfo, -listfunc, -pkg-name
+##                    added -texinfo, -listfunc
 ##                    man page revamp
 ##                    various improvements
-## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
-##                    added -tex
+## Copyright (c) 2001, 2002, 2013 Nikos Mavrogiannopoulos
+##                    added -tex, -pkg-site
 ## Copyright (c) 1998 Michael Zucchi
 ## Copyright (c) 2013 Adam Sampson
 ##                    made highlighting not depend on hash order, for Perl 5.18
@@ -31,7 +31,7 @@ eval '(exit $?0)' && eval 'exec perl "$0" ${1+"$@"}'
 # usage:
 # gdoc [ -docbook | -html | -text | -man | -tex | -texinfo | -listfunc ]
 #      [ -sourceversion verno ] [ -include file | -includefuncprefix ]
-#      [ -bugsto address ] [ -pkg-name packagename ]
+#      [ -bugsto address ] [ -pkg-site website ]
 #      [ -seeinfo infonode ] [ -copyright notice ] [ -verbatimcopying ]
 #      [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
 #
@@ -55,9 +55,9 @@ eval '(exit $?0)' && eval 'exec perl "$0" ${1+"$@"}'
 #       For man pages, include a section about reporting bugs and mention
 #       the given e-mail address, e.g 'bug-libidn@gnu.org'.
 #
-#  -pkg-name packagename
+#  -pkg-site web-site
 #       For man pages when -bugsto is used, also include help URLs to the
-#       the project's home page.  For example, "GNU Libidn".
+#       the project's home page. 
 #
 #  -seeinfo infonode
 #       For man pages, include a section that point to an info manual
@@ -194,7 +194,7 @@ sub usage {
     print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -tex | -texinfo  -listfunc ]\n";
     print "         [ -sourceversion verno ] [ -include file | -includefuncprefix ]\n";
     print "         [ -bugsto address ] [ -seeinfo infonode ] [ -copyright notice]\n";
-    print "         [ -verbatimcopying ] [ -pkg-name packagename ]\n";
+    print "         [ -verbatimcopying ] [ -pkg-site website ]\n";
     print "         [ -function funcname [ -function funcname ...] ]\n";
     print "         c source file(s) > outputfile\n";
     exit 1;
@@ -250,8 +250,8 @@ while ($ARGV[0] =~ m/^-(.*)/) {
        $includefuncprefix = 1;
     } elsif ($cmd eq "-bugsto") {
        $bugsto = shift @ARGV;
-    } elsif ($cmd eq "-pkg-name") {
-       $pkgname = shift @ARGV;
+    } elsif ($cmd eq "-pkg-site") {
+       $pkgsite = shift @ARGV;
     } elsif ($cmd eq "-copyright") {
        $copyright = shift @ARGV;
     } elsif ($cmd eq "-verbatimcopying") {
@@ -703,12 +703,11 @@ sub output_man {
     if ($args{'bugsto'}) {
        print ".SH \"REPORTING BUGS\"\n";
        print "Report bugs to <". $args{'bugsto'} . ">.\n";
+        #print ".br\n";
+       #print "General guidelines for reporting bugs: http://www.gnu.org/gethelp/\n";
         print ".br\n";
-       print "General guidelines for reporting bugs: http://www.gnu.org/gethelp/\n";
-        print ".br\n";
-       if ($args{'pkgname'}) {
-           print $args{'pkgname'} . " home page: " .
-               "http://www.gnu.org/software/" . $args{'module'} . "/\n";
+       if ($args{'pkgsite'}) {
+           print "Home page: " . $args{'pkgsite'} . "\n";
        }
        print "\n";
     }
@@ -728,18 +727,13 @@ sub output_man {
        print ".SH \"SEE ALSO\"\n";
        print "The full documentation for\n";
        print ".B " . $args{'module'} . "\n";
-       print "is maintained as a Texinfo manual.  If the\n";
-       print ".B info\n";
-       print "and\n";
-       print ".B " . $args{'module'} . "\n";
-       print "programs are properly installed at your site, the command\n";
-       print ".IP\n";
-       print ".B info " . $args{'seeinfo'} . "\n";
-       print ".PP\n";
-       print "should give you access to the complete manual.\n";
-       print "As an alternative you may obtain the manual from:\n";
-       print ".IP\n";
-       print ".B http://www.gnu.org/software/" . $args{'module'} . "/manual/\n";
+       print "is maintained as a Texinfo manual.\n";
+       if ($args{'pkgsite'}) {
+               print "If the /usr/share/doc/". $args{'module'} . "/\n";
+               print "directory does not contain the HTML form visit\n";
+               print ".B\n";
+               print ".IP " . $args{'pkgsite'} . "/manual/\n";
+       }
        print ".PP\n";
     }
 }
@@ -841,7 +835,7 @@ sub dump_function {
                         'include' => $include,
                         'includefuncprefix' => $includefuncprefix,
                         'bugsto' => $bugsto,
-                        'pkgname' => $pkgname,
+                        'pkgsite' => $pkgsite,
                         'copyright' => $copyright,
                         'verbatimcopying' => $verbatimcopying,
                         'seeinfo' => $seeinfo,
@@ -892,7 +886,7 @@ sub dump_enum {
                         'include' => $include,
                         'includefuncprefix' => $includefuncprefix,
                         'bugsto' => $bugsto,
-                        'pkgname' => $pkgname,
+                        'pkgsite' => $pkgsite,
                         'copyright' => $copyright,
                         'verbatimcopying' => $verbatimcopying,
                         'seeinfo' => $seeinfo,