curl/src/mkhelp.pl

#!/usr/bin/env perl
#***************************************************************************
#                                  _   _ ____  _
#  Project                     ___| | | |  _ \| |
#                             / __| | | | |_) | |
#                            | (__| |_| |  _ <| |___
#                             \___|\___/|_| \_\_____|
#
# Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at https://curl.haxx.se/docs/copyright.html.
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
###########################################################################

# Yeah, I know, probably 1000 other persons already wrote a script like
# this, but I'll tell ya:

# THEY DON'T FIT ME :-)

# Get readme file as parameter:

if($ARGV[0] eq "-c") {
    $c=1;
    shift @ARGV;
}

my $README = $ARGV[0];

if($README eq "") {
    print "usage: mkhelp.pl [-c] <README> < manpage\n";
    exit;
}


push @out, "                                  _   _ ____  _\n";
push @out, "  Project                     ___| | | |  _ \\| |\n";
push @out, "                             / __| | | | |_) | |\n";
push @out, "                            | (__| |_| |  _ <| |___\n";
push @out, "                             \\___|\\___/|_| \\_\\_____|\n";

my $olen=0;
while (<STDIN>) {
    my $line = $_;

    # this should be removed:
    $line =~ s/(.|_)//g;

    # remove trailing CR from line. msysgit checks out files as line+CRLF
    $line =~ s/\r$//;

    if($line =~ /^([ \t]*\n|curl)/i) {
        # cut off headers and empty lines
        $wline++; # count number of cut off lines
        next;
    }

    my $text = $line;
    $text =~ s/^\s+//g; # cut off preceding...
    $text =~ s/\s+$//g; # and trailing whitespaces

    $tlen = length($text);

    if($wline && ($olen == $tlen)) {
        # if the previous line with contents was exactly as long as
        # this line, then we ignore the newlines!

        # We do this magic because a header may abort a paragraph at
        # any line, but we don't want that to be noticed in the output
        # here
        $wline=0;
    }
    $olen = $tlen;

    if($wline) {
        # we only make one empty line max
        $wline = 0;
        push @out, "\n";
    }
    push @out, $line;
}
push @out, "\n"; # just an extra newline

open(READ, "<$README") ||
    die "couldn't read the README infile $README";

while(<READ>) {
    my $line = $_;

    # remove trailing CR from line. msysgit checks out files as line+CRLF
    $line =~ s/\r$//;

    push @out, $line;
}
close(READ);

print <<HEAD
/*
 * NEVER EVER edit this manually, fix the mkhelp.pl script instead!
 */
#ifdef USE_MANUAL
#include "tool_hugehelp.h"
HEAD
    ;
if($c) {
    # If compression requested, check that the Gzip module is available
    # or else disable compression
    $c = eval
    {
      require IO::Compress::Gzip;
      IO::Compress::Gzip->import();
      1;
    };
    print STDERR "Warning: compression requested but Gzip is not available\n" if (!$c)
}

if($c)
{
    my $content = join("", @out);
    my $gzippedContent;
    IO::Compress::Gzip::gzip(
        \$content, \$gzippedContent, Level => 9, TextFlag => 1, Time=>0) or die "gzip failed:";
    $gzip = length($content);
    $gzipped = length($gzippedContent);

    print <<HEAD
#include <zlib.h>
#include "memdebug.h" /* keep this as LAST include */
static const unsigned char hugehelpgz[] = {
  /* This mumbo-jumbo is the huge help text compressed with gzip.
     Thanks to this operation, the size of this data shrank from $gzip
     to $gzipped bytes. You can disable the use of compressed help
     texts by NOT passing -c to the mkhelp.pl tool. */
HEAD
;

    my $c=0;
    print " ";
    for(split(//, $gzippedContent)) {
        my $num=ord($_);
        printf(" 0x%02x,", 0+$num);
        if(!(++$c % 12)) {
            print "\n ";
        }
    }
    print "\n};\n";

    print <<EOF
#define BUF_SIZE 0x10000
static voidpf zalloc_func(voidpf opaque, unsigned int items, unsigned int size)
{
  (void) opaque;
  /* not a typo, keep it calloc() */
  return (voidpf) calloc(items, size);
}
static void zfree_func(voidpf opaque, voidpf ptr)
{
  (void) opaque;
  free(ptr);
}
/* Decompress and send to stdout a gzip-compressed buffer */
void hugehelp(void)
{
  unsigned char* buf;
  int status,headerlen;
  z_stream z;

  /* Make sure no gzip options are set */
  if (hugehelpgz[3] & 0xfe)
    return;

  headerlen = 10;
  memset(&z, 0, sizeof(z_stream));
  z.zalloc = (alloc_func)zalloc_func;
  z.zfree = (free_func)zfree_func;
  z.avail_in = (unsigned int)(sizeof(hugehelpgz) - headerlen);
  z.next_in = (unsigned char *)hugehelpgz + headerlen;

  if (inflateInit2(&z, -MAX_WBITS) != Z_OK)
    return;

  buf = malloc(BUF_SIZE);
  if (buf) {
    while(1) {
      z.avail_out = BUF_SIZE;
      z.next_out = buf;
      status = inflate(&z, Z_SYNC_FLUSH);
      if (status == Z_OK || status == Z_STREAM_END) {
        fwrite(buf, BUF_SIZE - z.avail_out, 1, stdout);
        if (status == Z_STREAM_END)
          break;
      }
      else
        break;    /* Error */
    }
    free(buf);
  }
  inflateEnd(&z);
}
EOF
    ;
foot();
exit;
}
else {
    print <<HEAD
void hugehelp(void)
{
   fputs(
HEAD
         ;
}

$outsize=0;
for(@out) {
    chop;

    $new = $_;

    $outsize += length($new)+1; # one for the newline

    $new =~ s/\\/\\\\/g;
    $new =~ s/\"/\\\"/g;

    # gcc 2.96 claims ISO C89 only is required to support 509 letter strings
    if($outsize > 500) {
        # terminate and make another fputs() call here
        print ", stdout);\n fputs(\n";
        $outsize=length($new)+1;
    }
    printf("\"%s\\n\"\n", $new);

}

print ", stdout) ;\n}\n";

foot();

sub foot {
  print <<FOOT
#else /* !USE_MANUAL */
/* built-in manual is disabled, blank function */
#include "tool_hugehelp.h"
void hugehelp(void) {}
#endif /* USE_MANUAL */
FOOT
  ;
}
-												mkhelp.pl: allow executing this script directly

- Enable execute permission (chmod +x)

- Change interpreter to /usr/bin/env perl

Ref: https://github.com/curl/curl/issues/1743

											
										
										
											2017-08-09 02:59:18 -04:00
+								#!/usr/bin/env perl
-												headers: more copyright headers added

											
										
										
											2011-03-22 17:48:11 -04:00
+								#***************************************************************************
 								#                                  _   _ ____  _
 								#  Project                     ___| | | |  _ \| |
 								#                             / __| | | | |_) | |
 								#                            | (__| |_| |  _ <| |___
 								#                             \___|\___/|_| \_\_____|
 								#
-												mkhelp: generate code for --disable-manual as well

This allows configure --disable-manual to run and build without having
to regenerate the src/tool_hugehelp.c file which otherwise is necessary
since we ship tarballs with that file present.

Reported-by: Remi Gacogne
Bug: http://curl.haxx.se/bug/view.cgi?id=1350

											
										
										
											2014-03-26 08:22:10 -04:00
+								# Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
-												headers: more copyright headers added

											
										
										
											2011-03-22 17:48:11 -04:00
+								#
 								# This software is licensed as described in the file COPYING, which
 								# you should have received as part of this distribution. The terms
-												URLs: change all http:// URLs to https://

											
										
										
											2016-02-02 18:19:02 -05:00
+								# are also available at https://curl.haxx.se/docs/copyright.html.
-												headers: more copyright headers added

											
										
										
											2011-03-22 17:48:11 -04:00
+								#
 								# You may opt to use, copy, modify, merge, publish, distribute and/or sell
 								# copies of the Software, and permit persons to whom the Software is
 								# furnished to do so, under the terms of the COPYING file.
 								#
 								# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 								# KIND, either express or implied.
 								#
 								###########################################################################
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
 								# Yeah, I know, probably 1000 other persons already wrote a script like
 								# this, but I'll tell ya:
 								# THEY DON'T FIT ME :-)
 								# Get readme file as parameter:
-												Fixes based on Gisle Vanem's input since this script failed due to
possibly crlf newlines.

											
										
										
											2003-07-28 19:00:56 -04:00
 								if($ARGV[0] eq "-c") {
 								    $c=1;
 								    shift @ARGV;
 								}
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								my $README = $ARGV[0];
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
 								if($README eq "") {
-												mkhelp.pl: fix script name in usage text

											
										
										
											2017-06-13 13:16:25 -04:00
+								    print "usage: mkhelp.pl [-c] <README> < manpage\n";
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								    exit;
 								}
-replaced tabs with spaces

											
										
										
											2010-02-16 08:32:45 -05:00
+								push @out, "                                  _   _ ____  _\n";
 								push @out, "  Project                     ___| | | |  _ \\| |\n";
 								push @out, "                             / __| | | | |_) | |\n";
 								push @out, "                            | (__| |_| |  _ <| |___\n";
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								push @out, "                             \\___|\\___/|_| \\_\\_____|\n";
-												Fixes based on Gisle Vanem's input since this script failed due to
possibly crlf newlines.

											
										
										
											2003-07-28 19:00:56 -04:00
+								my $olen=0;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								while (<STDIN>) {
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    my $line = $_;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    # this should be removed:
 								    $line =~ s/(.|_)//g;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
-												mkhelp: Remove trailing carriage return from every line of input

- Get rid of this flood of warnings in Windows mingw build:
warning: missing terminating " character

The warning is due to the carriage return. When msysgit checks out files
from the repo by default it converts the line endings to CRLF. Prior to
this change when mkhelp.pl processed the MANUAL and curl.1 in CRLF
format the trailing carriage returns caused unnecessary CR in the
output.

											
										
										
											2015-03-18 01:44:48 -04:00
+								    # remove trailing CR from line. msysgit checks out files as line+CRLF
 								    $line =~ s/\r$//;
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    if($line =~ /^([ \t]*\n|curl)/i) {
 								        # cut off headers and empty lines
-replaced tabs with spaces

											
										
										
											2010-02-16 08:32:45 -05:00
+								        $wline++; # count number of cut off lines
 								        next;
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    }
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    my $text = $line;
-												Fix spelling errors in src/

Found with codespell.

											
										
										
											2011-04-19 10:06:47 -04:00
+								    $text =~ s/^\s+//g; # cut off preceding...
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    $text =~ s/\s+$//g; # and trailing whitespaces
 								    $tlen = length($text);
 								    if($wline && ($olen == $tlen)) {
 								        # if the previous line with contents was exactly as long as
 								        # this line, then we ignore the newlines!
 								        # We do this magic because a header may abort a paragraph at
 								        # any line, but we don't want that to be noticed in the output
 								        # here
 								        $wline=0;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								    }
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    $olen = $tlen;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								    if($wline) {
-replaced tabs with spaces

											
										
										
											2010-02-16 08:32:45 -05:00
+								        # we only make one empty line max
 								        $wline = 0;
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								        push @out, "\n";
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								    }
 								    push @out, $line;
 								}
 								push @out, "\n"; # just an extra newline
 								open(READ, "<$README") ||
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								    die "couldn't read the README infile $README";
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
 								while(<READ>) {
-												mkhelp: Remove trailing carriage return from every line of input

- Get rid of this flood of warnings in Windows mingw build:
warning: missing terminating " character

The warning is due to the carriage return. When msysgit checks out files
from the repo by default it converts the line endings to CRLF. Prior to
this change when mkhelp.pl processed the MANUAL and curl.1 in CRLF
format the trailing carriage returns caused unnecessary CR in the
output.

											
										
										
											2015-03-18 01:44:48 -04:00
+								    my $line = $_;
 								    # remove trailing CR from line. msysgit checks out files as line+CRLF
 								    $line =~ s/\r$//;
 								    push @out, $line;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								}
 								close(READ);
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								print <<HEAD
 								/*
 								 * NEVER EVER edit this manually, fix the mkhelp.pl script instead!
 								 */
-												make the generated hugehelp.c file use the USE_MANUAL define so that it
will be properly built with configure --disable-manual even if the source
file is already present

											
										
										
											2004-04-25 04:13:07 -04:00
+								#ifdef USE_MANUAL
-												curl tool: renaming hugehelp files to tool_hugehelp

											
										
										
											2012-12-26 17:30:54 -05:00
+								#include "tool_hugehelp.h"
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								HEAD
 								    ;
 								if($c) {
-												mkhelp: disable compression if the perl gzip module is unavailable

This is nowadays included with the base perl distribution, but wasn't
prior to about perl 5.14

											
										
										
											2017-03-23 16:11:41 -04:00
+								    # If compression requested, check that the Gzip module is available
 								    # or else disable compression
 								    $c = eval
 								    {
 								      require IO::Compress::Gzip;
 								      IO::Compress::Gzip->import();
 ;
 								    };
 								    print STDERR "Warning: compression requested but Gzip is not available\n" if (!$c)
 								}
 								if($c)
 								{
-												mkhelp: simplified the gzip code

This eliminates the need for an external gzip program, which wasn't
working with Busybox's gzip, anyway. It now compresses using perl's
IO::Compress::Gzip

											
										
										
											2017-03-09 16:15:54 -05:00
+								    my $content = join("", @out);
 								    my $gzippedContent;
 								    IO::Compress::Gzip::gzip(
-												mkhelp.pl: do not add current time into curl binary

... as part of hugehelpgz rodata to make build reproducible.

See https://reproducible-builds.org/ for why this is good

Closes #1490

											
										
										
											2017-05-17 09:54:19 -04:00
+								        \$content, \$gzippedContent, Level => 9, TextFlag => 1, Time=>0) or die "gzip failed:";
-												mkhelp: simplified the gzip code

This eliminates the need for an external gzip program, which wasn't
working with Busybox's gzip, anyway. It now compresses using perl's
IO::Compress::Gzip

											
										
										
											2017-03-09 16:15:54 -05:00
+								    $gzip = length($content);
 								    $gzipped = length($gzippedContent);
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								    print <<HEAD
 								#include <zlib.h>
-												Revert changes relative to lib/*.[ch] recent renaming

This reverts renaming and usage of lib/*.h header files done
28-12-2012, reverting 2 commits:

  f871de0... build: make use of 76 lib/*.h renamed files
  ffd8e12... build: rename 76 lib/*.h files

This also reverts removal of redundant include guard (redundant thanks
to changes in above commits) done 2-12-2013, reverting 1 commit:

  c087374... curl_setup.h: remove redundant include guard

This also reverts renaming and usage of lib/*.c source files done
3-12-2013, reverting 3 commits:

  13606bb... build: make use of 93 lib/*.c renamed files
  5b6e792... build: rename 93 lib/*.c files
  7d83dff... build: commit 13606bbfde follow-up 1

Start of related discussion thread:

  http://curl.haxx.se/mail/lib-2013-01/0012.html

Asking for confirmation on pushing this revertion commit:

  http://curl.haxx.se/mail/lib-2013-01/0048.html

Confirmation summary:

  http://curl.haxx.se/mail/lib-2013-01/0079.html

NOTICE: The list of 2 files that have been modified by other
intermixed commits, while renamed, and also by at least one
of the 6 commits this one reverts follows below. These 2 files
will exhibit a hole in history unless git's '--follow' option
is used when viewing logs.

  lib/curl_imap.h
  lib/curl_smtp.h

											
										
										
											2013-01-03 20:50:28 -05:00
+								#include "memdebug.h" /* keep this as LAST include */
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								static const unsigned char hugehelpgz[] = {
 								  /* This mumbo-jumbo is the huge help text compressed with gzip.
-												mkhelp: simplified the gzip code

This eliminates the need for an external gzip program, which wasn't
working with Busybox's gzip, anyway. It now compresses using perl's
IO::Compress::Gzip

											
										
										
											2017-03-09 16:15:54 -05:00
+								     Thanks to this operation, the size of this data shrank from $gzip
-												adjusted the compressed generation to be more helpful in comments etc

											
										
										
											2003-06-26 07:34:07 -04:00
+								     to $gzipped bytes. You can disable the use of compressed help
 								     texts by NOT passing -c to the mkhelp.pl tool. */
 								HEAD
 								;
-												mkhelp: simplified the gzip code

This eliminates the need for an external gzip program, which wasn't
working with Busybox's gzip, anyway. It now compresses using perl's
IO::Compress::Gzip

											
										
										
											2017-03-09 16:15:54 -05:00
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								    my $c=0;
-												kill trailing whitespace

											
										
										
											2006-10-09 10:59:53 -04:00
+								    print " ";
-												mkhelp: simplified the gzip code

This eliminates the need for an external gzip program, which wasn't
working with Busybox's gzip, anyway. It now compresses using perl's
IO::Compress::Gzip

											
										
										
											2017-03-09 16:15:54 -05:00
+								    for(split(//, $gzippedContent)) {
 								        my $num=ord($_);
 								        printf(" 0x%02x,", 0+$num);
 								        if(!(++$c % 12)) {
 								            print "\n ";
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								        }
 								    }
 								    print "\n};\n";
 								    print <<EOF
-												Allocate the decompression buffer for the --manual option on the heap
instead of the stack.

											
										
										
											2008-04-21 19:17:20 -04:00
+								#define BUF_SIZE 0x10000
-												zlib: ensure user provided memory functions are used by zlib, when given

As a bonus, this lets our MemoryTracking subsystem track zlib operations.
And also fixes a shortcut some zlib 1.2.x versions took using malloc()
instead of calloc(), which would trigger memory debuggers warnings on
memory being used without having been initialized.

											
										
										
											2011-08-21 07:15:34 -04:00
+								static voidpf zalloc_func(voidpf opaque, unsigned int items, unsigned int size)
 								{
 								  (void) opaque;
 								  /* not a typo, keep it calloc() */
 								  return (voidpf) calloc(items, size);
 								}
 								static void zfree_func(voidpf opaque, voidpf ptr)
 								{
 								  (void) opaque;
 								  free(ptr);
 								}
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								/* Decompress and send to stdout a gzip-compressed buffer */
 								void hugehelp(void)
 								{
-												Allocate the decompression buffer for the --manual option on the heap
instead of the stack.

											
										
										
											2008-04-21 19:17:20 -04:00
+								  unsigned char* buf;
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								  int status,headerlen;
 								  z_stream z;
 								  /* Make sure no gzip options are set */
 								  if (hugehelpgz[3] & 0xfe)
 								    return;
 								  headerlen = 10;
-												zlib: enforce full initialization of our data space z_stream structs

											
										
										
											2011-08-18 14:09:26 -04:00
+								  memset(&z, 0, sizeof(z_stream));
-												zlib: ensure user provided memory functions are used by zlib, when given

As a bonus, this lets our MemoryTracking subsystem track zlib operations.
And also fixes a shortcut some zlib 1.2.x versions took using malloc()
instead of calloc(), which would trigger memory debuggers warnings on
memory being used without having been initialized.

											
										
										
											2011-08-21 07:15:34 -04:00
+								  z.zalloc = (alloc_func)zalloc_func;
 								  z.zfree = (free_func)zfree_func;
-												Another Yang Tse warning cleanup raid!

											
										
										
											2005-12-05 09:10:48 -05:00
+								  z.avail_in = (unsigned int)(sizeof(hugehelpgz) - headerlen);
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								  z.next_in = (unsigned char *)hugehelpgz + headerlen;
 								  if (inflateInit2(&z, -MAX_WBITS) != Z_OK)
 								    return;
-												Allocate the decompression buffer for the --manual option on the heap
instead of the stack.

											
										
										
											2008-04-21 19:17:20 -04:00
+								  buf = malloc(BUF_SIZE);
 								  if (buf) {
 								    while(1) {
 								      z.avail_out = BUF_SIZE;
 								      z.next_out = buf;
 								      status = inflate(&z, Z_SYNC_FLUSH);
 								      if (status == Z_OK || status == Z_STREAM_END) {
-replaced tabs with spaces

											
										
										
											2010-02-16 08:32:45 -05:00
+								        fwrite(buf, BUF_SIZE - z.avail_out, 1, stdout);
 								        if (status == Z_STREAM_END)
 								          break;
-												Allocate the decompression buffer for the --manual option on the heap
instead of the stack.

											
										
										
											2008-04-21 19:17:20 -04:00
+								      }
-replaced tabs with spaces

											
										
										
											2010-02-16 08:32:45 -05:00
+								      else
 								        break;    /* Error */
-												nonsence change to make -Wunreachable-code get happy

											
										
										
											2004-01-29 08:49:41 -05:00
+								    }
-												Allocate the decompression buffer for the --manual option on the heap
instead of the stack.

											
										
										
											2008-04-21 19:17:20 -04:00
+								    free(buf);
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								  }
 								  inflateEnd(&z);
 								}
 								EOF
 								    ;
-												make the generated hugehelp.c file use the USE_MANUAL define so that it
will be properly built with configure --disable-manual even if the source
file is already present

											
										
										
											2004-04-25 04:13:07 -04:00
+								foot();
-												Based on Dan Fandrich's patch and gzip unpack function, we now compress
the 'hugehelp' text if libz and gzip are available at build time.

											
										
										
											2003-06-12 08:54:34 -04:00
+								exit;
 								}
 								else {
 								    print <<HEAD
 								void hugehelp(void)
 								{
 								   fputs(
 								HEAD
 								         ;
 								}
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
-												now splits the text into several puts() calls

											
										
										
											2000-05-23 06:25:30 -04:00
+								$outsize=0;
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								for(@out) {
 								    chop;
 								    $new = $_;
-												only generate maximum 509 characters in each string

											
										
										
											2001-03-09 08:11:28 -05:00
+								    $outsize += length($new)+1; # one for the newline
-												now splits the text into several puts() calls

											
										
										
											2000-05-23 06:25:30 -04:00
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								    $new =~ s/\\/\\\\/g;
 								    $new =~ s/\"/\\\"/g;
-												only generate maximum 509 characters in each string

											
										
										
											2001-03-09 08:11:28 -05:00
+								    # gcc 2.96 claims ISO C89 only is required to support 509 letter strings
 								    if($outsize > 500) {
-												Gisle Vanem's fix to make the 'curl -M' output nicer

											
										
										
											2003-05-21 03:21:44 -04:00
+								        # terminate and make another fputs() call here
 								        print ", stdout);\n fputs(\n";
-												only generate maximum 509 characters in each string

											
										
										
											2001-03-09 08:11:28 -05:00
+								        $outsize=length($new)+1;
-												now splits the text into several puts() calls

											
										
										
											2000-05-23 06:25:30 -04:00
+								    }
-												only generate maximum 509 characters in each string

											
										
										
											2001-03-09 08:11:28 -05:00
+								    printf("\"%s\\n\"\n", $new);
-												now splits the text into several puts() calls

											
										
										
											2000-05-23 06:25:30 -04:00
-												Initial revision

											
										
										
											1999-12-29 09:20:26 -05:00
+								}
-												make the generated hugehelp.c file use the USE_MANUAL define so that it
will be properly built with configure --disable-manual even if the source
file is already present

											
										
										
											2004-04-25 04:13:07 -04:00
+								print ", stdout) ;\n}\n";
 								foot();
 								sub foot {
 								  print <<FOOT
-												mkhelp: generate code for --disable-manual as well

This allows configure --disable-manual to run and build without having
to regenerate the src/tool_hugehelp.c file which otherwise is necessary
since we ship tarballs with that file present.

Reported-by: Remi Gacogne
Bug: http://curl.haxx.se/bug/view.cgi?id=1350

											
										
										
											2014-03-26 08:22:10 -04:00
+								#else /* !USE_MANUAL */
 								/* built-in manual is disabled, blank function */
 								#include "tool_hugehelp.h"
 								void hugehelp(void) {}
-												make the generated hugehelp.c file use the USE_MANUAL define so that it
will be properly built with configure --disable-manual even if the source
file is already present

											
										
										
											2004-04-25 04:13:07 -04:00
+								#endif /* USE_MANUAL */
 								FOOT
 								  ;
 								}