summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/HTML_VARIABLES15
-rw-r--r--doc/debug.html48
-rw-r--r--doc/default.html7
-rw-r--r--doc/stats.html10
4 files changed, 80 insertions, 0 deletions
diff --git a/doc/HTML_VARIABLES b/doc/HTML_VARIABLES
new file mode 100644
index 0000000..2bdf3ad
--- /dev/null
+++ b/doc/HTML_VARIABLES
@@ -0,0 +1,15 @@
+There are several standard HTML variables that are available in every .html
+file:
+
+ request - The full HTTP request line.
+ cause - The abbreviated cause of the error condition.
+ clientip - The IP address of the client making the request.
+ clienthost - The hostname of the client making the request.
+ version - The version of tinyproxy.
+ package - Presently, resolves to 'tinyproxy'.
+ date - The current date/time in HTTP format.
+
+In addition, almost all pages support:
+
+ detail - A detailed, plain English explanation of the error and possible
+ causes. You might consider this the Microsoftian error message.
diff --git a/doc/debug.html b/doc/debug.html
new file mode 100644
index 0000000..c62ca43
--- /dev/null
+++ b/doc/debug.html
@@ -0,0 +1,48 @@
+<html>
+<head>
+<title>
+Request failed - {cause}
+</title>
+</head>
+<body>
+<center>{cause}</center>
+<blockquote>
+The request you made failed. Here are the error variables:
+<dt>
+request
+<dd>
+{request}
+<dt>
+cause
+<dd>
+{cause}
+<dt>
+clientip
+<dd>
+{clientip}
+<dt>
+clienthost
+<dd>
+{clienthost}
+<dt>
+version
+<dd>
+{version}
+<dt>
+package
+<dd>
+{package}
+<dt>
+date
+<dd>
+{date}
+<dt>
+detail
+<dd>
+{detail}
+<dt>
+url
+<dd>
+{url}
+</body>
+</html>
diff --git a/doc/default.html b/doc/default.html
new file mode 100644
index 0000000..2cb291d
--- /dev/null
+++ b/doc/default.html
@@ -0,0 +1,7 @@
+<html><head><title>{cause}</title></head>
+<body>
+<font size=\+2\>Cache Error!</font><br>
+The following error has occured: {detail}
+<hr>
+<font size=\-1\><em>Generated by {package} ({version})</em></font>
+</body></html>
diff --git a/doc/stats.html b/doc/stats.html
new file mode 100644
index 0000000..2168606
--- /dev/null
+++ b/doc/stats.html
@@ -0,0 +1,10 @@
+<html><head><title>{package} ({version}) stats</title></head>
+<body>
+<center><h2>{package} ({version}) run-time statistics</h2></center><hr>
+<blockquote>
+Number of open connections: {opens}<br>
+Number of requests: {reqs}<br>
+Number of bad connections: {badconns}<br>
+Number of denied connections: {deniedconns}<br>
+Number of refused connections due to high load: {refusedconns}<br>
+</blockquote></body></html>