← 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/CmdParms.pod

  • Committer: Bazaar Package Importer
  • Author(s): Andres Salomon
  • Date: 2005-08-12 01:40:38 UTC
  • mfrom: (1.1.2 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050812014038-gjigefs55pqx4qc8
Tags: 2.0.1-3
Grr.  Really include perl.conf file; it got lost due to diff not
wanting to add an empty file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/Apache/CmdParms.pod
1
 
=head1 NAME
2
 
 
3
 
Apache::CmdParms - Perl API for XXX
4
 
 
5
 
 
6
 
 
7
 
 
8
 
=head1 Synopsis
9
 
 
10
 
  use Apache::CmdParms ();
11
 
 
12
 
META: to be completed
13
 
 
14
 
 
15
 
 
16
 
 
17
 
=head1 Description
18
 
 
19
 
META: to be completed
20
 
 
21
 
 
22
 
 
23
 
 
24
 
=head1 API
25
 
 
26
 
C<Apache::CmdParms> provides the following functions and/or methods:
27
 
 
28
 
 
29
 
 
30
 
 
31
 
=head2 C<info>
32
 
 
33
 
META: Autogenerated - needs to be reviewed/completed
34
 
 
35
 
Argument to command from cmd_table
36
 
 
37
 
  $obj->info($newval);
38
 
 
39
 
=over 4
40
 
 
41
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
42
 
 
43
 
=item arg1: C<$newval> (XXX)
44
 
 
45
 
=item ret: no return value
46
 
 
47
 
=back
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
=head2 C<override>
54
 
 
55
 
META: Autogenerated - needs to be reviewed/completed
56
 
 
57
 
Which allow-override bits are set
58
 
 
59
 
  $obj->override($newval);
60
 
 
61
 
=over 4
62
 
 
63
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
64
 
 
65
 
=item arg1: C<$newval> (integer)
66
 
 
67
 
=item ret: no return value
68
 
 
69
 
=back
70
 
 
71
 
 
72
 
 
73
 
 
74
 
 
75
 
=head2 C<limited>
76
 
 
77
 
META: Autogenerated - needs to be reviewed/completed
78
 
 
79
 
Which methods are E<lt>LimitE<gt>ed
80
 
 
81
 
  $obj->limited($newval);
82
 
 
83
 
=over 4
84
 
 
85
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
86
 
 
87
 
=item arg1: C<$newval> (number)
88
 
 
89
 
=item ret: no return value
90
 
 
91
 
 
92
 
=back
93
 
 
94
 
 
95
 
 
96
 
 
97
 
 
98
 
=head2 C<limited_xmethods>
99
 
 
100
 
META: Autogenerated - needs to be reviewed/completed
101
 
 
102
 
methods which are limited
103
 
 
104
 
  $obj->limited_xmethods($newval);
105
 
 
106
 
=over 4
107
 
 
108
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
109
 
 
110
 
=item arg1: C<$newval> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
111
 
 
112
 
=item ret: no return value
113
 
 
114
 
 
115
 
=back
116
 
 
117
 
 
118
 
 
119
 
 
120
 
 
121
 
=head2 C<xlimited>
122
 
 
123
 
META: Autogenerated - needs to be reviewed/completed
124
 
 
125
 
methods which are xlimited
126
 
 
127
 
  $obj->xlimited($newval);
128
 
 
129
 
=over 4
130
 
 
131
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
132
 
 
133
 
=item arg1: C<$newval> (C<L<Apache::MethodList|docs::2.0::api::Apache::MethodList>>)
134
 
 
135
 
=item ret: no return value
136
 
 
137
 
=back
138
 
 
139
 
 
140
 
 
141
 
 
142
 
 
143
 
=head2 C<config_file>
144
 
 
145
 
META: Autogenerated - needs to be reviewed/completed
146
 
 
147
 
Config file structure.
148
 
 
149
 
  $obj->config_file($newval);
150
 
 
151
 
=over 4
152
 
 
153
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
154
 
 
155
 
=item arg1: C<$newval> (C<L<Apache::ConfigFile|docs::2.0::api::Apache::ConfigFile>>)
156
 
 
157
 
=item ret: no return value
158
 
 
159
 
 
160
 
=back
161
 
 
162
 
 
163
 
 
164
 
 
165
 
 
166
 
=head2 C<directive>
167
 
 
168
 
META: Autogenerated - needs to be reviewed/completed
169
 
 
170
 
the directive specifying this command
171
 
 
172
 
  $obj->directive($newval);
173
 
 
174
 
=over 4
175
 
 
176
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
177
 
 
178
 
=item arg1: C<$newval> (C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
179
 
 
180
 
=item ret: no return value
181
 
 
182
 
=back
183
 
 
184
 
 
185
 
 
186
 
 
187
 
 
188
 
=head2 C<pool>
189
 
 
190
 
META: Autogenerated - needs to be reviewed/completed
191
 
 
192
 
Pool to allocate new storage in
193
 
 
194
 
  $obj->pool($newval);
195
 
 
196
 
=over 4
197
 
 
198
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
199
 
 
200
 
=item arg1: C<$newval> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
201
 
 
202
 
=item ret: no return value
203
 
 
204
 
=back
205
 
 
206
 
 
207
 
 
208
 
 
209
 
 
210
 
=head2 C<temp_pool>
211
 
 
212
 
META: Autogenerated - needs to be reviewed/completed
213
 
 
214
 
Pool for scratch memory; persists during configuration, but
215
 
wiped before the first request is served...
216
 
 
217
 
  $obj->temp_pool($p);
218
 
 
219
 
=over 4
220
 
 
221
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
222
 
 
223
 
=item arg1: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
224
 
 
225
 
=item ret: no return value
226
 
 
227
 
 
228
 
=back
229
 
 
230
 
 
231
 
 
232
 
 
233
 
 
234
 
=head2 C<server>
235
 
 
236
 
META: Autogenerated - needs to be reviewed/completed
237
 
 
238
 
server_rec being configured for
239
 
 
240
 
  $obj->server($s);
241
 
 
242
 
=over 4
243
 
 
244
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
245
 
 
246
 
=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
247
 
 
248
 
=item ret: no return value
249
 
 
250
 
=back
251
 
 
252
 
 
253
 
 
254
 
 
255
 
 
256
 
=head2 C<path>
257
 
 
258
 
META: Autogenerated - needs to be reviewed/completed
259
 
 
260
 
If configuring for a directory, pathname of that directory.  NOPE!
261
 
That's what it meant previous to the existance of E<lt>FilesE<gt>,
262
 
E<lt>LocationE<gt> and regex matching.  Now the only usefulness that
263
 
can be derived from this field is whether a command is being called in
264
 
a server context (path == NULL) or being called in a dir context (path
265
 
!= NULL).
266
 
 
267
 
  $obj->path($newval);
268
 
 
269
 
=over 4
270
 
 
271
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
272
 
 
273
 
=item arg1: C<$newval> (string)
274
 
 
275
 
=item ret: no return value
276
 
 
277
 
=back
278
 
 
279
 
 
280
 
 
281
 
 
282
 
 
283
 
=head2 C<cmd>
284
 
 
285
 
META: Autogenerated - needs to be reviewed/completed
286
 
 
287
 
configuration command
288
 
 
289
 
  $obj->cmd($newval);
290
 
 
291
 
=over 4
292
 
 
293
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
294
 
 
295
 
=item arg1: C<$newval> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
296
 
 
297
 
=item ret: no return value
298
 
 
299
 
=back
300
 
 
301
 
 
302
 
 
303
 
 
304
 
 
305
 
=head2 C<context>
306
 
 
307
 
META: Autogenerated - needs to be reviewed/completed
308
 
 
309
 
per_dir_config vector passed to handle_command
310
 
 
311
 
  $obj->context($newval);
312
 
 
313
 
=over 4
314
 
 
315
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
316
 
 
317
 
=item arg1: C<$newval> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
318
 
 
319
 
=item ret: no return value
320
 
 
321
 
=back
322
 
 
323
 
 
324
 
 
325
 
 
326
 
 
327
 
=head2 C<err_directive>
328
 
 
329
 
META: Autogenerated - needs to be reviewed/completed
330
 
 
331
 
directive with syntax error
332
 
 
333
 
  $obj->err_directive($newval);
334
 
 
335
 
=over 4
336
 
 
337
 
=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
338
 
 
339
 
=item arg1: C<$newval> (C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
340
 
 
341
 
=item ret: no return value
342
 
 
343
 
=back
344
 
 
345
 
 
346
 
 
347
 
 
348
 
=head1 See Also
349
 
 
350
 
L<mod_perl 2.0 documentation|docs::2.0::index>.
351
 
 
352
 
 
353
 
 
354
 
 
355
 
=head1 Copyright
356
 
 
357
 
mod_perl 2.0 and its core modules are copyrighted under
358
 
The Apache Software License, Version 1.1.
359
 
 
360
 
 
361
 
 
362
 
 
363
 
=head1 Authors
364
 
 
365
 
L<The mod_perl development team and numerous
366
 
contributors|about::contributors::people>.
367
 
 
368
 
=cut
369