summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMukund Sivaraman <muks@banu.com>2009-09-13 03:59:03 +0530
committerMukund Sivaraman <muks@banu.com>2009-09-13 03:59:03 +0530
commit4cbc6b0359dcac8d3c6165433db8f220c70097bf (patch)
tree381366febe2121af7d99134ca5a67a8451922d15
parent13ccc059d05ab047b0ea0f32d202b0327bf40b08 (diff)
downloadtinyproxy-4cbc6b0359dcac8d3c6165433db8f220c70097bf.tar.gz
tinyproxy-4cbc6b0359dcac8d3c6165433db8f220c70097bf.zip
doc: Move doc/HTML_VARIABLES content to the manpage
-rw-r--r--doc/HTML_VARIABLES15
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/man8/tinyproxy.846
-rw-r--r--doc/man8/tinyproxy.txt34
4 files changed, 80 insertions, 16 deletions
diff --git a/doc/HTML_VARIABLES b/doc/HTML_VARIABLES
deleted file mode 100644
index 2bdf3ad..0000000
--- a/doc/HTML_VARIABLES
+++ /dev/null
@@ -1,15 +0,0 @@
-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/Makefile.am b/doc/Makefile.am
index b246228..151bcbb 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -3,7 +3,6 @@ SUBDIRS = \
EXTRA_DIST = \
tinyproxy.conf \
- HTML_VARIABLES \
http-error-codes.txt \
http-rfcs.txt \
filter-howto.txt
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
-----