← Back to branch summary

~ubuntu-branches/ubuntu/edgy/libapache2-mod-perl2/edgy

« back to all changes in this revision

Viewing changes to docs/api/Apache.pod

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2004-08-19 06:23:48 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040819062348-jxl4koqbtvgm8v2t
Tags: 1.99.14-4
Remove the LFS CFLAGS, and build-dep against apache2-*-dev (>= 2.0.50-10)
as we're backing out of the apache2/apr ABI transition.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/Apache.pod
 
1
=head1 NAME
 
2
 
 
3
Apache -- A ghost mod_perl 2.0 class
 
4
 
 
5
=head1 Synopsis
 
6
 
 
7
=head1 Description
 
8
 
 
9
There is no Apache class per se.
 
10
 
 
11
There are several modules that put their functions into the
 
12
C<Apache::> namespace. For example
 
13
C<L<ModPerl::Util|docs::2.0::api::ModPerl::Util>> defines a function
 
14
C<L<Apache::current_callback()|docs::2.0::api::ModPerl::Util/C_current_callback_>>:
 
15
 
 
16
  use ModPerl::Util;
 
17
  my $callback = Apache::current_callback();
 
18
 
 
19
There are several modules that require the I<Apache> class as the
 
20
first argument to the class methods that they define. For example
 
21
C<L<Apache::Server|docs::2.0::api::Apache::Server>> defines a class
 
22
method
 
23
C<L<Apache-E<gt>server|docs::2.0::api::Apache::Server/C_server_>>:
 
24
 
 
25
  use Apache::Server;
 
26
  my $server = Apache->server;
 
27
 
 
28
There are several modules that install constants into the C<Apache::>
 
29
namespace. For example
 
30
C<L<Apache::ServerUtil|docs::2.0::api::Apache::ServerUtil>> defines a
 
31
constant
 
32
C<L<Apache::server_root|docs::2.0::api::Apache::ServerUtil/C_Apache__server_root_>>:
 
33
 
 
34
  use Apache::ServerUtil;
 
35
  my $server_root = Apache::server_root;
 
36
 
 
37
To use this functions and methods you need to load the module that
 
38
defines them. If you aren't sure which module contains the symbol you
 
39
are after, use the helper module
 
40
C<L<ModPerl::MethodLookup|docs::2.0::api::ModPerl::MethodLookup>>.
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
=head1 See Also
 
47
 
 
48
L<mod_perl 2.0 documentation|docs::2.0::index>.
 
49
 
 
50
 
 
51
 
 
52
 
 
53
=head1 Copyright
 
54
 
 
55
mod_perl 2.0 and its core modules are copyrighted under
 
56
The Apache Software License, Version 1.1.
 
57
 
 
58
 
 
59
 
 
60
 
 
61
=head1 Authors
 
62
 
 
63
L<The mod_perl development team and numerous
 
64
contributors|about::contributors::people>.
 
65
 
 
66
=cut
 
67