diff options
| author | Mukund Sivaraman <muks@banu.com> | 2010-01-19 19:12:24 +0530 |
|---|---|---|
| committer | Mukund Sivaraman <muks@banu.com> | 2010-01-19 19:12:24 +0530 |
| commit | 9b9d8c10f817e8fb81d761f3f4ba915cc79ae776 (patch) | |
| tree | 2fa01735ce332a12b6eb477808b9ccedfb5f9fd6 | |
| parent | b08420ec133aa0e55536a44f8afbf43ec41fec5c (diff) | |
| download | tinyproxy-9b9d8c10f817e8fb81d761f3f4ba915cc79ae776.tar.gz tinyproxy-9b9d8c10f817e8fb81d761f3f4ba915cc79ae776.zip | |
Reformat README for asciidoc
| -rw-r--r-- | README | 54 |
1 files changed, 31 insertions, 23 deletions
@@ -15,7 +15,7 @@ administrator. For more info, please visit: - https://www.banu.com/tinyproxy/ +<https://www.banu.com/tinyproxy/> Installation @@ -35,21 +35,27 @@ in the top level directory to compile and install Tinyproxy. There are additional command line arguments you can supply to `configure`. They include: - --enable-debug If you would like to turn on full - debugging support - --enable-xtinyproxy Compile in support for the XTinyproxy - header, which is sent to any web - server in your domain. - --enable-filter Allows Tinyproxy to filter out certain - domains and URLs. - --enable-upstream Enable support for proxying connections - through another proxy server. - --enable-transparent-proxy - Allow Tinyproxy to be used as a - transparent proxy daemon - --enable-static Compile a static version of Tinyproxy +--enable-debug:: + If you would like to turn on full debugging support. - --with-stathost=HOST Set the default name of the stats host +--enable-xtinyproxy:: + Compile in support for the XTinyproxy header, which is sent to any + web server in your domain. + +--enable-filter:: + Allows Tinyproxy to filter out certain domains and URLs. + +--enable-upstream:: + Enable support for proxying connections through another proxy server. + +--enable-transparent-proxy:: + Allow Tinyproxy to be used as a transparent proxy daemon. + +--enable-static:: + Compile a static version of Tinyproxy. + +--with-stathost=HOST:: + Set the default name of the stats host. Support @@ -58,14 +64,16 @@ Support If you are having problems with Tinyproxy, please submit a bug report using Tinyproxy as the product at: - https://www.banu.com/bugzilla/ +<https://www.banu.com/bugzilla/> You may also wish to subscribe to the Tinyproxy mailing lists. To do so please visit: - https://www.banu.com/mailman/listinfo/tinyproxy-announce-list - https://www.banu.com/mailman/listinfo/tinyproxy-users-list - https://www.banu.com/mailman/listinfo/tinyproxy-developers-list +<https://www.banu.com/mailman/listinfo/tinyproxy-announce-list> + +<https://www.banu.com/mailman/listinfo/tinyproxy-users-list> + +<https://www.banu.com/mailman/listinfo/tinyproxy-developers-list> for more information on how to subscribe and post messages to the lists. @@ -75,11 +83,11 @@ Contributing If you would like to contribute a feature, or a bug fix to the Tinyproxy source, please send a patch (preferably as a unified diff. i.e. `diff --u` against the "master" branch of the Tinyproxy source code git -repository to tinyproxy-developers-list. Please include a description +-u` against the 'master' branch of the Tinyproxy source code git +repository to 'tinyproxy-developers-list'. Please include a description of what your patch does. -Tinyproxy's git repository is git://www.banu.com/tinyproxy.git. The +Tinyproxy's git repository is <git://www.banu.com/tinyproxy.git>. The following command creates a local copy: ---- @@ -94,4 +102,4 @@ integrated into the upstream repository, automatically keeping the commit message and author information. You can also meet developers and discuss development issues and patches -in the #tinyproxy IRC channel on Freenode (irc.freenode.net). +in the `#tinyproxy` IRC channel on Freenode (`irc.freenode.net`). |