Workaround for firefox hanging on blocked javascript pages
[privoxy.git] / privoxy.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "PRIVOXY" "1" "10 October 2009" "Privoxy 3.0.15 beta" ""
7 .SH NAME
8 privoxy \- Privacy Enhancing Proxy
9 .SH SYNOPSIS
10
11 \fBprivoxy\fR [\fB\-\-help\fR ] [\fB\-\-version\fR ] [\fB\-\-no-daemon\fR ] [\fB\-\-pidfile \fIpidfile\fB\fR ] [\fB\-\-user \fIuser[.group]\fB\fR ] [\fB\-\-chroot\fR ] [\fB\-\-pre-chroot-nslookup \fIhostname\fB\fR ] [\fB\fIconfigfile\fB\fR ]
12
13 .SH "OPTIONS"
14 .PP
15 \fBPrivoxy\fR may be invoked with the following command line
16 options:
17 .TP
18 \fB\-\-help\fR
19 Print brief usage info and exit.
20 .TP
21 \fB\-\-version\fR
22 Print version info and exit.
23 .TP
24 \fB\-\-no-daemon\fR
25 Don't  become  a daemon, i.e. don't fork and become process group
26 leader, don't detach from controlling tty, and do all logging there.
27 .TP
28 \fB\-\-pidfile \fIpidfile\fB\fR
29 On startup, write the process ID to \fIpidfile\fR.
30 Delete the \fIpidfile\fR on exit.
31 Failure to create or delete the \fIpidfile\fR
32 is non-fatal. If no \fB\-\-pidfile\fR option is given, no PID file will be used.
33 .TP
34 \fB\-\-user \fIuser[.group]\fB\fR
35 After (optionally) writing the PID file, assume the user ID of
36 \fIuser\fR and the GID of
37 \fIgroup\fR, or, if the optional
38 \fIgroup\fR was not given, the default group of
39 \fIuser\fR. Exit if the privileges are not
40 sufficient to do so.
41 .TP
42 \fB\-\-chroot\fR
43 Before changing to the user ID given in the \-\-user option, chroot to
44 that user's home directory, i.e. make the kernel pretend to the
45 \fBPrivoxy\fR process that the directory tree starts
46 there. If set up carefully, this can limit the impact of possible
47 vulnerabilities in \fBPrivoxy\fR to the files contained in
48 that hierarchy. 
49 .TP
50 \fB\-\-pre-chroot-nslookup \fIhostname\fB\fR
51 Initialize the resolver library using \fIhostname\fR
52 before chroot'ing. On some systems this reduces the number of files
53 that must be copied into the chroot tree.
54 .PP
55 If the \fIconfigfile\fR is not specified on  the  command  line,
56 \fBPrivoxy\fR  will  look for a file named
57 \fIconfig\fR in the current directory. If no
58 \fIconfigfile\fR is found, \fBPrivoxy\fR will 
59 fail to start.
60 .SH "DESCRIPTION"
61 .PP
62 Privoxy is a non-caching web proxy with advanced filtering capabilities
63 for enhancing privacy, modifying web page data and HTTP headers, controlling
64 access, and removing ads and other obnoxious Internet junk. Privoxy has a
65 flexible configuration and can be customized to suit individual needs and tastes.
66 It has application for both stand-alone systems and multi-user networks.
67 .PP
68 Privoxy is Free Software and licensed under the GPL2.
69 .PP
70 Privoxy is an associated project of Software in the Public Interest (SPI).
71 Donations are welcome.
72 .SH "INSTALLATION AND USAGE"
73 .PP
74 Browsers can either be individually configured to use
75 \fBPrivoxy\fR as a HTTP proxy (recommended),
76 or \fBPrivoxy\fR can be combined with a packet
77 filter to build an intercepting proxy
78 (see \fIconfig\fR).  The default setting is  for
79 localhost,  on port  8118 (configurable in the main config file).  To set the
80 HTTP proxy in Firefox, go through: \fBTools\fR; 
81 \fBOptions\fR; \fBGeneral\fR;
82 \fBConnection Settings\fR;
83 \fBManual Proxy Configuration\fR. 
84 .PP
85 For Internet Explorer, go through: \fBTools\fR; 
86 \fBInternet Properties\fR; \fBConnections\fR;
87 \fBLAN Settings\fR. 
88 .PP
89 The Secure (SSL) Proxy should also be set to the same values, otherwise
90 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
91 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
92 HTTPS presents some limitations, and not all features will work with HTTPS 
93 connections.
94 .PP
95 For other browsers, check the documentation.
96 .SH "CONFIGURATION"
97 .PP
98 \fBPrivoxy\fR can be configured with the various configuration
99 files. The default configuration files are: \fIconfig\fR,
100 \fIdefault.filter\fR, \fIdefault.action\fR and
101 \fIdefault.action\fR. \fIuser.action\fR should 
102 be used for locally defined exceptions to the default rules in
103 \fImatch-all.action\fR and \fIdefault.action\fR,
104 and \fIuser.filter\fR for locally defined filters. These are
105 well commented.  On Unix and Unix-like systems, these are located in
106 \fI/etc/privoxy/\fR by default. 
107 .PP
108 \fBPrivoxy\fR uses the concept of \fBactions\fR 
109 in order to manipulate the data stream between the browser and remote sites.
110 There are various actions available with specific functions for such things 
111 as blocking web sites, managing cookies, etc. These actions can be invoked
112 individually or combined, and used against individual URLs, or groups of URLs 
113 that can be defined using wildcards and regular expressions. The result is
114 that the user has greatly enhanced control and freedom.
115 .PP
116 The actions list (ad blocks, etc) can also be configured with your
117 web browser at http://config.privoxy.org/ 
118 (assuming the configuration allows it).
119 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
120 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
121 This is an internal page, and does not require Internet access.
122 .PP
123 See the \fIUser Manual\fR for a detailed
124 explanation of installation, general usage, all configuration options, new
125 features and notes on upgrading.
126 .SH "FILES"
127
128 .nf
129  
130  \fI/usr/sbin/privoxy\fR
131  \fI/etc/privoxy/config\fR
132  \fI/etc/privoxy/match-all.action\fR
133  \fI/etc/privoxy/default.action\fR
134  \fI/etc/privoxy/user.action\fR
135  \fI/etc/privoxy/default.filter\fR
136  \fI/etc/privoxy/user.filter\fR
137  \fI/etc/privoxy/trust\fR
138  \fI/etc/privoxy/templates/*\fR
139  \fI/var/log/privoxy/logfile\fR
140 .fi
141 .PP
142 Various other files should be included, but may vary depending on platform
143 and build configuration. Additional documentation should be included in the local
144 documentation directory.
145 .SH "SIGNALS"
146 .PP
147 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
148 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
149 rotation scripts may cause a re-opening of the logfile by sending a 
150 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
151 other daemons,  \fBPrivoxy\fR does not need to be made aware of
152 config file changes by \fBSIGHUP\fR -- it will detect them
153 automatically. 
154 .SH "NOTES"
155 .PP
156 This is a beta version of \fBPrivoxy\fR. Not
157 all features are well tested.
158 .PP
159 Please see the \fIUser Manual\fR on how to contact the
160 developers, for feature requests, reporting problems, and other questions.
161 .SH "SEE ALSO"
162 .PP
163 Other references and sites of interest to \fBPrivoxy\fR
164 users:
165 .PP
166
167 http://www.privoxy.org/, 
168 the \fBPrivoxy\fR Home page. 
169
170 http://www.privoxy.org/faq/, 
171 the \fBPrivoxy\fR FAQ. 
172
173 http://www.privoxy.org/developer-manual/, 
174 the \fBPrivoxy\fR developer manual. 
175
176 https://sourceforge.net/projects/ijbswa/, 
177 the Project Page for \fBPrivoxy\fR on 
178 SourceForge.
179
180 http://config.privoxy.org/,
181 the web-based user interface. \fBPrivoxy\fR must be
182 running for this to work. Shortcut: http://p.p/
183
184 https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
185 configuration related suggestions to the developers. 
186 .SH "DEVELOPMENT TEAM"
187
188 .nf
189  Fabian Keil, lead developer
190  David Schmidt, developer
191
192  Hal Burgiss
193  Mark Miller
194  Gerry Murphy
195  Lee Rian
196  Roland Rosenfeld
197 .fi
198 .SH "COPYRIGHT AND LICENSE"
199 .SS "COPYRIGHT"
200 .PP
201 Copyright (C) 2001-2009 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
202 .PP
203 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
204 and Junkbusters, Inc. and licensed under the \fIGNU General Public
205 License\fR.
206 .SS "LICENSE"
207 .PP
208 \fBPrivoxy\fR is free software; you can
209 redistribute it and/or modify it under the terms of the 
210 \fIGNU General Public License\fR, version 2,
211 as published by the Free Software Foundation.
212 .PP
213 This program is distributed in the hope that it will be useful, but WITHOUT
214 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
215 FITNESS FOR A PARTICULAR PURPOSE.  See the  \fIGNU General Public License\fR for details.
216 .PP
217 You should have received a copy of the \fIGNU GPL\fR
218 along with this program; if not, write to the  Free Software
219 Foundation, Inc. 51 Franklin Street, Fifth Floor
220 Boston, MA 02110-1301
221 USA