blob: 8969f52deca05747897a38b2be46fda42444608b [file] [log] [blame]
<!-- HTML header for doxygen 1.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libapreq2-2.17: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" width="100%">
<tbody>
<tr style="height: 56px;">
<!--
<td id="projectlogo"><img alt="Logo" src="feather.png"/></td>
-->
<!--
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libapreq2
< !--BEGIN PROJECT_NUMBER-- >&#160;<span id="projectnumber">2.17</span>< !--END PROJECT_NUMBER-- >
</div>
< !--BEGIN PROJECT_BRIEF-- ><div id="projectbrief"></div>< !--END PROJECT_BRIEF-- >
</td>
-->
<td>
<div id="page-header">
<p class="menu">
<a href="https://www.apache.org/">Apache Software Foundation</a> &gt;
<a href="https://httpd.apache.org">HTTP Server Project</a> &gt;
<a href="https://httpd.apache.org/apreq/">Request Library Subproject</a>
</p>
<p class="apache">Apache HTTP Server Request Library - 2.17</p>
<img alt="" src="feather.png" />
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">libapreq2 Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Project Website: <a href="http://httpd.apache.org/apreq/">http://httpd.apache.org/apreq/</a></p>
<pre class="fragment">
Apache HTTP Server Request Library
What is it?
-----------
httpd-apreq is subproject of the Apache HTTP Server Project
whose committers develop and maintain the libapreq C library
and its language bindings for Perl (contributions for additional
language bindings are most welcome).
libapreq is a safe, standards-compliant, high-performance library
used for parsing HTTP cookies, query-strings and POST data. The
original version (libapreq-1.X) was designed by Lincoln Stein and Doug
MacEachern. The perl APIs Apache::Request and Apache::Cookie are the
lightweight mod_perl analogs of the CGI and CGI::Cookie perl modules.
Version 2 of libapreq is an improved codebase designed around APR
and Apache-2's input filter API. The C codebase is separated into
two independent components:
1) libapreq2, a shared library which is based on
libapr and libaprutil.
2) A collection of modules:
- mod_apreq2, a filter module for the Apache 2.X webserver,
- a CGI module included in libapreq2 itself,
- a custom module for general applications.
Version 2 also includes the perl APIs for libapreq2- Apache2::Request,
Apache2::Upload and Apache2::Cookie. The corresponding XS modules
are generated by ExtUtils::XSBuilder, which is based on the new build
system created specifically for mod_perl2.
The Latest Version
------------------
Details of the latest version can be found on the libapreq
project page at
https://httpd.apache.org/apreq
Documentation
-------------
The documentation is in the docs/ directory. It is
based on Doxygen, and can be regenerated by typing
% make docs
in the main directory.
Installation
------------
For full details please consult the INSTALL file. Briefly,
to install just the C API (libapreq2 + environment modules)
on a Unix-like system:
% ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs
% make
% make test
% make install
To build and install the perl API as well, either add
the "--enable-perl-glue" configure option, or let Makefile.PL
enable it for you:
% perl Makefile.PL --with-apache2-apxs=/path/to/apache2/bin/apxs
% make
% make test
% make install
Licensing
---------
Please see the file called LICENSE.
Contacts
--------
o Project homepage:
https://httpd.apache.org/apreq/
o Mailing Lists:
user lists:
C/C++ API - modules-dev@httpd.apache.org
Perl API - modperl@perl.apache.org
Tcl API - XXX
Java API - XXX
Python API - XXX
developer list (bugs, patches, code contributions, etc.):
apreq-dev@httpd.apache.org
Acknowledgments
----------------
We wish to acknowledge the following copyrighted works that
make up portions of the Apache software:
libapreq2 relies heavily on the use of the GNU auto-tools
to provide a build environment. The tests are based on
the Apache::Test, Test::Harness and Test::Inline.
Doxygen generates the documentation for libapreq2. The perl glue
and pods are generated by ExtUtils::XSBuilder.
</pre> </div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<hr class="footer"/>
<table class="footer">
<td>
<address class="footer_left"><small>
Copyright &copy; 2003-2022 <a href="https://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.
</small></address>
</td>
<td>
<address class="footer"><small>
Generated on Sat Sep 3 2022 17:23:06 for libapreq2 by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</td>
</table>
</body>
</html>