diff options
| author | Mukund Sivaraman <muks@banu.com> | 2009-09-13 03:59:03 +0530 |
|---|---|---|
| committer | Mukund Sivaraman <muks@banu.com> | 2009-09-13 03:59:03 +0530 |
| commit | 4cbc6b0359dcac8d3c6165433db8f220c70097bf (patch) | |
| tree | 381366febe2121af7d99134ca5a67a8451922d15 /doc/man8 | |
| parent | 13ccc059d05ab047b0ea0f32d202b0327bf40b08 (diff) | |
| download | tinyproxy-4cbc6b0359dcac8d3c6165433db8f220c70097bf.tar.gz tinyproxy-4cbc6b0359dcac8d3c6165433db8f220c70097bf.zip | |
doc: Move doc/HTML_VARIABLES content to the manpage
Diffstat (limited to 'doc/man8')
| -rw-r--r-- | doc/man8/tinyproxy.8 | 46 | ||||
| -rw-r--r-- | doc/man8/tinyproxy.txt | 34 |
2 files changed, 80 insertions, 0 deletions
diff --git a/doc/man8/tinyproxy.8 b/doc/man8/tinyproxy.8 index 1ae95b9..44225eb 100644 --- a/doc/man8/tinyproxy.8 +++ b/doc/man8/tinyproxy.8 @@ -62,6 +62,52 @@ In addition to command\-line options, there are also several signals that can be .RS 4 Force Tinyproxy to do a garbage collection on the current connections linked list\&. This is usually done automatically after a certain number of connections have been handled\&. .RE +.SH "TEMPLATE VARIABLES" +.sp +There are several standard HTML variables that are available in every template file: +.PP +\fBrequest\fR +.RS 4 +The full HTTP request line\&. +.RE +.PP +\fBcause\fR +.RS 4 +The abbreviated cause of the error condition\&. +.RE +.PP +\fBclientip\fR +.RS 4 +The IP address of the client making the request\&. +.RE +.PP +\fBclienthost\fR +.RS 4 +The hostname of the client making the request\&. +.RE +.PP +\fBversion\fR +.RS 4 +The version of tinyproxy\&. +.RE +.PP +\fBpackage\fR +.RS 4 +The package name\&. Presently, resolves to +\fItinyproxy\fR\&. +.RE +.PP +\fBdate\fR +.RS 4 +The current date/time in HTTP format\&. +.RE +.sp +In addition, almost all templates support: +.PP +\fBdetail\fR +.RS 4 +A detailed, plain English explanation of the error and possible causes\&. +.RE .SH "FILES" .sp /etc/tinyproxy/tinyproxy\&.conf, /var/run/tinyproxy\&.pid, /var/log/tinyproxy\&.log diff --git a/doc/man8/tinyproxy.txt b/doc/man8/tinyproxy.txt index 9aac609..4d292fe 100644 --- a/doc/man8/tinyproxy.txt +++ b/doc/man8/tinyproxy.txt @@ -58,6 +58,40 @@ information and to force certain events. certain number of connections have been handled. +TEMPLATE VARIABLES +------------------ + +There are several standard HTML variables that are available in every +template 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*:: + The package name. Presently, resolves to 'tinyproxy'. + +*date*:: + The current date/time in HTTP format. + +In addition, almost all templates support: + +*detail*:: + A detailed, plain English explanation of the error and possible + causes. + + FILES ----- |