File: cgi.5

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 (118 lines) | stat: -rw-r--r-- 3,921 bytes parent folder | download | duplicates (2)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.\" cgi - Common Gateway Interface
.\" 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 cgi 5 "14 August 1999" "CGI Library" "Programmer's Manual"
.SH NAME
cgi \- Common Gateway Interface

.SH DESCRIPTION
The Common Gateway Interface is a way to create dynamic web pages.
It defines rules for interaction between a program and the web server
while the server talks to the client.  There are some ways to use it.

.SH "ENVIRONMENT"
Normally the webserver sets several environment variables to give some
information to the CGI program so it can determine various stuff.
.TP
.B AUTH_TYPE
This reflects the authentification method used to validate a user.
.TP
.B CONTENT_LENGTH
The length of the data in bytes passed to the CGI program through
standard input.  This is used by the POST method.
.TP
.B CONTENT_TYPE
The MIME type of the query data, such as "text/html", optional.
.TP
.B DOCUMENT_ROOT
This reflects the document root directory of the webserver.
.TP
.B GATEWAY_INTERFACE
Reflects the version of the Common Gateway Interface that the server
is using
.TP
.B HTTP_ACCEPT
A comma separated list of MIME type that the client is willing to
accept.
.TP
.B HTTP_FROM
The email address of the user issuing the information request.  This
is not supported by most browsers.
.TP
.B HTTP_REFERER
Reflects the URL from which tis CGI program was accessed.
.TP
.B HTTP_USER_AGENT
The name, version and libraries of the browser making the request.
This information can be used to determine if the browser is capable of
graphics and is able to display frames and tables.
.TP
.B PATH_INFO
This shows extra information that was passed to the CGI program via
command line.  Normally it's empty or non-existant.
.TP
.B PATH_TRANSLATED
The translated path on the local filesystem.
.TP
.B QUERY_STRING
This variable refers to additional arguments that were appended to the
CGI programm - normally with the '?' sign.
.TP
.B REMOTE_ADDR
This refers to the host from which the information request was issued,
as ip number.
.TP
.B REMOTE_HOST
This refers to the host from which the information request was issued.
.TP
.B REMOTE_USER
The authenticated name of the user.
.TP
.B REQUEST_METHOD
This refers to the method with which the information request was
issued.  Normally this is either GET or POST.
.TP
.B SCRIPT_NAME
The virtual name of the script being executed.
.TP
.B SERVER_NAME
The server's hostname or ip number.  This may be used to determine the
correct paths or resulting HTML code for CGI programs that are used on
the same machine for several servers.
.TP
.B SERVER_PROTOCOL
This is the name and version of the information protocol the request
came in with.  Normally this is "HTTP/1.0" or "HTTP/1.1".
.TP
.B SERVER_PORT
This refers to the TCP/IP port on which the webserver is running.
.TP
.B SERVER_SOFTWARE
This reflects the name and revision of the webserver software.

.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 cgiHeader (3),
.BR cgiSetType (3),
.BR cgiSetHeader (3),
.BR cgiGetValue (3),
.BR cgiGetVariables (3).