coar 00/07/23 08:32:51
Modified: apidoc api.list dict-conn_rec.html dict-request_rec.html
mkapidict
Added: apidoc dict-BIG_SECURITY_HOLE.html
dict-DOCUMENT_LOCATION.html
dict-DYNAMIC_MODULE_LIMIT.html dict-HTTPD_ROOT.html
Log:
Add some constants settable on the compilation command line,
flesh out a couple of structure descriptions (at least a
little), and correct the structure definitions.
Revision Changes Path
1.15 +53 -10 httpd-docs-1.3/apidoc/api.list
Index: api.list
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/api.list,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -u -r1.14 -r1.15
--- api.list 2000/07/13 12:44:24 1.14
+++ api.list 2000/07/23 15:32:50 1.15
@@ -603,6 +603,7 @@
#;
X|SA-core-rec\
|conn_rec,request_rec,server_rec,cmd_parms,command_rec,BUFF,uri_components\
+ ,proxyreqtype\
|\
|\
|dict-$*.html
@@ -627,10 +628,12 @@
unsigned keptalive:1; \n \
signed int double_reverse:2; \n \
int keepalives; \n \
+ char *local_ip; \n \
+ char *local_host; \n \
};\
|\
|SA-core-rec\
- |
+ |dict-$*.html
S|regex_t\
|typedef struct { \n \
int re_magic; \n \
@@ -659,15 +662,15 @@
request_rec *main; \n \
char *the_request; \n \
int assbackwards; \n \
- int proxyreq; \n \
+ enum proxyreqtype proxyreq; \n \
int header_only; \n \
char *protocol; \n \
int proto_num; \n \
char *hostname; \n \
time_t request_time; \n \
- char *status_line; \n \
+ const char *status_line; \n \
int status; \n \
- char *method; \n \
+ const char *method; \n \
int method_number; \n \
int allowed; \n \
int sent_bodyct; \n \
@@ -676,22 +679,24 @@
int chunked; \n \
int byterange; \n \
char *boundary; \n \
- char *range; \n \
+ const char *range; \n \
long clength; \n \
long remaining; \n \
long read_length; \n \
int read_body; \n \
int read_chunked; \n \
+ unsigned expecting_100; \n \
table *headers_in; \n \
table *headers_out; \n \
table *err_headers_out; \n \
table *subprocess_env; \n \
table *notes; \n \
- char *content_type; \n \
- char *handler; \n \
- char *content_encoding; \n \
- char *content_language; \n \
+ const char *content_type; \n \
+ const char *handler; \n \
+ const char *content_encoding; \n \
+ const char *content_language; \n \
array_header *content_languages; \n \
+ char *vlist_validator; \n \
int no_cache; \n \
int no_local_copy; \n \
char *unparsed_uri; \n \
@@ -704,10 +709,11 @@
void *per_dir_config; \n \
void *request_config; \n \
const struct htaccess_result *htaccess; \n \
+ char *case_preserved_filename; \n \
};\
|\
|SA-core-rec\
- |
+ |dict-$*.html
S|server_rec\
|struct server_rec { \n \
\n \
@@ -863,6 +869,34 @@
|SA-overrides\
|dict-$*.html
#;
+#; Random constants
+#;
+X|CTCEs\
+ |BIG_SECURITY_HOLE,DOCUMENT_LOCATION,DYNAMIC_MODULE_LIMIT,HTTPD_ROOT\
+ |\
+ |\
+ |
+C|BIG_SECURITY_HOLE\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|DOCUMENT_LOCATION\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=\"/usr/httpd/htdocs\"" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|DYNAMIC_MODULE_LIMIT\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=64" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|HTTPD_ROOT\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=\"/usr/httpd\"" ./configure\
+ |CTCEs\
+ |dict-$*.html
+#;
#; Tables..
#;
X|SA-tables\
@@ -1231,6 +1265,15 @@
}; \
|\
|SA-dirdata\
+ |dict-$*.html
+C|proxyreqtype\
+ |enum proxyreqtype { \n \
+ NOT_PROXY=0, \n \
+ STD_PROXY, \n \
+ PROXY_PASS \n \
+}; \n \
+ |\
+ |request_rec\
|dict-$*.html
C|RAW_ARGS\
|<i>see</i> cmd_how.\
1.3 +7 -0 httpd-docs-1.3/apidoc/dict-conn_rec.html
Index: dict-conn_rec.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-conn_rec.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- dict-conn_rec.html 2000/07/13 12:44:38 1.2
+++ dict-conn_rec.html 2000/07/23 15:32:50 1.3
@@ -12,6 +12,13 @@
</p>
<dl compact>
<dt><b>Note:</b></dt>
+ <dd>An unfortunate assumption was made during the early days of
+ Apache that only one set of authentication credentials would be
+ in use for any connexion, even persistent ones. That is why this
+ structure includes the credential information instead of the
+ <code>request_rec</code>, which is where it actually belongs.
+ This has been corrected for Apache 2.0.</dd>
+ <dt><b>Note:</b></dt>
<dd>This structure has been very stable through the Apache 1.3
series of releases, but has been updated for 2.0.</dd>
</dl>
1.3 +10 -0 httpd-docs-1.3/apidoc/dict-request_rec.html
Index: dict-request_rec.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-request_rec.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- dict-request_rec.html 2000/07/13 12:44:39 1.2
+++ dict-request_rec.html 2000/07/23 15:32:50 1.3
@@ -1,4 +1,14 @@
<p>
+The <code>request_rec</code> structure is key to Apache's
+processing of client requests. A pointer to a
+<code>request_req</code> structure is passed to all
+phase handlers and many API routines, and it is usually
+given the argument name '<code>r</code>' (<i>e.g.</i>,
+<code>ap_add_common_vars(r)</code>).
</p>
<p>
+If a module routine is passed a <code>request_rec</code> structure,
+the <code>pool</code> pointer in the structure is available for
+memory allocation. When the request is completed, the
+memory pool will be released.
</p>
1.10 +5 -2 httpd-docs-1.3/apidoc/mkapidict
Index: mkapidict
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/mkapidict,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -u -r1.9 -r1.10
--- mkapidict 2000/07/13 12:44:39 1.9
+++ mkapidict 2000/07/23 15:32:50 1.10
@@ -371,8 +371,11 @@
$trim_next = 0 if ($line =~ m:\\n$:);
$line .= &get_record($trim_next, 1);
}
- $line =~ s:\\n:\n:g;
- $RecordNum++ if ($line && (! $continued));
+ if ($line && (! $continued)) {
+ $RecordNum++;
+ $line =~ s:([^\\])\\n:\1\n:g;
+ $line =~ s:\\\\:\\:g;
+ }
return ($line);
}
1.1 httpd-docs-1.3/apidoc/dict-BIG_SECURITY_HOLE.html
Index: dict-BIG_SECURITY_HOLE.html
===================================================================
<p>
Ordinarily the Apache server is started as the <code>root</code>
superuser, and then switches to an unprivileged user identity as soon
as possible. If you try to have Apache continue its normal operations
as <code>root</code>, it will display an error message and exit.
If you <i>really</i> want the server to start as <code>root</code> and
not switch identities, you need to rebuild the server with this compile-time
definition.
</p>
<dl compact>
<dt><b>Note:</b></dt>
<dd>Having the Web server perform its normal operations as the
superuser <code>root</code> is very dangerous, and not recommended.</dd>
</dl>
1.1 httpd-docs-1.3/apidoc/dict-DOCUMENT_LOCATION.html
Index: dict-DOCUMENT_LOCATION.html
===================================================================
<p>
This constant is the hard-coded default for the <code>DocumentRoot</code>
directive. Like the <code>HTTPD_ROOT</code> definition, its value differs
from operating system to operating system:
</p>
<dl>
<dt><b>OS/2:</b></dt>
<dd><code>{HTTPD_ROOT}/docs</code></dd>
<dt><b>Everything else:</b></dt>
<dd><code>{HTTPD_ROOT}/htdocs</code></dd>
</dl>
<p>
The default value is based on the definition of the <code>HTTPD_ROOT</code>
compile-time definition (<i>q.v.</i>).
</p>
1.1 httpd-docs-1.3/apidoc/dict-DYNAMIC_MODULE_LIMIT.html
Index: dict-DYNAMIC_MODULE_LIMIT.html
===================================================================
<p>
This constant defines the maximum number of modules that can be dynamically
loaded. The default value is 64, which is usually sufficient.
</p>
1.1 httpd-docs-1.3/apidoc/dict-HTTPD_ROOT.html
Index: dict-HTTPD_ROOT.html
===================================================================
<p>
This constant is the hard-coded default for the <code>ServerRoot</code>
directive. Its value differs from operating system to operating
system:
</p>
<dl>
<dt><b>OS/2:</b></dt>
<dd><code>/os2httpd</code></dd>
<dt><b>Windows:</b></dt>
<dd><code>/apache</code></dd>
<dt><b>BeOS:</b></dt>
<dd><code>/boot/home/apache</code></dd>
<dt><b>NetWare:</b></dt>
<dd><code>sys:/apache</code></dd>
<dt><b>Everything else:</b></dt>
<dd><code>/usr/local/apache</code></dd>
</dl>
<p>
This default value is typically overridden at compile-time by
the build script.
</p>
Modified: apidoc api.list dict-conn_rec.html dict-request_rec.html
mkapidict
Added: apidoc dict-BIG_SECURITY_HOLE.html
dict-DOCUMENT_LOCATION.html
dict-DYNAMIC_MODULE_LIMIT.html dict-HTTPD_ROOT.html
Log:
Add some constants settable on the compilation command line,
flesh out a couple of structure descriptions (at least a
little), and correct the structure definitions.
Revision Changes Path
1.15 +53 -10 httpd-docs-1.3/apidoc/api.list
Index: api.list
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/api.list,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -u -r1.14 -r1.15
--- api.list 2000/07/13 12:44:24 1.14
+++ api.list 2000/07/23 15:32:50 1.15
@@ -603,6 +603,7 @@
#;
X|SA-core-rec\
|conn_rec,request_rec,server_rec,cmd_parms,command_rec,BUFF,uri_components\
+ ,proxyreqtype\
|\
|\
|dict-$*.html
@@ -627,10 +628,12 @@
unsigned keptalive:1; \n \
signed int double_reverse:2; \n \
int keepalives; \n \
+ char *local_ip; \n \
+ char *local_host; \n \
};\
|\
|SA-core-rec\
- |
+ |dict-$*.html
S|regex_t\
|typedef struct { \n \
int re_magic; \n \
@@ -659,15 +662,15 @@
request_rec *main; \n \
char *the_request; \n \
int assbackwards; \n \
- int proxyreq; \n \
+ enum proxyreqtype proxyreq; \n \
int header_only; \n \
char *protocol; \n \
int proto_num; \n \
char *hostname; \n \
time_t request_time; \n \
- char *status_line; \n \
+ const char *status_line; \n \
int status; \n \
- char *method; \n \
+ const char *method; \n \
int method_number; \n \
int allowed; \n \
int sent_bodyct; \n \
@@ -676,22 +679,24 @@
int chunked; \n \
int byterange; \n \
char *boundary; \n \
- char *range; \n \
+ const char *range; \n \
long clength; \n \
long remaining; \n \
long read_length; \n \
int read_body; \n \
int read_chunked; \n \
+ unsigned expecting_100; \n \
table *headers_in; \n \
table *headers_out; \n \
table *err_headers_out; \n \
table *subprocess_env; \n \
table *notes; \n \
- char *content_type; \n \
- char *handler; \n \
- char *content_encoding; \n \
- char *content_language; \n \
+ const char *content_type; \n \
+ const char *handler; \n \
+ const char *content_encoding; \n \
+ const char *content_language; \n \
array_header *content_languages; \n \
+ char *vlist_validator; \n \
int no_cache; \n \
int no_local_copy; \n \
char *unparsed_uri; \n \
@@ -704,10 +709,11 @@
void *per_dir_config; \n \
void *request_config; \n \
const struct htaccess_result *htaccess; \n \
+ char *case_preserved_filename; \n \
};\
|\
|SA-core-rec\
- |
+ |dict-$*.html
S|server_rec\
|struct server_rec { \n \
\n \
@@ -863,6 +869,34 @@
|SA-overrides\
|dict-$*.html
#;
+#; Random constants
+#;
+X|CTCEs\
+ |BIG_SECURITY_HOLE,DOCUMENT_LOCATION,DYNAMIC_MODULE_LIMIT,HTTPD_ROOT\
+ |\
+ |\
+ |
+C|BIG_SECURITY_HOLE\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|DOCUMENT_LOCATION\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=\"/usr/httpd/htdocs\"" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|DYNAMIC_MODULE_LIMIT\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=64" ./configure\
+ |CTCEs\
+ |dict-$*.html
+C|HTTPD_ROOT\
+ |Compile-time definition\
+ |env CFLAGS="-Wall -D$*=\"/usr/httpd\"" ./configure\
+ |CTCEs\
+ |dict-$*.html
+#;
#; Tables..
#;
X|SA-tables\
@@ -1231,6 +1265,15 @@
}; \
|\
|SA-dirdata\
+ |dict-$*.html
+C|proxyreqtype\
+ |enum proxyreqtype { \n \
+ NOT_PROXY=0, \n \
+ STD_PROXY, \n \
+ PROXY_PASS \n \
+}; \n \
+ |\
+ |request_rec\
|dict-$*.html
C|RAW_ARGS\
|<i>see</i> cmd_how.\
1.3 +7 -0 httpd-docs-1.3/apidoc/dict-conn_rec.html
Index: dict-conn_rec.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-conn_rec.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- dict-conn_rec.html 2000/07/13 12:44:38 1.2
+++ dict-conn_rec.html 2000/07/23 15:32:50 1.3
@@ -12,6 +12,13 @@
</p>
<dl compact>
<dt><b>Note:</b></dt>
+ <dd>An unfortunate assumption was made during the early days of
+ Apache that only one set of authentication credentials would be
+ in use for any connexion, even persistent ones. That is why this
+ structure includes the credential information instead of the
+ <code>request_rec</code>, which is where it actually belongs.
+ This has been corrected for Apache 2.0.</dd>
+ <dt><b>Note:</b></dt>
<dd>This structure has been very stable through the Apache 1.3
series of releases, but has been updated for 2.0.</dd>
</dl>
1.3 +10 -0 httpd-docs-1.3/apidoc/dict-request_rec.html
Index: dict-request_rec.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-request_rec.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- dict-request_rec.html 2000/07/13 12:44:39 1.2
+++ dict-request_rec.html 2000/07/23 15:32:50 1.3
@@ -1,4 +1,14 @@
<p>
+The <code>request_rec</code> structure is key to Apache's
+processing of client requests. A pointer to a
+<code>request_req</code> structure is passed to all
+phase handlers and many API routines, and it is usually
+given the argument name '<code>r</code>' (<i>e.g.</i>,
+<code>ap_add_common_vars(r)</code>).
</p>
<p>
+If a module routine is passed a <code>request_rec</code> structure,
+the <code>pool</code> pointer in the structure is available for
+memory allocation. When the request is completed, the
+memory pool will be released.
</p>
1.10 +5 -2 httpd-docs-1.3/apidoc/mkapidict
Index: mkapidict
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/mkapidict,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -u -r1.9 -r1.10
--- mkapidict 2000/07/13 12:44:39 1.9
+++ mkapidict 2000/07/23 15:32:50 1.10
@@ -371,8 +371,11 @@
$trim_next = 0 if ($line =~ m:\\n$:);
$line .= &get_record($trim_next, 1);
}
- $line =~ s:\\n:\n:g;
- $RecordNum++ if ($line && (! $continued));
+ if ($line && (! $continued)) {
+ $RecordNum++;
+ $line =~ s:([^\\])\\n:\1\n:g;
+ $line =~ s:\\\\:\\:g;
+ }
return ($line);
}
1.1 httpd-docs-1.3/apidoc/dict-BIG_SECURITY_HOLE.html
Index: dict-BIG_SECURITY_HOLE.html
===================================================================
<p>
Ordinarily the Apache server is started as the <code>root</code>
superuser, and then switches to an unprivileged user identity as soon
as possible. If you try to have Apache continue its normal operations
as <code>root</code>, it will display an error message and exit.
If you <i>really</i> want the server to start as <code>root</code> and
not switch identities, you need to rebuild the server with this compile-time
definition.
</p>
<dl compact>
<dt><b>Note:</b></dt>
<dd>Having the Web server perform its normal operations as the
superuser <code>root</code> is very dangerous, and not recommended.</dd>
</dl>
1.1 httpd-docs-1.3/apidoc/dict-DOCUMENT_LOCATION.html
Index: dict-DOCUMENT_LOCATION.html
===================================================================
<p>
This constant is the hard-coded default for the <code>DocumentRoot</code>
directive. Like the <code>HTTPD_ROOT</code> definition, its value differs
from operating system to operating system:
</p>
<dl>
<dt><b>OS/2:</b></dt>
<dd><code>{HTTPD_ROOT}/docs</code></dd>
<dt><b>Everything else:</b></dt>
<dd><code>{HTTPD_ROOT}/htdocs</code></dd>
</dl>
<p>
The default value is based on the definition of the <code>HTTPD_ROOT</code>
compile-time definition (<i>q.v.</i>).
</p>
1.1 httpd-docs-1.3/apidoc/dict-DYNAMIC_MODULE_LIMIT.html
Index: dict-DYNAMIC_MODULE_LIMIT.html
===================================================================
<p>
This constant defines the maximum number of modules that can be dynamically
loaded. The default value is 64, which is usually sufficient.
</p>
1.1 httpd-docs-1.3/apidoc/dict-HTTPD_ROOT.html
Index: dict-HTTPD_ROOT.html
===================================================================
<p>
This constant is the hard-coded default for the <code>ServerRoot</code>
directive. Its value differs from operating system to operating
system:
</p>
<dl>
<dt><b>OS/2:</b></dt>
<dd><code>/os2httpd</code></dd>
<dt><b>Windows:</b></dt>
<dd><code>/apache</code></dd>
<dt><b>BeOS:</b></dt>
<dd><code>/boot/home/apache</code></dd>
<dt><b>NetWare:</b></dt>
<dd><code>sys:/apache</code></dd>
<dt><b>Everything else:</b></dt>
<dd><code>/usr/local/apache</code></dd>
</dl>
<p>
This default value is typically overridden at compile-time by
the build script.
</p>