You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by co...@apache.org on 2001/10/30 11:20:10 UTC
cvs commit: httpd-docs-1.3/apidoc ap-dict.dtd api.xml
coar 01/10/30 02:20:10
Modified: apidoc ap-dict.dtd api.xml
Log:
Import some of the descriptions
Revision Changes Path
1.2 +17 -1 httpd-docs-1.3/apidoc/ap-dict.dtd
Index: ap-dict.dtd
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/ap-dict.dtd,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- ap-dict.dtd 2001/07/26 17:34:24 1.1
+++ ap-dict.dtd 2001/10/30 10:20:10 1.2
@@ -10,13 +10,22 @@
comment*,
para*,
comment*)">
+<!ENTITY % elements.b
+ "i
+ |literal">
+<!ENTITY % content.b
+ "(#PCDATA
+ |%elements.b;)*">
+
<!ENTITY % elements.comment
"">
<!ENTITY % content.comment
"(#PCDATA)*">
<!ENTITY % elements.declaration
- "comment
+ "b
+ |comment
+ |i
|literal
|ref
|type
@@ -71,6 +80,13 @@
|flag">
<!ENTITY % content.flags
"(%elements.flags;)*">
+
+<!ENTITY % elements.i
+ "b
+ |literal">
+<!ENTITY % content.i
+ "(#PCDATA
+ |%elements.i;)*">
<!ENTITY % elements.item
"">
1.3 +70 -8 httpd-docs-1.3/apidoc/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/api.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -u -r1.2 -r1.3
--- api.xml 2001/07/26 17:33:27 1.2
+++ api.xml 2001/10/30 10:20:10 1.3
@@ -6,9 +6,26 @@
<name>ACCESS_CONF</name>
<definition>
<declaration>#include "http_config.h"</declaration>
- <description href="dict-ACCESS_CONF.html" />
+ <description>
+ <para>
+ Allowed locations for a configuration directive are the union of
+ those indicated by each set bit in the
+ <literal>req_override</literal>
+ mask in the
+ <literal><ref>command_rec</ref></literal> structure.
+ </para>
+ <para>
+ A directive with the
+ <literal>ACCESS_CONF</literal>
+ bit set may appear
+ in the server-wide configuration files
+ (<i>e.g.</i>, <literal>httpd.conf</literal>)
+ inside <Directory> or <Location> containers.
+ </para>
+ </description>
<example>
- <text>static const command_rec module_cmds[] =
+ <text>
+static const command_rec module_cmds[] =
{
.
{"ModuleDirective", cmd_moduledirective, NULL, ACCESS_CONF, RAW_ARGS,
@@ -626,13 +643,21 @@
<name>FLAG</name>
<definition>
<declaration>#include "httpd.h"
-<i>see</i> cmd_how.</declaration>
- <description href="dict-FLAG.html" />
+ <i>see</i> <ref>cmd_how<ref>.</declaration>
+ <description>
+ <para>
+ This value indicates that the directive in whose definition it appears
+ takes a single Boolean keyword argument, one of 'Off' or 'On'. When the
+ directive handler is invoked, the argument will be an
+ <literal>int</literal>
+ value -- either zero or non-zero, respectively.
+ </para>
+ </description>
<example>
<text>static const command_rec module_cmds[] =
{
.
- {"ModuleDirective", cmd_moduledirective, NULL, OR_LIMIT, FLAG,
+ {"ModuleDirective", cmd_moduledirective, NULL, <ref>OR_LIMIT</ref>, <ref>FLAG</ref>,
"directive description"},
.
{NULL}
@@ -1540,7 +1565,7 @@
<text>static const command_rec module_cmds[] =
{
.
- {"ModuleDirective", cmd_moduledirective, NULL, OR_LIMIT, ITERATE,
+ {"ModuleDirective", cmd_moduledirective, NULL, <ref>OR_LIMIT</ref>, <ref>ITERATE</ref>,
"directive description"},
.
{NULL}
@@ -2250,7 +2275,27 @@
<name>OR_AUTHCFG</name>
<definition>
<declaration>#include "http_config.h"</declaration>
- <description href="dict-OR_AUTHCFG.html" />
+ <description>
+ <para>
+ Allowed locations for a configuration directive are the union of
+ those indicated by each set bit in the
+ <literal>req_override</literal>
+ mask in the
+ <literal><ref>command_rec</ref></literal>
+ structure.
+ </para>
+ <para>
+ A directive with the
+ <literal>OR_AUTHCFG</literal>
+ bit set may appear in the server-wide configuration files
+ (<i>e.g.</i>, <literal>httpd.conf</literal>)
+ inside <Directory> or <Location> containers, and in
+ <literal>.htaccess</literal>
+ files when the scope is covered by an
+ <literal>AllowOverride AuthConfig</literal>
+ keyword.
+ </para>
+ </description>
<example>
<text>static const command_rec module_cmds[] =
{
@@ -2430,7 +2475,24 @@
<name>RSRC_CONF</name>
<definition>
<declaration>#include "http_config.h"</declaration>
- <description href="dict-RSRC_CONF.html" />
+ <description>
+ <para>
+ Allowed locations for a configuration directive are the union of
+ those indicated by each set bit in the
+ <literal>req_override</literal>
+ mask in the
+ <literal><ref>command_rec</ref></literal>
+ structure.
+ </para>
+ <para>
+ A directive with the
+ <literal>RSRC_CONF</literal>
+ bit set may appear
+ in the server-wide configuration files
+ (<i>e.g.</i>, <literal>httpd.conf</literal>)
+ outside <Directory> or <Location> containers.
+ </para>
+ </description>
<example>
<text>static const command_rec module_cmds[] =
{