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

doc: Move doc/HTML_VARIABLES content to the manpage

Browse Source
This commit is contained in:
Mukund Sivaraman 2009-09-13 03:59:03 +05:30
parent 13ccc059d0
commit 4cbc6b0359
4 changed files with 80 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/HTML_VARIABLES
View File

@ -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.

1
doc/Makefile.am
View File

@ -3,7 +3,6 @@ SUBDIRS = \
EXTRA_DIST = \
tinyproxy.conf \
HTML_VARIABLES \
http-error-codes.txt \
http-rfcs.txt \
filter-howto.txt

46
doc/man8/tinyproxy.8
View File

@ -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

34
doc/man8/tinyproxy.txt
View File

@ -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
-----