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