Return to mksymbolsmanpage.pl CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/mksymbolsmanpage.pl, revision 1.1.1.1

1.1       misho       1: #!/usr/bin/env perl
                      2: # ***************************************************************************
                      3: # *                                  _   _ ____  _
                      4: # *  Project                     ___| | | |  _ \| |
                      5: # *                             / __| | | | |_) | |
                      6: # *                            | (__| |_| |  _ <| |___
                      7: # *                             \___|\___/|_| \_\_____|
                      8: # *
                      9: # * Copyright (C) 2015 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
                     10: # *
                     11: # * This software is licensed as described in the file COPYING, which
                     12: # * you should have received as part of this distribution. The terms
                     13: # * are also available at https://curl.haxx.se/docs/copyright.html.
                     14: # *
                     15: # * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     16: # * copies of the Software, and permit persons to whom the Software is
                     17: # * furnished to do so, under the terms of the COPYING file.
                     18: # *
                     19: # * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     20: # * KIND, either express or implied.
                     21: # *
                     22: # ***************************************************************************
                     23: 
                     24: my $version="7.41.0";
                     25: 
                     26: use POSIX qw(strftime);
                     27: my $date = strftime "%b %e, %Y", localtime;
                     28: my $year = strftime "%Y", localtime;
                     29: 
                     30: print <<HEADER
                     31: .\\" **************************************************************************
                     32: .\\" *                                  _   _ ____  _
                     33: .\\" *  Project                     ___| | | |  _ \\| |
                     34: .\\" *                             / __| | | | |_) | |
                     35: .\\" *                            | (__| |_| |  _ <| |___
                     36: .\\" *                             \\___|\\___/|_| \\_\\_____|
                     37: .\\" *
                     38: .\\" * Copyright (C) 1998 - $year, Daniel Stenberg, <daniel\@haxx.se>, et al.
                     39: .\\" *
                     40: .\\" * This software is licensed as described in the file COPYING, which
                     41: .\\" * you should have received as part of this distribution. The terms
                     42: .\\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     43: .\\" *
                     44: .\\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     45: .\\" * copies of the Software, and permit persons to whom the Software is
                     46: .\\" * furnished to do so, under the terms of the COPYING file.
                     47: .\\" *
                     48: .\\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     49: .\\" * KIND, either express or implied.
                     50: .\\" *
                     51: .\\" **************************************************************************
                     52: .TH libcurl-symbols 3 "$date" "libcurl $version" "libcurl symbols"
                     53: .SH NAME
                     54: libcurl-symbols \\- libcurl symbol version information
                     55: .SH "libcurl symbols"
                     56: This man page details version information for public symbols provided in the
                     57: libcurl header files. This lists the first version in which the symbol was
                     58: introduced and for some symbols two additional information pieces:
                     59: 
                     60: The first version in which the symbol is marked "deprecated" - meaning that
                     61: since that version no new code should be written to use the symbol as it is
                     62: marked for getting removed in a future.
                     63: 
                     64: The last version that featured the specific symbol. Using the symbol in source
                     65: code will make it no longer compile error-free after that specified version.
                     66: 
                     67: This man page is automatically generated from the symbols-in-versions file.
                     68: HEADER
                     69:     ;
                     70: 
                     71: while(<STDIN>) {
                     72:     if($_ =~ /^(CURL[A-Z0-9_.]*) *(.*)/) {
                     73:         my ($symbol, $rest)=($1,$2);
                     74:         my ($intro, $dep, $rem);
                     75:         if($rest =~ s/^([0-9.]*) *//) {
                     76:            $intro = $1;
                     77:         }
                     78:         if($rest =~ s/^([0-9.]*) *//) {
                     79:            $dep = $1;
                     80:         }
                     81:         if($rest =~ s/^([0-9.]*) *//) {
                     82:            $rem = $1;
                     83:         }
                     84:         print ".IP $symbol\nIntroduced in $intro\n";
                     85:         if($dep) {
                     86:           print "Deprecated since $dep\n";
                     87:         }
                     88:         if($rem) {
                     89:           print "Last used in $dep\n";
                     90:         }
                     91:     }
                     92: 
                     93: }