perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/docs/2.0/api/ModPerl Util.pod
Date Tue, 13 Jan 2004 20:39:05 GMT
stas        2004/01/13 12:39:05

  Modified:    src/docs/2.0/api/ModPerl Util.pod
  Log:
  ModPerl::Util manpage update
  
  Revision  Changes    Path
  1.4       +86 -8     modperl-docs/src/docs/2.0/api/ModPerl/Util.pod
  
  Index: Util.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/ModPerl/Util.pod,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -u -r1.3 -r1.4
  --- Util.pod	15 Dec 2003 20:26:29 -0000	1.3
  +++ Util.pod	13 Jan 2004 20:39:05 -0000	1.4
  @@ -1,8 +1,11 @@
   =head1 NAME
   
  -ModPerl::Util -- Helper mod_perl 2.0 Functions
  +ModPerl::Util - Helper mod_perl 2.0 Functions
   
  -=head1 SYNOPSIS
  +
  +
  +
  +=head1 Synopsis
   
     use ModPerl::Util;
     
  @@ -12,23 +15,98 @@
     
     ModPerl::Util::untaint($) # secret API?
   
  -=head1 DESCRIPTION
  +
  +
  +
  +=head1 Description
   
   C<ModPerl::Util> provides mod_perl 2.0 util functions.
   
  +
  +
  +
  +
   =head1 API
   
  -=over
  +C<ModPerl::Util> provides the following functions and/or methods:
  +
  +
  +
  +
  +=head2 C<untaint>
   
  -=item * current_callback
  +Untaint the variable, by turning its tainted bit off (used internally).
   
  -Returns the currently running callback, like 'PerlResponseHandler'
  +  untaint($var);
   
  -=item * exit
  +=over 4
  +
  +=item arg1: C<$var> (scalar)
  +
  +=item ret: no return value
  +
  +=back
  +
  +Do not use this function unless you know what you are doing. To learn
  +how to properly untaint variables refer to the I<perlsec> manpage.
  +
  +
  +=head2 C<current_callback>
  +
  +Returns the currently running callback, like 'PerlResponseHandler'.
  +
  +  $callback = Apache::current_callback();
  +
  +=over 4
  +
  +=item ret: C<$callback> (string)
  +
  +=back
   
  -Used internally to replace CORE::exit and terminate the request,
  +
  +
  +
  +
  +=head2 C<exit>
  +
  +Used internally to replace C<CORE::exit> and terminate the request,
   not the current process.
   
  +  ModPerl::Util::exit($status);
  +
  +=over 4
  +
  +=item opt arg1: C<$status> (integer)
  +
  +The exit status, similar to C<CORE::exit>. If not passed, the default
  +value of 0 is used.
  +
  +=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
  +
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message