summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Adam <obnox@samba.org>2009-09-21 23:47:45 +0200
committerMichael Adam <obnox@samba.org>2009-09-22 00:05:23 +0200
commit93219ea0db37b565b04a9efad2576fb8f610117a (patch)
tree907f41e6613a15fc01e99b1d1f7015b477fb8b77
parent92c64cabc1c8f1d1caebf73adb802768adf41d3c (diff)
downloadtinyproxy-93219ea0db37b565b04a9efad2576fb8f610117a.tar.gz
tinyproxy-93219ea0db37b565b04a9efad2576fb8f610117a.zip
docs:tinyproxy.conf: describe ErrorFile and DefaultErrorFile and StatFile
Somehow, I don't quite get the asciidoc formatting yet. I can't get the extra paragraph on templates to look nice in the manpage output. But at least there is some content... Michael
-rw-r--r--docs/man5/tinyproxy.conf.txt.in28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/man5/tinyproxy.conf.txt.in b/docs/man5/tinyproxy.conf.txt.in
index cc7380c..773ac57 100644
--- a/docs/man5/tinyproxy.conf.txt.in
+++ b/docs/man5/tinyproxy.conf.txt.in
@@ -72,6 +72,34 @@ The possible keywords and their descriptions are as follows:
The maximum number of seconds of inactivity a connection is
allowed to have before it is closed by Tinyproxy.
+*ErrorFile*::
+
+ This parameter controls which HTML file Tinyproxy returns when a
+ given HTTP error occurs. It takes two arguments, the error number
+ and the location of the HTML error file.
+
+*DefaultErrorFile*::
+
+ This parameter controls the HTML template file returned when an
+ error occurs for which no specific error file has been set.
+
+
+*StatFile*::
+
+ This configures the HTML file that Tinyproxy sends when
+ a request for the stathost is received. If this parameter is
+ not set, Tinyproxy returns a hardcoded basic statistics page.
+ See the STATHOST section in the `tinyproxy(8)` manual page
+ for details.
+
+
+ Note that the StatFile and the error files configured with ErrorFile
+ and DefaultErrorFile are template files that can contain a few
+ template variables that Tinyproxy expands prior to delivery.
+ Examples are "\{cause}" for an abbreviated error description and
+ "\{detail}" for a datiled error message. The `tinyproxy(8)`
+ manual page contains a description of all template variables.
+
BUGS
----