git.infodrom.org Git - infodrom/cgilib/blob - cgiInit.3

   1 .\" cgiInit - Initializes cgi library
   2 .\" Copyright (c) 1998  Martin Schulze <joey@infodrom.north.de>
   3 .\"
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful,
  10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 .\" GNU General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with this program; if not, write to the Free Software
  16 .\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17 .\"
  18 .TH cgiInit 3 "14 February 1998" "Debian GNU/Linux" "Programmer's Manual"
  19 .SH NAME
  20 cgiInit \- Initializes cgi library
  21 .SH SYNOPSYS
  22 .nf
  23 .B #include <cgi.h>
  24 .sp
  25 .B s_cgi **cgiInit();
  26 .fi
  27 .SH DESCRIPTION
  28 This routine initializes the cgi routines.  Mainly it reads in and
  29 decodes cgi data for later processing.  If the program is not called
  30 via cgi interface the user is prompted to type in cgi variable
  31 bindings via stdin - just like GGI.pm does.
  32
  33 This routine normally is the first or second.  Only
  34 .BR cgiDebug ()
  35 may be called before.  If debugging is enabled this routine produces
  36 some additional output.
  37 .SH "RETURN VALUE"
  38 On success a set of cgi variable bindings is returned that is needed
  39 for later processing.  If an error occurs NULL is returned.
  40
  41 .SH "AUTHOR"
  42 This cgi library is written by Martin Schulze
  43 <joey@infodrom.north.de>.  If you have additions or improvements
  44 please get in touch with him.
  45
  46 .SH "SEE ALSO"
  47 .BR cgiDebug (3),
  48 .BR cgiHeader (3),
  49 .BR cgiGetValue (3).