a547a298c7
it turned out that the upstream section in tinyproxy.conf.5 wasn't rendered properly, because in asciidoc items following a list item are always explicitly appended to the last list item. after several hours of finding a workaround, it was decided to change the manpage generator to pod2man instead. as pod2man ships together with any perl base install, it should be available on almost every UNIX system, unlike asciidoc which requires installation of a huge set of dependencies (more than 1.3 GB on Ubuntu 16.04), and the replacement asciidoctor requires a ruby installation plus a "gem" (which is by far better than asciidoc, but still more effort than using the already available pod2man). tinyproxy's hard requirement of a2x (asciidoctor) for building from source caused rivers of tears (and dozens of support emails/issues) in the past, but finally we get rid of it. a tool such as a2x with its XML based bloat- technology isn't really suited to go along with a supposedly lightweight C program. if it ever turns out that even pod2man is too heavy a dependency, we could still write our own replacement in less than 50 lines of awk, as the pod syntax is very low level and easy to parse.
177 lines
3.6 KiB
Plaintext
177 lines
3.6 KiB
Plaintext
=pod
|
|
|
|
=encoding utf8
|
|
|
|
=head1 NAME
|
|
|
|
tinyproxy - A light-weight HTTP proxy daemon
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<tinyproxy> [-vdch]
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
B<tinyproxy> 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.
|
|
|
|
|
|
=head1 OPTIONS
|
|
|
|
B<tinyproxy> accepts the following options:
|
|
|
|
=over 4
|
|
|
|
=item B<-c <config-file>>
|
|
|
|
Use an alternate configuration file.
|
|
|
|
=item B<-d>
|
|
|
|
Don't daemonize and stay in the foreground. Useful for debugging purposes.
|
|
|
|
=item B<-h>
|
|
|
|
Display a short help screen of command line arguments and exit.
|
|
|
|
=item B<-v>
|
|
|
|
Display version information and exit.
|
|
|
|
=back
|
|
|
|
=head1 SIGNALS
|
|
|
|
In addition to command-line options, there are also several signals that
|
|
can be sent to B<tinyproxy> while it is running to generate debugging
|
|
information and to force certain events.
|
|
|
|
=over 4
|
|
|
|
=item B<SIGHUP>
|
|
|
|
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.
|
|
|
|
=back
|
|
|
|
=head1 TEMPLATE FILES
|
|
|
|
There are two occasions when Tinyproxy delivers HTML pages to
|
|
the client on it's own right:
|
|
|
|
=over 4
|
|
|
|
=item * When an error occurred, a corresponding error page is returned.
|
|
|
|
=item * When a request for the stathost is made, a page summarizing the
|
|
connection statistics is returned. (See STATHOST below.)
|
|
|
|
=back
|
|
|
|
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.
|
|
|
|
|
|
=head1 TEMPLATE VARIABLES
|
|
|
|
There are several standard HTML variables that are available in every
|
|
template file:
|
|
|
|
=over 4
|
|
|
|
=item B<request>
|
|
|
|
The full HTTP request line.
|
|
|
|
=item B<cause>
|
|
|
|
The abbreviated cause of the error condition.
|
|
|
|
=item B<clientip>
|
|
|
|
The IP address of the client making the request.
|
|
|
|
=item B<clienthost>
|
|
|
|
The hostname of the client making the request.
|
|
|
|
=item B<version>
|
|
|
|
The version of Tinyproxy.
|
|
|
|
=item B<package>
|
|
|
|
The package name. Presently, resolves to 'tinyproxy'.
|
|
|
|
=item B<date>
|
|
|
|
The current date/time in HTTP format.
|
|
|
|
=back
|
|
|
|
In addition, almost all templates support:
|
|
|
|
=over 4
|
|
|
|
=item B<detail>
|
|
|
|
A detailed, plain English explanation of the error and possible
|
|
causes.
|
|
|
|
=back
|
|
|
|
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.
|
|
|
|
|
|
=head1 STATHOST
|
|
|
|
Tinyproxy returns a HTML page with connection statistics when it
|
|
receives a HTTP request for a certain host -- the stathost. The
|
|
stathost name defaults to `@TINYPROXY_STATHOST@` and can be changed at
|
|
runtime to any name or IP address with the configuration variable
|
|
`StatHost`.
|
|
|
|
The stat file template can be changed at runtime through the
|
|
configuration variable `StatFile`.
|
|
|
|
|
|
=head1 FILES
|
|
|
|
`/etc/tinyproxy/tinyproxy.conf`, `/var/run/tinyproxy/tinyproxy.pid`, `/var/log/tinyproxy/tinyproxy.log`
|
|
|
|
=head1 BUGS
|
|
|
|
To report bugs in Tinyproxy, please visit
|
|
L<https://tinyproxy.github.io/>.
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<tinyproxy.conf(5)>
|
|
|
|
|
|
=head1 AUTHOR
|
|
|
|
This manpage was written by the Tinyproxy project team.
|
|
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright (c) 1998-2018 the Tinyproxy authors.
|
|
|
|
This program is distributed under the terms of the GNU General Public
|
|
License version 2 or above. See the COPYING file for additional
|
|
information.
|