=head1 NAME

Apache::CmdParms - Perl API for XXX




=head1 Synopsis

  use Apache::CmdParms ();

META: to be completed




=head1 Description

META: to be completed




=head1 API

C<Apache::CmdParms> provides the following functions and/or methods:




=head2 C<info>

META: Autogenerated - needs to be reviewed/completed

Argument to command from cmd_table

  $obj->info($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (XXX)

=item ret: no return value

=back





=head2 C<override>

META: Autogenerated - needs to be reviewed/completed

Which allow-override bits are set

  $obj->override($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (integer)

=item ret: no return value

=back





=head2 C<limited>

META: Autogenerated - needs to be reviewed/completed

Which methods are E<lt>LimitE<gt>ed

  $obj->limited($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (number)

=item ret: no return value


=back





=head2 C<limited_xmethods>

META: Autogenerated - needs to be reviewed/completed

methods which are limited

  $obj->limited_xmethods($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)

=item ret: no return value


=back





=head2 C<xlimited>

META: Autogenerated - needs to be reviewed/completed

methods which are xlimited

  $obj->xlimited($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::MethodList|docs::2.0::api::Apache::MethodList>>)

=item ret: no return value

=back





=head2 C<config_file>

META: Autogenerated - needs to be reviewed/completed

Config file structure.

  $obj->config_file($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::ConfigFile|docs::2.0::api::Apache::ConfigFile>>)

=item ret: no return value


=back





=head2 C<directive>

META: Autogenerated - needs to be reviewed/completed

the directive specifying this command

  $obj->directive($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)

=item ret: no return value

=back





=head2 C<pool>

META: Autogenerated - needs to be reviewed/completed

Pool to allocate new storage in

  $obj->pool($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)

=item ret: no return value

=back





=head2 C<temp_pool>

META: Autogenerated - needs to be reviewed/completed

Pool for scratch memory; persists during configuration, but
wiped before the first request is served...

  $obj->temp_pool($p);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)

=item ret: no return value


=back





=head2 C<server>

META: Autogenerated - needs to be reviewed/completed

server_rec being configured for

  $obj->server($s);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)

=item ret: no return value

=back





=head2 C<path>

META: Autogenerated - needs to be reviewed/completed

If configuring for a directory, pathname of that directory.  NOPE!
That's what it meant previous to the existance of E<lt>FilesE<gt>,
E<lt>LocationE<gt> and regex matching.  Now the only usefulness that
can be derived from this field is whether a command is being called in
a server context (path == NULL) or being called in a dir context (path
!= NULL).

  $obj->path($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (string)

=item ret: no return value

=back





=head2 C<cmd>

META: Autogenerated - needs to be reviewed/completed

configuration command

  $obj->cmd($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)

=item ret: no return value

=back





=head2 C<context>

META: Autogenerated - needs to be reviewed/completed

per_dir_config vector passed to handle_command

  $obj->context($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)

=item ret: no return value

=back





=head2 C<err_directive>

META: Autogenerated - needs to be reviewed/completed

directive with syntax error

  $obj->err_directive($newval);

=over 4

=item arg1: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)

=item arg2: C<$newval> (C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)

=item ret: no return value

=back




=head1 See Also

L<mod_perl 2.0 documentation|docs::2.0::index>.




=head1 Copyright

mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 1.1.




=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut

