Author: randyk Date: Sat Apr 2 13:39:46 2005 New Revision: 159819 URL: http://svn.apache.org/viewcvs?view=rev&rev=159819 Log: s/Apache/Apache2/
Modified: perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/Module.pod Modified: perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/Module.pod URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/Module.pod?view=diff&r1=159818&r2=159819 ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/Module.pod (original) +++ perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/Module.pod Sat Apr 2 13:39:46 2005 @@ -1,13 +1,13 @@ =head1 NAME -Apache::Module - Perl API for creating and working with Apache modules +Apache2::Module - Perl API for creating and working with Apache modules =head1 Synopsis - use Apache::Module (); + use Apache2::Module (); #Define a configuration directive my @directives = ( @@ -16,10 +16,10 @@ } ); - Apache::Module::add(__PACKAGE__, [EMAIL PROTECTED]); + Apache2::Module::add(__PACKAGE__, [EMAIL PROTECTED]); # iterate over the whole module list - for (my $modp = Apache::Module::top_module(); $modp; $modp = $modp->next) { + for (my $modp = Apache2::Module::top_module(); $modp; $modp = $modp->next) { my $name = $modp->name; my $index = $modp->module_index; my $ap_api_major_version = $modp->ap_api_major_version; @@ -28,7 +28,7 @@ } # find a specific module - my $module = Apache::Module::find_linked_module('mod_ssl.c'); + my $module = Apache2::Module::find_linked_module('mod_ssl.c'); # remove a specific module $module->remove_loaded_module(); @@ -36,17 +36,17 @@ # access module configuration from a directive sub MyDirective { my ($self, $parms, $args) = @_; - my $srv_cfg = Apache::Module::get_config($self, $parms->server); + my $srv_cfg = Apache2::Module::get_config($self, $parms->server); [...] } # test if an Apache module is loaded - if (Apache::Module::loaded('mod_ssl.c')) { + if (Apache2::Module::loaded('mod_ssl.c')) { [...] } # test if a Perl module is loaded - if (Apache::Module::loaded('Apache::Status')) { + if (Apache2::Module::loaded('Apache2::Status')) { [...] } @@ -58,7 +58,7 @@ =head1 Description -C<Apache::Module> provides the Perl API for creating and working with +C<Apache2::Module> provides the Perl API for creating and working with Apache modules See L<Apache Server Configuration Customization in @@ -70,7 +70,7 @@ =head1 API -C<Apache::Module> provides the following functions and/or methods: +C<Apache2::Module> provides the following functions and/or methods: @@ -80,7 +80,7 @@ Add a module's custom configuration directive to Apache. - Apache::Module::add($package, $cmds); + Apache2::Module::add($package, $cmds); =over 4 @@ -117,7 +117,7 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$major_version> ( integer ) @@ -142,7 +142,7 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$minor_version> ( integer ) @@ -160,7 +160,7 @@ =head2 C<cmds> -Get the C<L<Apache::Command|docs::2.0::api::Apache::Command>> object, +Get the C<L<Apache2::Command|docs::2.0::api::Apache2::Command>> object, describing all of the directives this module defines. $command = $module->cmds(); @@ -168,10 +168,10 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$command> -( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> ) +( C<L<Apache2::Command object|docs::2.0::api::Apache2::Command>> ) =item since: 1.99_12 @@ -187,33 +187,33 @@ Retrieve a module's configuration. Used by configuration directives. - $cfg = Apache::Module::get_config($class, $server, $dir_config); - $cfg = Apache::Module::get_config($class, $server); + $cfg = Apache2::Module::get_config($class, $server, $dir_config); + $cfg = Apache2::Module::get_config($class, $server); $cfg = $self->get_config($server, $dir_config); $cfg = $self->get_config($server); =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item arg1: C<$class> ( string ) The Perl package this configuration is for =item arg2: C<$server> -( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> ) +( C<L<Apache2::ServerRec object|docs::2.0::api::Apache2::ServerRec>> ) The current server, typically -C<L<$r-E<gt>server|docs::2.0::api::Apache::ServerUtil>> or -C<L<$parms-E<gt>server|docs::2.0::api::Apache::CmdParms>>. +C<L<$r-E<gt>server|docs::2.0::api::Apache2::ServerUtil>> or +C<L<$parms-E<gt>server|docs::2.0::api::Apache2::CmdParms>>. =item opt arg3: C<$dir_config> -( C<L<Apache::ConfVector object|docs::2.0::api::Apache::ConfVector>> ) +( C<L<Apache2::ConfVector object|docs::2.0::api::Apache2::ConfVector>> ) By default, the configuration returned is the server level one. To retrieve the per directory configuration, use -C<L<$r-E<gt>per_dir_config|docs::2.0::api::Apache::RequestRec>> as a +C<L<$r-E<gt>per_dir_config|docs::2.0::api::Apache2::RequestRec>> as a last argument. =item ret: C<$cfg> (HASH reference) @@ -236,7 +236,7 @@ Find a module based on the name of the module - $module = Apache::Module::find_linked_module($name); + $module = Apache2::Module::find_linked_module($name); =over 4 @@ -245,7 +245,7 @@ The name of the module ending in C<.c> =item ret: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) The module object if found, C<undef> otherwise. @@ -255,7 +255,7 @@ For example: - my $module = Apache::Module::find_linked_module('mod_ssl.c'); + my $module = Apache2::Module::find_linked_module('mod_ssl.c'); @@ -266,7 +266,7 @@ Determine if a certain module is loaded - $loaded = Apache::Module::loaded($module); + $loaded = Apache2::Module::loaded($module); =over 4 @@ -293,20 +293,20 @@ For example, to test if this server supports ssl: - if (Apache::Module::loaded('mod_ssl.c')) { + if (Apache2::Module::loaded('mod_ssl.c')) { [...] } To test is this server dynamically loaded mod_perl: - if (Apache::Module::loaded('mod_perl.so')) { + if (Apache2::Module::loaded('mod_perl.so')) { [...] } -To test if C<L<Apache::Status|docs::2.0::api::Apache::Status>> is +To test if C<L<Apache2::Status|docs::2.0::api::Apache2::Status>> is loaded: - if (Apache::Module::loaded('Apache::Status')) { + if (Apache2::Module::loaded('Apache2::Status')) { [...] } @@ -325,7 +325,7 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$index> ( integer ) @@ -346,7 +346,7 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$name> ( string ) @@ -373,10 +373,10 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: C<$next_module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item since: 1.99_12 @@ -398,7 +398,7 @@ =over 4 =item obj: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item ret: no return value @@ -416,12 +416,12 @@ Returns the first module in the module list. Usefull to start a module iteration. - $module = Apache::Module::top_module(); + $module = Apache2::Module::top_module(); =over 4 =item ret: C<$module> -( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> ) +( C<L<Apache2::Module object|docs::2.0::api::Apache2::Module>> ) =item since: 1.99_12 --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]