| 1 |
<html> |
| 2 |
<head> |
| 3 |
<link rel="stylesheet" type="text/css" href="dox.css" /> |
| 4 |
<title>libapreq2-2.17: Main Page</title> |
| 5 |
</head> |
| 6 |
<body> |
| 7 |
<div id="page-header"> |
| 8 |
<p class="menu"> |
| 9 |
<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> > |
| 10 |
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p> |
| 11 |
<p class="apache">Apache HTTP Server Request Library</p> |
| 12 |
<img alt="" src="feather.gif" /></div> |
| 13 |
<!-- Generated by Doxygen 1.9.1 --> |
| 14 |
<script type="text/javascript" src="menudata.js"></script> |
| 15 |
<script type="text/javascript" src="menu.js"></script> |
| 16 |
<script type="text/javascript"> |
| 17 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 18 |
$(function() { |
| 19 |
initMenu('',false,false,'search.php','Search'); |
| 20 |
}); |
| 21 |
/* @license-end */</script> |
| 22 |
<div id="main-nav"></div> |
| 23 |
</div><!-- top --> |
| 24 |
<div class="PageDoc"><div class="header"> |
| 25 |
<div class="headertitle"> |
| 26 |
<div class="title">libapreq2 Documentation</div> </div> |
| 27 |
</div><!--header--> |
| 28 |
<div class="contents"> |
| 29 |
<div class="textblock"><p>Project Website: <a href="http://httpd.apache.org/apreq/">http://httpd.apache.org/apreq/</a></p> |
| 30 |
<pre class="fragment"> |
| 31 |
Apache HTTP Server Request Library |
| 32 |
|
| 33 |
What is it? |
| 34 |
----------- |
| 35 |
httpd-apreq is subproject of the Apache HTTP Server Project |
| 36 |
whose committers develop and maintain the libapreq C library |
| 37 |
and its language bindings for Perl (contributions for additional |
| 38 |
language bindings are most welcome). |
| 39 |
|
| 40 |
libapreq is a safe, standards-compliant, high-performance library |
| 41 |
used for parsing HTTP cookies, query-strings and POST data. The |
| 42 |
original version (libapreq-1.X) was designed by Lincoln Stein and Doug |
| 43 |
MacEachern. The perl APIs Apache::Request and Apache::Cookie are the |
| 44 |
lightweight mod_perl analogs of the CGI and CGI::Cookie perl modules. |
| 45 |
|
| 46 |
Version 2 of libapreq is an improved codebase designed around APR |
| 47 |
and Apache-2's input filter API. The C codebase is separated into |
| 48 |
two independent components: |
| 49 |
|
| 50 |
1) libapreq2, a shared library which is based on |
| 51 |
libapr and libaprutil. |
| 52 |
|
| 53 |
2) A collection of modules: |
| 54 |
|
| 55 |
- mod_apreq2, a filter module for the Apache 2.X webserver, |
| 56 |
- a CGI module included in libapreq2 itself, |
| 57 |
- a custom module for general applications. |
| 58 |
|
| 59 |
Version 2 also includes the perl APIs for libapreq2- Apache2::Request, |
| 60 |
Apache2::Upload and Apache2::Cookie. The corresponding XS modules |
| 61 |
are generated by ExtUtils::XSBuilder, which is based on the new build |
| 62 |
system created specifically for mod_perl2. |
| 63 |
|
| 64 |
|
| 65 |
The Latest Version |
| 66 |
------------------ |
| 67 |
|
| 68 |
Details of the latest version can be found on the libapreq |
| 69 |
project page at |
| 70 |
|
| 71 |
https://httpd.apache.org/apreq |
| 72 |
|
| 73 |
|
| 74 |
Documentation |
| 75 |
------------- |
| 76 |
|
| 77 |
The documentation is in the docs/ directory. It is |
| 78 |
based on Doxygen, and can be regenerated by typing |
| 79 |
|
| 80 |
% make docs |
| 81 |
|
| 82 |
in the main directory. |
| 83 |
|
| 84 |
|
| 85 |
Installation |
| 86 |
------------ |
| 87 |
|
| 88 |
For full details please consult the INSTALL file. Briefly, |
| 89 |
to install just the C API (libapreq2 + environment modules) |
| 90 |
on a Unix-like system: |
| 91 |
|
| 92 |
% ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs |
| 93 |
% make |
| 94 |
% make test |
| 95 |
% make install |
| 96 |
|
| 97 |
To build and install the perl API as well, either add |
| 98 |
the "--enable-perl-glue" configure option, or let Makefile.PL |
| 99 |
enable it for you: |
| 100 |
|
| 101 |
% perl Makefile.PL --with-apache2-apxs=/path/to/apache2/bin/apxs |
| 102 |
% make |
| 103 |
% make test |
| 104 |
% make install |
| 105 |
|
| 106 |
Licensing |
| 107 |
--------- |
| 108 |
|
| 109 |
Please see the file called LICENSE. |
| 110 |
|
| 111 |
|
| 112 |
Contacts |
| 113 |
-------- |
| 114 |
|
| 115 |
o Project homepage: |
| 116 |
|
| 117 |
https://httpd.apache.org/apreq/ |
| 118 |
|
| 119 |
o Mailing Lists: |
| 120 |
|
| 121 |
user lists: |
| 122 |
C/C++ API - [email protected] |
| 123 |
Perl API - [email protected] |
| 124 |
Tcl API - XXX |
| 125 |
Java API - XXX |
| 126 |
Python API - XXX |
| 127 |
|
| 128 |
developer list (bugs, patches, code contributions, etc.): |
| 129 |
[email protected] |
| 130 |
|
| 131 |
|
| 132 |
Acknowledgments |
| 133 |
---------------- |
| 134 |
|
| 135 |
We wish to acknowledge the following copyrighted works that |
| 136 |
make up portions of the Apache software: |
| 137 |
|
| 138 |
libapreq2 relies heavily on the use of the GNU auto-tools |
| 139 |
to provide a build environment. The tests are based on |
| 140 |
the Apache::Test, Test::Harness and Test::Inline. |
| 141 |
|
| 142 |
Doxygen generates the documentation for libapreq2. The perl glue |
| 143 |
and pods are generated by ExtUtils::XSBuilder. |
| 144 |
</pre> </div></div><!-- PageDoc --> |
| 145 |
</div><!-- contents --> |
| 146 |
<div id="footer"> |
| 147 |
<p class="apache"> |
| 148 |
Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/> |
| 149 |
See <a href="apreq_license.html">LICENSE</a>.</p> |
| 150 |
<p class="menu"> |
| 151 |
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a> |
| 152 |
version 1.9.1 on Thu Aug 18 2022</span> |
| 153 |
</p> |
| 154 |
</div> |
| 155 |
</body> |
| 156 |
</html> |