File: cgiInit.3

package info (click to toggle)
cgilib 0.5-4
  • links: PTS
  • area: main
  • in suites: sarge, woody
  • size: 140 kB
  • ctags: 60
  • sloc: ansic: 652; makefile: 97; sh: 10
file content (65 lines) | stat: -rw-r--r-- 2,385 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.\" cgiInit - Initializes CGI library
.\" Copyright (c) 1998,9 by Martin Schulze <joey@infodrom.north.de>
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.TH cgiInit 3 "17 August 1999" "CGI Library" "Programmer's Manual"
.SH NAME
cgiInit \- Initializes CGI library
.SH SYNOPSYS
.nf
.B #include <cgi.h>
.sp
.B s_cgi *cgiInit ();
.fi
.SH DESCRIPTION
This routine initializes the CGI routines.  Mainly it reads in and
decodes CGI data for later processing.  If the program is not called
via CGI interface the user is prompted to type in CGI variable
bindings via stdin - just like CGI.pm does.  There is no limit in the
number of variable bindings.

If HTTP Cookies are used (through the variable HTTP_COOKIE) this
routine will parse them as well and assign them to internal variables.
There is no limit in the number of cookies.

To set a cookie you'll have to use the
.BR cgiSetHeader (3)
routine.  Some clients allow 4kB of Cookies while others only allow
short ones.  Some clients may also allow only 200 Cookies for a
certain domain/path pair.

This routine normally is the first or second.  Only
.BR cgiDebug ()
may be called before.  If debugging is enabled this routine produces
some additional output.
.SH "RETURN VALUE"
On success a set of CGI variable bindings is returned that is needed
for later processing.  If an error occurs NULL is returned.

.SH "AUTHOR"
This CGI library is written by Martin Schulze
<joey@infodrom.north.de>.  If you have additions or improvements
please get in touch with him.

.SH "SEE ALSO"
.BR cgiDebug (3),
.BR cgiSetType (3),
.BR cgiSetHeader (3),
.BR cgiHeader (3),
.BR cgiGetValue (3),
.BR cgiGetVariables (3)
.BR cgiGetCookie (3),
.BR cgiGetCookies (3).