bughz/tinyproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update tinyproxy manpage: elaborate template files and explain stat host.

Browse Source 
Michael
This commit is contained in:
Michael Adam 2009-09-14 11:00:52 +02:00
parent afacc3d80b
commit cdb9d54dca
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/man8/tinyproxy.txt
View File

@ -58,6 +58,22 @@ information and to force certain events.
certain number of connections have been handled. certain number of connections have been handled.
TEMPLATE FILES
--------------
There are two occasions when tinyproxy delivers HTML pages to
the client on it's own right:
1. When an error occurred, a corresponding error page is returned.
2. When a request for the stathost is made, a page summarizing the
connection statistics is returned. (See STATHOST below.)
The layout of both error pages and the statistics page can be
controlled via configurable HTML template files that are plain
HTML files that additionally understand a couple of template
variables.
TEMPLATE VARIABLES TEMPLATE VARIABLES
------------------ ------------------
@ -91,6 +107,23 @@ In addition, almost all templates support:
A detailed, plain English explanation of the error and possible A detailed, plain English explanation of the error and possible
causes. causes.
When tinyproxy finds a variable name enclosed in braces, e.g.
"\{request}", then this is replaced by the value of the corresponding
variable before delivery of the page.
STATHOST
--------
Tinyproxy returns an html page with connection statistics when it
receives a HTTP request for a certain host -- the stathost.
The stathost name defaults to tinyproxy.stats and can be changed
at compile-time with the configure switch `--with-stathost` to any
name or IP address.
The stat file template can be changed at runtime through the configuration
variable StatFile.
FILES FILES
----- -----