STATUS revision ed8096b26d46bd7833563cec0383a43da46fc352
02c335c23bf5fa225a467c19f2c063fb0dc7b8c3Timo SirainenApache HTTP Server 2.1 Documentation Status File.
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo SirainenLast modified: $Date: 2003/05/29 19:46:08 $
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
ef3ebb56989cb9b1b80edd133a091338e4206836Timo SirainenFor more information on how to contribute to the Apache Documentation
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo SirainenProject, please see http://httpd.apache.org/docs-project/
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen ------------------------------
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo SirainenDecisions pending
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen=================
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen -Comment out .gz etc. AddEncoding lines in our default configuration.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen docs/conf/httpd-std.conf.in rev 1.32
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen jerenkrantz said in the log message:
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen Current browsers have a tendency to decompress the data when no one
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen really wants it to do that. If you want the old behavior that leads to
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen transparent decompression by modern browsers, uncomment these lines.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen But, this shouldn't be our default.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen Someone else said: Certainly wasn't in 1.3.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen nd adds: we should provide example solutions somewhere in the docs.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen e.g.: .tar.gz should get the content-type application/x-gzip
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen (hmm, bad x-, better suggestions?).
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen <Files *.tar.gz>
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen Forcetype ...
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen </Files>
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Backport to 2.0
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek +1: wrowe, slive, nd
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek- Figure out what to do about the 2.0 FAQ
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Copy important stuff from 1.3?
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Some kind of XML?
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Something that allows dynamic contributions from users a la
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek FAQ-O-Matic? (I don't think any really good software exists
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek for this.)
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Perhaps we can use the newly created Wiki for this. (SubWiki,
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek with the possibility to get nice commit mails.)
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek nd: someone should try to convince me, what the heck is
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek so cool with wikis
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek erik: it lowers the entry barrier and therefore users are able to
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek contribute (handy for a FAQ, see PHP site)
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek nd: yes, good bad example. The PHP docs would mostly be
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek better without these comments. I don't want to censor
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek the entries, but also don't want to leave them without
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek control. IMHO it's better to incorporate changes into the
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek static docs. We need some better way of feedback, anyway.
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' SipekThings That Need Fixing
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek=======================
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek- Windows platform docs are in desperate need of rewrites/updates for 2.0.
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Bill Rowe and Bill Stoddard are good contacts for tech questions.
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - "using apache" has been done, "compiling apache" is still open
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - hints on uninstalling apache (exit monitor, close directories,
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek registry entries etc) (PR 10154)
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - FAQ! UTF-8 config and URL encoding for non-ascii characters.
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek- New Auth system
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Much clean-up and enhancement of aaa howto
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - Independent note on how to upgrade to new auth system
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen- modules docs
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen - mod_suexec: very little documentation
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen - mod_proxy: updates for 2.0
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - mod_status: updates for 2.0
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - mod_example: updates for 2.0
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen - mod_rewrite: explain, when what variables are actually available
2ac5f36aa7c2e7a07ba8815d43a6d7483f62e74cTimo Sirainen (PR 16402)
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen- man pages
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Convert from nroff to our xml format. See list at bottom.
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek - Then if someone gets creative, they can try to find an automatic
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen way to convert back to nroff.
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen - An example: http://cyberelk.net/tim/data/xmlto/db2man/
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen This is designed for docbook, but it could be adapted.
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen I'm not sure what the license is.
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen- MPM documentation
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - explain what the following command line options do
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen (perhaps in the developer/debugging docs):
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen -D DEBUG
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen -D ONE_PROCESS
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen one-process-mode == no threads, i.e. only one
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek process handling the requests in a single loop?
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen -D NO_DETACH (not in every MPM avail.)
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen no daemon, but detached from terminal?
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek -D FOREGROUND (not in every MPM avail.)
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek ?
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen- Individual docs will need some cleanup.
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - misc/custom_errordocs.html needs to be updated to
75891a354ed229a4e56bbb0eceab75a0d1278687Josef 'Jeff' Sipek essentially describe how the international error
71ecc97593a25c2444316b74e5882e6ce0a82c0cTimo Sirainen docs included in 2.0 work
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - misc/perf-tuning.html - needs major rewrite for 2.0
adb90447f6bf7b11b5fca7e87a3f256622fdef9fTimo Sirainen - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
a10ed8c47534b4c6b6bf2711ccfe577e720a47b4Timo Sirainen - platform/ebcdic.xml - needs major rework for 2.0
f7ec15aefabeb0a17d1f262bc5e9a15e43dfc5adTimo Sirainen
f7ec15aefabeb0a17d1f262bc5e9a15e43dfc5adTimo Sirainen- New build process.
a10ed8c47534b4c6b6bf2711ccfe577e720a47b4Timo Sirainen - install.html has had a first-pass rewrite, it is basically
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen accurate, but very incomplete: many configure options are missing,
0989e8ba44ec35dc9322e424b5213b96596319e7Timo Sirainen especially those inherited from apr.
0989e8ba44ec35dc9322e424b5213b96596319e7Timo Sirainen
0989e8ba44ec35dc9322e424b5213b96596319e7Timo Sirainen- API documentation
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - Ben Laurie has written some hooks documentation
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - authn provider API documentation could be useful
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen- Several features in Apache require write-access to the filesystem.
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen Examples: CacheRoot, DavLockDB, ScriptLog
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen We should treat the things consistently in the docs, and perhaps
2719970c2c246f976178da179deeb64eecaec5baTimo Sirainen suggest the use of directory like /usr/local/apache2/var/ that is
0989e8ba44ec35dc9322e424b5213b96596319e7Timo Sirainen httpd-writable.
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen- SSL docs are generally good, but they need a refreshing by someone
2ac5f36aa7c2e7a07ba8815d43a6d7483f62e74cTimo Sirainen familiar with mod_ssl and openssl.
2ac5f36aa7c2e7a07ba8815d43a6d7483f62e74cTimo Sirainen
2ac5f36aa7c2e7a07ba8815d43a6d7483f62e74cTimo SirainenDocumentation improvements
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen==========================
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
6e81d67a4e8985d35034eab791e270ffc01800b8Timo Sirainen* Enhancements to the DTD/XSL:
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - <glossary> tag that links to the glossary and uses some special
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen style in the css.
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - New index: directives by context, including listing which directives
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen are available for each AllowOverride setting.
2719970c2c246f976178da179deeb64eecaec5baTimo Sirainen - New index: backout modules by type (aaa, mappers, loggers etc.)
2719970c2c246f976178da179deeb64eecaec5baTimo Sirainen probably by introducing a <category> element in modulesynopsis
27a44fcfd8d19bffe0f267f20a2b5d3fe7600fddTimo Sirainen - Use a tag like <var> in place of <em> for things like the
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen <syntax> listing.
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - in progress
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - add letter links to glossary and quickreference,
2719970c2c246f976178da179deeb64eecaec5baTimo Sirainen perhaps also a term overview (sidebar)
2719970c2c246f976178da179deeb64eecaec5baTimo Sirainen - cross references between the different languages,
27a44fcfd8d19bffe0f267f20a2b5d3fe7600fddTimo Sirainen at least links from non-en docs to the originals.
27a44fcfd8d19bffe0f267f20a2b5d3fe7600fddTimo Sirainen - Javascript?
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - post processing (s&r, XML::Parser, ...)?
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - pre processing ([kind of] type maps
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen generated from sitemap entries like:
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen <page><variant lang="en" href="">title</variant>)?
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - looking for other good ideas ;-)
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - remove <pre> elements. Use <br /> and <indent> elements to get
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen a similar effect.
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen* Autogeneration of PDF
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - Andr� is working on this, Erik volunteers to help out
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen* Improving the "security docs"
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen - More content and better organisation.
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - mod_dav ressources are owned by the httpd
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen* General cleaning and improving of module docs
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen* Making the directive definitions "less terse" (i.e., adding more
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen examples and details to the definitions of the directives)
8bb360f9e5de1c25e4f875205bb06e8bf15dae14Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen* Making site-specific enhancements easier, including a documented
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen and robust way for 3P module docco to be added -- and have it
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen survive a server docco upgrade
c8e34785671d3b13f4500144a2ec7af968ce3307Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen - This could be something a simple and hackish as a manual/extra/
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen directory (a la the 1.3 src/modules/extra/ directory) and a
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen script in the support directory that scans the files there and
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen updates the manual indices. (We do something like that now for
4334b9b032298defd4d3906f5357698ff016ead0Timo Sirainen httpd.conf file with apxs [LoadModule, etc.].)
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen
39025a2dabfcfaeee3790988b9ea00d19887a3d3Timo Sirainen* Summarize all the implemented drafts/standards with short explanations
76a71915c6452a4bee9a8ae89ddbdf58fa941deeTimo Sirainen within a document. (PR 16938)
76a71915c6452a4bee9a8ae89ddbdf58fa941deeTimo Sirainen
76a71915c6452a4bee9a8ae89ddbdf58fa941deeTimo Sirainen