stas 2002/12/01 21:46:07
Modified: src/docs/2.0/user/config config.pod
Log:
reorganize the sections order and heading levels to have a nicely
organized TOC
Revision Changes Path
1.28 +194 -57 modperl-docs/src/docs/2.0/user/config/config.pod
Index: config.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/user/config/config.pod,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- config.pod 29 Nov 2002 04:55:03 -0000 1.27
+++ config.pod 2 Dec 2002 05:46:07 -0000 1.28
@@ -128,7 +128,38 @@
-=head1 Perl's Command Line Switches
+=head1 Server Configuration Directives
+
+=head2 C<PerlRequire>
+
+ META: to be written
+
+=head2 C<PerlModule>
+
+ META: to be written
+
+=head2 C<PerlSetVar>
+
+ META: to be written
+
+=head2 C<PerlAddVar>
+
+ META: to be written
+
+=head2 C<PerlSetEnv>
+
+ META: to be written
+
+=head2 C<PerlPassEnv>
+
+ META: to be written
+
+=head2 C<E<lt>PerlE<gt>> Sections
+
+ META: to be written. probably needs a dedicated chapter.
+
+
+=head2 C<PerlSwitches>
Now you can pass any Perl's command line switches in I<httpd.conf>
using the C<PerlSwitches> directive. For example to enable warnings
@@ -147,16 +178,12 @@
whereas C<-I> does not.
+=head2 C<SetHandler>
+mod_perl 2.0 provides two types of C<SetHandler> handlers: C<modperl>
+and C<perl-script>.
-
-
-=head1 mod_perl 2.0 Handlers
-
-mod_perl 2.0 provides two types of handlers: C<modperl> and
-C<perl-script>.
-
-=head2 modperl
+=head3 C<modperl>
Configured as:
@@ -214,7 +241,7 @@
which always populate C<r-E<gt>subprocess_env>, but this doesn't happen
until the Apache I<fixups> phase, which could be too late for your needs.
-=head2 perl-script
+=head3 C<perl-script>
Configured as:
@@ -257,15 +284,7 @@
=back
-
-
-
-
-
-
-
-
-=head1 C<PerlOptions> Directive
+=head2 C<PerlOptions>
The directive C<PerlOptions> provides fine-grained configuration for
what were compile-time only options in the first mod_perl generation.
@@ -276,7 +295,7 @@
Options are enabled by prepending C<+> and disabled with C<->. The
options include:
-=head2 C<Enable>
+=head3 C<Enable>
On by default, can be used to disable mod_perl for a given
C<VirtualHost>. For example:
@@ -285,7 +304,7 @@
PerlOptions -Enable
</VirtualHost>
-=head2 C<Clone>
+=head3 C<Clone>
Share the parent Perl interpreter, but give the C<VirtualHost> its own
interpreter pool. For example should you wish to fine tune interpreter
@@ -311,7 +330,7 @@
</VirtualHost>
-=head2 C<Parent>
+=head3 C<Parent>
Create a new parent Perl interpreter for the given C<VirtualHost> and
give it its own interpreter pool (implies the C<Clone> option).
@@ -350,7 +369,7 @@
will use a fresh interpreter with its own namespace to handle each
request.
-=head2 C<Perl*Handler>
+=head3 C<Perl*Handler>
Disable C<Perl*Handler>s, all compiled-in handlers are enabled by
default. The option name is derived from the C<Perl*Handler> name, by
@@ -374,7 +393,7 @@
PerlOptions None +Response
</VirtualHost>
-=head2 C<AutoLoad>
+=head3 C<AutoLoad>
Resolve C<Perl*Handlers> at startup time, which includes loading the
modules from disk if not already loaded.
@@ -403,7 +422,7 @@
in our example.
-=head2 C<GlobalRequest>
+=head3 C<GlobalRequest>
Setup the global C<request_rec> for use with C<Apache-E<gt>request>.
This setting is needed for example if you use C<CGI.pm> to process the
@@ -426,7 +445,7 @@
-=head2 C<ParseHeaders>
+=head3 C<ParseHeaders>
Scan output for HTTP headers, same functionality as mod_perl 1.0's
C<PerlSendHeader>, but more robust. This option is usually needs to
@@ -434,7 +453,7 @@
print "Content-type: text/html\n\n";
-=head2 C<MergeHandlers>
+=head3 C<MergeHandlers>
Turn on merging of C<Perl*Handler> arrays. For example with a setting:
@@ -458,7 +477,7 @@
C<Apache::FixupB> handlers.
-=head2 C<SetupEnv>
+=head3 C<SetupEnv>
Set up environment variables for each request ala mod_cgi.
@@ -541,11 +560,124 @@
+=head1 Server Life Cycle Handlers Directives
+
+See L<Server life cycle|docs::2.0::user::handlers::server/>.
+
+
+
+=head2 C<PerlOpenLogsHandler>
+
+See
C<L<PerlOpenLogsHandler|docs::2.0::user::handlers::server/PerlOpenLogsHandler>>.
+
+=head2 C<PerlPostConfigHandler>
+
+See
C<L<PerlPostConfigHandler|docs::2.0::user::handlers::server/PerlPostConfigHandler>>.
+
+=head2 C<PerlChildInitHandler>
+
+See
C<L<PerlChildInitHandler|docs::2.0::user::handlers::server/PerlChildInitHandler>>.
+
+=head2 C<PerlChildExitHandler>
+
+See
C<L<PerlChildExitHandler|docs::2.0::user::handlers::server/PerlChildExitHandler>>.
+
+
+
+
+
+
+
+=head1 Protocol Handlers Directives
+
+See L<Protocol handlers|docs::2.0::user::handlers::protocols/>.
+
+
+
+=head2 C<PerlPreConnectionHandler>
+
+See
C<L<PerlPreConnectionHandler|docs::2.0::user::handlers::protocols/PerlPreConnectionHandler>>.
+
+=head2 C<PerlProcessConnectionHandler>
+
+See
C<L<PerlProcessConnectionHandler|docs::2.0::user::handlers::protocols/PerlProcessConnectionHandler>>.
+
+
+
+
+
+
+=head1 Filter Handlers Directives
+
+See L<Filter handlers|docs::2.0::user::handlers::filters/>.
+
+
+
+=head2 C<PerlInputFilterHandler>
+
+See
C<L<PerlInputFilterHandler|docs::2.0::user::handlers::filters/PerlInputFilterHandler>>.
+
+=head2 C<PerlOutputFilterHandler>
+
+See
C<L<PerlOutputFilterHandler|docs::2.0::user::handlers::filters/PerlOutputFilterHandler>>.
+
+
+
+
-=head1 Handlers Directives
-See L<The handlers chapters|docs::2.0::user::handlers::index>.
+=head1 HTTP Protocol Handlers Directives
+See L<HTTP protocol handlers|docs::2.0::user::handlers::http/>.
+
+
+=head2 C<PerlPostReadRequestHandler>
+
+See
C<L<PerlPostReadRequestHandler|docs::2.0::user::handlers::http/PerlPostReadRequestHandler>>.
+
+=head2 C<PerlTransHandler>
+
+See C<L<PerlTransHandler|docs::2.0::user::handlers::http/PerlTransHandler>>.
+
+=head2 C<PerlInitHandler>
+
+See C<L<PerlInitHandler|docs::2.0::user::handlers::http/PerlInitHandler>>.
+
+=head2 C<PerlHeaderParserHandler>
+
+See
C<L<PerlHeaderParserHandler|docs::2.0::user::handlers::http/PerlHeaderParserHandler>>.
+
+=head2 C<PerlAccessHandler>
+
+See
C<L<PerlAccessHandler|docs::2.0::user::handlers::http/PerlAccessHandler>>.
+
+=head2 C<PerlAuthenHandler>
+
+See
C<L<PerlAuthenHandler|docs::2.0::user::handlers::http/PerlAuthenHandler>>.
+
+=head2 C<PerlAuthzHandler>
+
+See C<L<PerlAuthzHandler|docs::2.0::user::handlers::http/PerlAuthzHandler>>.
+
+=head2 C<PerlTypeHandler>
+
+See C<L<PerlTypeHandler|docs::2.0::user::handlers::http/PerlTypeHandler>>.
+
+=head2 C<PerlFixupHandler>
+
+See C<L<PerlFixupHandler|docs::2.0::user::handlers::http/PerlFixupHandler>>.
+
+=head2 C<PerlResponseHandler>
+
+See
C<L<PerlResponseHandler|docs::2.0::user::handlers::http/PerlResponseHandler>>.
+
+=head2 C<PerlLogHandler>
+
+See C<L<PerlLogHandler|docs::2.0::user::handlers::http/PerlLogHandler>>.
+
+=head2 C<PerlCleanupHandler>
+
+See
C<L<PerlCleanupHandler|docs::2.0::user::handlers::http/PerlCleanupHandler>>.
@@ -633,7 +765,38 @@
PerlInterpScope connection
+=head1 Debug Directives
+
+=head2 C<PerlTrace>
+
+The C<PerlTrace> is used for tracing the mod_perl execution. This
+directive is enabled when mod_perl is compiled with the C<MP_TRACE=1>
+option.
+
+To enable tracing, add to I<httpd.conf>:
+
+ PerlTrace [level]
+
+where C<level> is either:
+
+ all
+
+which sets maximum logging and debugging levels;
+
+a combination of one or more option letters (or option numerical
+equivalents) from the following list:
+
+ d ( 1) directive processing
+ f ( 2) filters
+ g ( 4) Perl runtime interaction
+ h ( 8) handlers
+ i ( 16) interpreter pool management
+ m ( 32) memory allocations
+ s ( 64) perl sections
+ t (128) benchmark-ish timings
+When C<level> is not specified, the tracing level will be set to the
+value of the C<$ENV{MOD_PERL_TRACE}> environment variable.
@@ -819,7 +982,7 @@
print "Running in a single mode";
}
-=head2 MODPERL2 Define Option
+=head2 C<MODPERL2> Define Option
When running under mod_perl 2.0 a special configuration "define"
symbol C<MODPERL2> is enabled internally, as if the server had been
@@ -859,32 +1022,6 @@
-
-=head1 Debug Directives
-
-=head2 C<PerlTrace [level]>
-
-set the trace level. This directive is enabled when mod_perl is
-compiled with the MP_TRACE option. C<level> is either:
-
- all
-
-which sets maximum logging and debugging levels;
-
-a combination of one or more option letters (or option numerical
-equivalents) from the following list:
-
- d ( 1) directive processing
- f ( 2) filters
- g ( 4) Perl runtime interaction
- h ( 8) handlers
- i ( 16) interpreter pool management
- m ( 32) memory allocations
- s ( 64) perl sections
- t (128) benchmark-ish timings
-
-When C<level> is not specified, the tracing level will be set to the
-value of the MOD_PERL_TRACE environment variable.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
