1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
'\" t
.\" Title: tinyproxy
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
.\" Date: 09/14/2009
.\" Manual: Tinyproxy manual
.\" Source: Version 1.7.1
.\" Language: English
.\"
.TH "TINYPROXY" "8" "09/14/2009" "Version 1\&.7\&.1" "Tinyproxy manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tinyproxy \- A light\-weight HTTP proxy daemon
.SH "SYNOPSIS"
.sp
\fBtinyproxy\fR [\-vldch]
.SH "DESCRIPTION"
.sp
\fBtinyproxy\fR is a light\-weight HTTP proxy daemon designed to consume a minimum amount of system resources\&. It listens on a given TCP port and handles HTTP proxy requests\&. Designed from the ground up to be fast and yet small, it is an ideal solution for use cases such as embedded deployments where a full featured HTTP proxy is required, but the system resources for a larger proxy are unavailable\&.
.SH "OPTIONS"
.sp
\fBtinyproxy\fR accepts the following options:
.PP
\fB\-c <config\-file>\fR
.RS 4
Use an alternate configuration file\&.
.RE
.PP
\fB\-d\fR
.RS 4
Don\(cqt daemonize and stay in the foreground\&. Useful for debugging purposes\&.
.RE
.PP
\fB\-h\fR
.RS 4
Display a short help screen of command line arguments and exit\&.
.RE
.PP
\fB\-l\fR
.RS 4
Display the licensing agreement\&.
.RE
.PP
\fB\-v\fR
.RS 4
Display version information and exit\&.
.RE
.SH "SIGNALS"
.sp
In addition to command\-line options, there are also several signals that can be sent to \fBtinyproxy\fR while it is running to generate debugging information and to force certain events\&.
.PP
\fBSIGHUP\fR
.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 FILES"
.sp
There are two occasions when Tinyproxy delivers HTML pages to the client on it\(cqs own right:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
When an error occurred, a corresponding error page is returned\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
When a request for the stathost is made, a page summarizing the connection statistics is returned\&. (See STATHOST below\&.)
.RE
.sp
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 few template variables\&.
.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
.sp
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\&.
.SH "STATHOST"
.sp
Tinyproxy returns a HTML page with connection statistics when it receives a HTTP request for a certain host \(em 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\&.
.sp
The stat file template can be changed at runtime through the configuration variable StatFile\&.
.SH "FILES"
.sp
/etc/tinyproxy/tinyproxy\&.conf, /var/run/tinyproxy\&.pid, /var/log/tinyproxy\&.log
.SH "BUGS"
.sp
To report bugs in Tinyproxy, please visit <https://www\&.banu\&.com/tinyproxy/support/>\&.
.SH "COPYRIGHT"
.sp
Copyright (c) 1998\-2000 Steven Young; Copyright (c) 2000\-2001 Robert James Kaes; Copyright (c) 2009 Mukund Sivaraman; Copyright (c) 2009 Michael Adam\&.
.sp
This program is distributed under the terms of the GNU General Public License version 2 or above\&. See the COPYING file for additional information\&.
|
