![]() |
Apache Modelling Portal 2001-12-07 |
List of Apache functions and macros
cgi-bin/ contains 2 example cgi scripts included in the apache distribution
conf/ contains default or example configuration files
htdocs/ contains a sample web page
logs/ empty
src/ Contains build control files and subdirectories with all source files of the apache web server and most modules.
ap/ Abstract operating system calls
helpers/ scripts needed to build apache
include/ header files with definitions and prototypes, needed to build apache
lib/ additional libraries
expat-lite/ XML parser
sdbm/ simple file based database
main/ apache core
modules/ all modules included in this distribution
example/ template for a module
experimental/ modules in state "experimental" - use carefully
extra/ directory for future use
proxy/ proxy module
standard/ all standard modules
os/ subdirectories with platform dependent files
regex/ library sources for regular expression parser
support/ additional tools for apache and their documentation
SHA1/ tools for handling SHA1 coded password bases
contains 2 example cgi scripts included in the apache distribution
contains default or example configuration files
contains a sample web page. Just follow the link tohtdocs/.
empty directory
Contains build control files and subdirectories with all source files of the apache web server and most modules.
Apache.dsp/.dsw/.mak, ApacheCore.def/.dsp/.mak, ApacheCoreOS2.mak, InstallBin.dsp, makefile.win Microsoft Developer Studio Files
ApacheNW.mcp.gz CodeWarrior Project File
BUILD.NOTES, CHANGES, INSTALL, PORTING, README, README.EBCDIC
Abstract operating system calls
ap_base64.c See apidoc_ap_base64decode.html , apidoc_ap_base64decode_binary.html , apidoc_ap_base64decode_len.html, apidoc_ap_base64encode.html, apidoc_ap_base64encode_binary.html , apidoc_ap_base64encode_len.html
scripts needed to build apache
header files with definitions and prototypes, needed to build apache
additional libraries
XML parser
simple file based database
apache core
alloc.c allocation of all resources which might have to be reclaimed eventually, including memory, files, and child processes.
buff.c Buffered I/O routines. These are a replacement for the stdio routines.
gen_test_char.c A bunch of functions in util.c scan strings looking for certain characters. To make that more efficient this encodes a lookup table.
gen_uri_delims.c generate a table of 256 values, where certain characters are marked "interesting"... for the uri parsing process.
http_config.c Functions to read config files and dispatch to the command handlers; also, routines to manage configuration vectors, and to dispatch to modules' handlers for the various phases of handling a request.
http_core.c Contains the core module structure, its command table, and the command handlers, also the filename translation routine, and the like for the core. (Basically, this is all of the core module stuff which looks more or less like the boilerplate from the other modules).
http_log.c just the error log. Error handling is split between http_protocol.c (for generating the default error responses) and http_request.c (for executive handling, including ErrorDocument invocation); transaction logging is in the modules.
http_main.c System startup, restart, and accepting connections; also timeout handling (which is pretty grotesque right now; ideas?)
http_protocol.c functions for dealing directly with the client. Reading requests, writing replies of various sorts. I've tried to route all data transfer between server and client through here, so there's a single piece of code to change if we want to add, say, HTTP-NG packetization. The major glaring exception is NPH- CGI scripts; what *will* we do with those for HTTP-NG?
http_request.c functions which direct the processing of requests, including error handling. Generally responsible for making sure that the right module handlers get invoked, in the right order. (This includes the "sub-request" mechanism, which is used by includes and other stuff to ask about the status of particular subfiles).
http_vhost.c functions pertaining to virtual host addresses (configuration and run-time). See also vhost/index.html.en
rfc1413.c The code queries an RFC 1413 etc. compatible daemon on a remote host to look up the owner of a connection. See also rfc1413-Identification_protocol.html
util.c String Utilities
util_date.c date parsing utility routines
util_md5.c Utility procedures for md5 context and digest handling
util_script.c Various utility functions which are common to a whole lot of script-type extensions mechanisms, and might as well be gathered in one place
util_uri.c URI related utility things
all modules included in this distribution. Module documentation: See Apache module documentation
example_mod_example.c Demonstrates Apache API. See mod_example.html
mod_auth_digest.c Experimental MD5 authentication. See mod_auth_digest.html
mod_mmap_static.c Experimental file caching, mapping files into memory to improve performance. See mod_mmap_static.html
mod_proxy.c Caching proxy abilities. See mod_proxy.html
mod_access.c Access control based on client hostname or IP address. Access checking by DNS name or IP address; defines the "order", "allow" and "deny" config-file commands. (If this module is compiled out, the server fails safe --- any attempt to configure access control will die on a config file syntax error when the relevant commands go unrecognized). See mod_access.html
mod_actions.c Executing CGI scripts based on media type or request method. See mod_actions.html
mod_alias.c Mapping different parts of the host filesystem in the document tree, and URL redirection. See mod_alias.html
mod_asis.c Sending files which contain their own HTTP headers. See mod_asis.html
mod_auth_anon.c Anonymous user access to authenticated areas. See mod_auth_anon.html
mod_auth.c User authentication using text files (HTTP authentication). Defines the AuthUserFile and AuthGroupFile directives (other auth-related commands are handled by the core itself, so it knows which requests require it to poll the modules for authentication handlers). See mod_auth.html
mod_auth_db.c User authentication using Berkeley DB files. See mod_auth_db.html
mod_auth_dbm.c User authentication using DBM files. Untested, and left out of the modules list in modules.c because of that, but it does at least compile. Grump. See mod_auth_dbm.html
mod_autoindex.c Automatic directory listings. See mod_autoindex.html
mod_cern_meta.c Support for HTTP header metafiles. See mod_cern_meta.html
mod_cgi.c Common Gateway Interface. Also defines ScriptAlias, because scripts are treated slightly differently depending on whether they are ScriptAliased or not (in particular, ExecCGI is not required in the former case). See mod_cgi.html
mod_digest.c MD5 authentication. See mod_digest.html
mod_dir.c Basic directory handling. Defines a whole *raft* of commands; handles directories. See mod_dir.html
mod_env.c Passing of environments to CGI scripts. See mod_env.html
mod_expires.c Apply Expires: headers to resources. See mod_expires.html
mod_headers.c Add arbitrary HTTP headers to resources. See mod_headers.html
mod_imap.c The imagemap file handler. See mod_imap.html
mod_include.c server-side includes. See mod_include.html
mod_info.c Server configuration information. See mod_info.html
mod_log_agent.c Logging of User Agents. See mod_log_agent.html
mod_log_config.c User-configurable logging replacement for mod_log_common. See mod_log_config.html
mod_log_referer.c Logging of document references. See mod_log_referer.html
mod_mime.c deduction of MIME types and content-encodings from filename extensions. This module defines the AddType, AddEncoding, and TypesConfig config-file directives. This code is off in a module by itself so that people who want to experiment with other meta-information schemes can replace it, and still have content negotiation work. See mod_mime.html
mod_mime_magic.c Determining document types using "magic numbers". See mod_mime_magic.html
mod_negotiation.c Content negotiation. Defines the CacheNegotiatedDocs config-file command. Making this a module is perhaps going overboard, but I wanted to see how far I could push it. See mod_negotiation.html
mod_rewrite.c Powerful URI-to-filename mapping using regular expressions. See mod_rewrite.html
mod_setenvif.c Set environment variables based on client information. See mod_setenvif.html
mod_so.c Support for loading modules (.so's on Unix, .dll's on Win32) at runtime. See mod_so.html
mod_speling.c Automatically correct minor typos in URLs. See mod_speling.html
mod_status.c Server status display. See mod_status.html
mod_unique_id.c Generate unique request identifier for every request. See mod_unique_id.html
mod_userdir.c User home directories. See mod_userdir.html
mod_usertrack.c User tracking using Cookies (replacement for mod_cookies.c). See mod_usertrack.html
mod_vhost_alias.c Support for dynamically configured mass virtual hosting. See mod_vhost_alias.html
subdirectories with platform dependent files
files needed to map abstract os calls to real os calls for unix
files needed to map abstract os calls to real os calls for windows plus project files plus windows installer sources
library sources for regular expression parser
additional tools for apache and their documentation
ab.c ABuse your server with this benchmarker. Rudimentary command line testing tool.
ab.8 (Manual Page)
apachectl Apache run-time Control script. To facilitate the administrator and/or your rc.d scripts to control the functioning of the Apache httpd daemon.
apachectl.8 (Manual Page)
apxs.pl APache eXtenSion tool. Eases building and installing DSO style modules.
apxs.8 (Manual Page)
dbmmanage Create and update user authentication files in the faster DBM format used by mod_auth_db.
dbmmanage.1 (Manual Page)
htdigest.c Create and update user authentication files used in DIGEST authentification. See mod_auth_digest.
htdigest.1 (Manual Page)
htpasswd.c Create and update user authentication files used in BASIC authentification. I.e. the htpasswd files. See mod_auth.
htpasswd.1 (Manual Page)
httpd.8 (Manual Page) General apache man page.
log_server_status This script is designed to be run at a frequent interval by something like cron. It connects to the server and downloads the status information. It reformats the information to a single line and logs it to a file. See log_server_status Manual
logresolve.c resolve hostnames for IP-adresses in Apache logfiles
logresolve.8 (Manual Page)
phf_abuse_log.cgi This script can be used to detect people trying to abuse an ancient and long plugged security hole which existed in a CGI script distributed with Apache 1.0.3 and earlier versions.
rotatelogs.c rotate Apache logs without having to kill the server.
rotatelogs.8 (Manual Page)
split-logfile This script will take a combined virtual hosts access log file and break its contents into separate files. See split-logfile Manual
suexec.c Switch User For Exec. Used internally by apache, see the document `Apache suEXEC Support' under suexec.html.
suexec.8 (Manual Page)
This directory includes some utilities to allow Apache 1.3 to recognize passwords in SHA1 format, as used by Netscape web servers. It is not installed by default.