=head1 NAME

Apache::Util - Perl API for XXX




=head1 Synopsis

  use Apache::Util ();

META: to be completed




=head1 Description

META: to be completed




=head1 Functions API

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




=head2 C<ht_time>

Convert time from an integer value into a string in a specified format

  $time_str = Apache::Util::ht_time($p, $time, $fmt, $gmt);

=over 4

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

The pool to allocate memory from

=item arg2 opt: C<$time> (number)

The time to convert (e.g., C<time()> or
C<L<$r-E<gt>request_time|docs::2.0::api::Apache::RequestRec/C_request_time_>>).

If the value is not passed the current time will be used.

=item arg3 opt: C<$fmt> (string)

The format to use for the conversion, using strftime(3) tokens.

If the value is not passed the default format used is:

  "%a, %d %b %Y %H:%M:%S %Z"

=item arg4 opt: C<$gmt> (integer)

The time will be not converted to GMT if 0 is passed.

If the value is not passed 1 (do convert) is used as a default.

=item ret: C<$time_str> (string)

The string that represents the specified time

=back

Examples:

Use current time, the default format and convert to GMT:

  $fmtdate = Apache::Util::ht_time($r->pool);

Use my time, the default format and convert to GMT:

  my $time = time+100;
  $fmtdate = Apache::Util::ht_time($r->pool, $time);

Use the time the request has started, custom format and don't convert
to GMT:

  my $fmt = "%a, %D %H:%M:%S %Z";
  $fmtdate = Apache::Util::ht_time($r->pool, $r->request_time, $fmt, 0);




=head2 C<escape_path>

META: Autogenerated - needs to be reviewed/completed

convert an OS path to a URL in an OS dependant way.

  $path = Apache::escape_path($path, $p, $partial);

=over 4

=item arg1: C<$path> (string)

The path to convert

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

The pool to allocate from

=item arg3: C<$partial> (integer)

if set, assume that the path will be appended to something with a '/'
in it (and thus does not prefix "./")

=item ret: C<$path> (string)

The converted URL

=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

