From 00614c152395b13ee8aaae4799351c2c6b295c79 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Mon, 14 Sep 2009 15:42:43 +0530 Subject: doc: Update manpage to set missing fields --- doc/man8/Makefile.am | 5 +- doc/man8/tinyproxy.8 | 62 +++++++++++++------ doc/man8/tinyproxy.txt | 151 --------------------------------------------- doc/man8/tinyproxy.txt.in | 152 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 199 insertions(+), 171 deletions(-) delete mode 100644 doc/man8/tinyproxy.txt create mode 100644 doc/man8/tinyproxy.txt.in (limited to 'doc') diff --git a/doc/man8/Makefile.am b/doc/man8/Makefile.am index 3dc9dea..82a78bb 100644 --- a/doc/man8/Makefile.am +++ b/doc/man8/Makefile.am @@ -19,5 +19,6 @@ EXTRA_DIST = \ $(MAN8_FILES) \ $(man_MANS) -clean-local: - rm -f $(MAN8_FILES:.txt=.8) $(MAN1_FILES:.txt=.xml) +CLEANFILES = \ + $(MAN8_FILES:.txt=.8) \ + $(MAN8_FILES:.txt=.xml) diff --git a/doc/man8/tinyproxy.8 b/doc/man8/tinyproxy.8 index f71ff04..dc99001 100644 --- a/doc/man8/tinyproxy.8 +++ b/doc/man8/tinyproxy.8 @@ -1,24 +1,33 @@ +'\" t .\" Title: tinyproxy -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.3 .\" Date: 09/14/2009 -.\" Manual: -.\" Source: +.\" Manual: Tinyproxy manual +.\" Source: Version 1.7.1 +.\" Language: English .\" -.TH "TINYPROXY" "8" "09/14/2009" "" "" +.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 +tinyproxy \- A light\-weight HTTP proxy daemon .SH "SYNOPSIS" -\fBtinyproxy\fR [\-vldch] .sp +\fBtinyproxy\fR [\-vldch] .SH "DESCRIPTION" -\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\&. .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 \fR @@ -28,7 +37,7 @@ Use an alternate configuration file\&. .PP \fB\-d\fR .RS 4 -Don\'t daemonize and stay in the foreground\&. Useful for debugging purposes\&. +Don\(cqt daemonize and stay in the foreground\&. Useful for debugging purposes\&. .RE .PP \fB\-h\fR @@ -46,6 +55,7 @@ Display the licensing agreement\&. 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 @@ -53,19 +63,34 @@ In addition to command\-line options, there are also several signals that can be 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" -There are two occasions when tinyproxy delivers HTML pages to the client on it\'s own right: .sp +There are two occasions when tinyproxy delivers HTML pages to the client on it\(cqs own right: .sp .RS 4 -\h'-04' 1.\h'+02'When an error occurred, a corresponding error page is returned\&. +.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 -\h'-04' 2.\h'+02'When a request for the stathost is made, a page summarizing the connection statistics is returned\&. (See STATHOST below\&.) +.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 -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 couple of template variables\&. .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 couple of template variables\&. .SH "TEMPLATE VARIABLES" +.sp There are several standard HTML variables that are available in every template file: .PP \fBrequest\fR @@ -103,27 +128,28 @@ The package name\&. Presently, resolves to .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 -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\&. .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 an 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\&. -.sp .SH "FILES" -/etc/tinyproxy/tinyproxy\&.conf, /var/run/tinyproxy\&.pid, /var/log/tinyproxy\&.log .sp +/etc/tinyproxy/tinyproxy\&.conf, /var/run/tinyproxy\&.pid, /var/log/tinyproxy\&.log .SH "BUGS" -To report bugs in Tinyproxy, please visit \&. .sp +To report bugs in Tinyproxy, please visit \&. .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\&. -.sp diff --git a/doc/man8/tinyproxy.txt b/doc/man8/tinyproxy.txt deleted file mode 100644 index 4802b7b..0000000 --- a/doc/man8/tinyproxy.txt +++ /dev/null @@ -1,151 +0,0 @@ -TINYPROXY(8) -============ -:Author: The Tinyproxy Team - -NAME ----- - -tinyproxy - A light-weight HTTP proxy daemon - - -SYNOPSIS --------- - -*tinyproxy* [-vldch] - - -DESCRIPTION ------------ - -*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. - - -OPTIONS -------- - -*tinyproxy* accepts the following options: - -*-c *:: - Use an alternate configuration file. - -*-d*:: - Don't daemonize and stay in the foreground. Useful for debugging purposes. - -*-h*:: - Display a short help screen of command line arguments and exit. - -*-l*:: - Display the licensing agreement. - -*-v*:: - Display version information and exit. - - -SIGNALS -------- - -In addition to command-line options, there are also several signals that -can be sent to *tinyproxy* while it is running to generate debugging -information and to force certain events. - -*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. - - -TEMPLATE FILES --------------- - -There are two occasions when tinyproxy delivers HTML pages to -the client on it's own right: - -. When an error occurred, a corresponding error page is returned. -. When a request for the stathost is made, a page summarizing the - connection statistics is returned. (See STATHOST below.) - -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 couple of template -variables. - - -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. - -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. - - -STATHOST --------- - -Tinyproxy returns an html page with connection statistics when it -receives a HTTP request for a certain host -- 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. - -The stat file template can be changed at runtime through the configuration -variable StatFile. - - -FILES ------ - -`/etc/tinyproxy/tinyproxy.conf`, `/var/run/tinyproxy.pid`, `/var/log/tinyproxy.log` - -BUGS ----- - -To report bugs in Tinyproxy, please visit -. - - -COPYRIGHT ---------- - -Copyright (c) 1998-2000 Steven Young; -Copyright (c) 2000-2001 Robert James Kaes; -Copyright (c) 2009 Mukund Sivaraman; -Copyright (c) 2009 Michael Adam. - -This program is distributed under the terms of the GNU General Public -License version 2 or above. See the COPYING file for additional -information. diff --git a/doc/man8/tinyproxy.txt.in b/doc/man8/tinyproxy.txt.in new file mode 100644 index 0000000..d3d800e --- /dev/null +++ b/doc/man8/tinyproxy.txt.in @@ -0,0 +1,152 @@ +TINYPROXY(8) +============ +:man source: Version @VERSION@ +:man manual: Tinyproxy manual + +NAME +---- + +tinyproxy - A light-weight HTTP proxy daemon + + +SYNOPSIS +-------- + +*tinyproxy* [-vldch] + + +DESCRIPTION +----------- + +*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. + + +OPTIONS +------- + +*tinyproxy* accepts the following options: + +*-c *:: + Use an alternate configuration file. + +*-d*:: + Don't daemonize and stay in the foreground. Useful for debugging purposes. + +*-h*:: + Display a short help screen of command line arguments and exit. + +*-l*:: + Display the licensing agreement. + +*-v*:: + Display version information and exit. + + +SIGNALS +------- + +In addition to command-line options, there are also several signals that +can be sent to *tinyproxy* while it is running to generate debugging +information and to force certain events. + +*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. + + +TEMPLATE FILES +-------------- + +There are two occasions when tinyproxy delivers HTML pages to +the client on it's own right: + +. When an error occurred, a corresponding error page is returned. +. When a request for the stathost is made, a page summarizing the + connection statistics is returned. (See STATHOST below.) + +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 couple of template +variables. + + +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. + +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. + + +STATHOST +-------- + +Tinyproxy returns an html page with connection statistics when it +receives a HTTP request for a certain host -- 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. + +The stat file template can be changed at runtime through the configuration +variable StatFile. + + +FILES +----- + +`/etc/tinyproxy/tinyproxy.conf`, `/var/run/tinyproxy.pid`, `/var/log/tinyproxy.log` + +BUGS +---- + +To report bugs in Tinyproxy, please visit +. + + +COPYRIGHT +--------- + +Copyright (c) 1998-2000 Steven Young; +Copyright (c) 2000-2001 Robert James Kaes; +Copyright (c) 2009 Mukund Sivaraman; +Copyright (c) 2009 Michael Adam. + +This program is distributed under the terms of the GNU General Public +License version 2 or above. See the COPYING file for additional +information. -- cgit v1.2.3