nit
[privoxy.git] / junkbuster.1
1 .\" Revised man page 10/13/01, for development version.\r
2 .\" Hal Burgiss <hal@foobox.net> \r
3 .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
4 .\"\r
5 .TH JUNKBUSTER 1 "v2.9.10 (alpha) Date: 2001/12/01"\r
6 \r
7 .SH NAME\r
8 \fBjunkbuster\fP\r
9 - The\r
10 Internet Junkbuster\r
11 Proxy\r
12 \s-2(TM)\s+2\r
13 .SH SYNOPSIS\r
14 \fBjunkbuster\fP\r
15 \fI\&[config_file]\fP\r
16 .br\r
17 \fBjunkbstr.exe\fP\r
18 \fI\&[config_file]\fP\r
19 (Windows)\r
20 .br\r
21 .P\r
22 If the configuration file is not specified on the command line,\r
23 \fBJunkbuster\fP will look for a file named \fIconfig\fP in the \r
24 current directory (except on Amiga where it will look for \r
25 \fIAmiTCP:db/junkbuster/config\fP and Win32 where it will try \r
26 \fIconfig.txt\fP).\r
27 \r
28 \r
29 .SH DESCRIPTION\r
30 \fBJunkbuster\fP\r
31 is an instrumentable HTTP proxy that filters the \r
32 \s-2HTTP\s0\r
33 data stream between\r
34 web servers and browsers.\r
35 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web\r
36 page content, manage access restrictions, and to discard such annoying Internet\r
37 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your\r
38 fancy.\r
39 \r
40 .SH INSTALLATION AND USE\r
41 Browsers must be configured to use \r
42 \fBJunkbuster\fP\r
43 (the default is localhost, \r
44 port 8000).\r
45 To set the \r
46 \s-2HTTP\s0\r
47 proxy in Netscape and Mozilla,\r
48 go through:\r
49 \fB\&Edit\fP;\r
50 \fB\&Preferences\fP;\r
51 \fB\&Advanced\fP;\r
52 \fB\&Proxies\fP;\r
53 \fB\&Manual Proxy Configuration\fP;\r
54 \fB\&View\fP.\r
55 .P\r
56 For Internet Explorer,\r
57 go through:\r
58 \fB\&Tools\fP;\r
59 \fB\&Internet Properties\fP;\r
60 \fB\&Connections\fP;\r
61 \fB\&LAN Settings\fP.\r
62 .P\r
63 Set the HTTP proxy location for localhost, port 8000.\r
64 The\r
65 Secure (SSL) Proxy\" ijbfaq.html#security\r
66 should also be set to the same values,\r
67 otherwise\r
68 \fB\&https:\fP\r
69 \s-2URL\s0s\r
70 won't be proxied.\r
71 \r
72 .SH CONFIGURATION\r
73 All \fBJunkbuster\fP configuration is done via the various configuarion \r
74 files. The default configuration files are: \fIconfig\fP, \r
75 \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. \r
76 On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP \r
77 by default. On Windows and OS/2, these files are in the same directory \r
78 as the \fBJunkbuster\fP executable. \r
79 .P\r
80 The name and number of configuration files has changed from previous versions,\r
81 and is subject to change as development progresses. In fact, the configuration\r
82 itself is changed and much more sophisticated. See the user-manual for a brief\r
83 explanation of all configuration options.\r
84 .P\r
85 \fBJunkbuster's\fP configuration parameters can be viewed at\r
86 \fIhttp://i.j.b./\fP. This is an internal page. In\r
87 addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can\r
88 be toggled on/off.\r
89 \r
90 .SH "SAMPLE CONFIGURATION"\r
91 .PP\r
92 A brief example of what an \fIijb.action\fP configuration might look like:\r
93 .PP\r
94 .nf\r
95 \r
96 # Define a few useful custom aliases for later use\r
97 {{alias}}\r
98 +no-cookies = +no-cookies-set +no-cookies-read\r
99 -no-cookies = -no-cookies-set -no-cookies-read\r
100 +imageblock = +block +image\r
101 \r
102 ## Default Policies (actions) ############################\r
103 { \\\r
104  -block \\\r
105  -downgrade \\\r
106  +fast-redirects \\\r
107  +filter \\\r
108  +no-compression \\\r
109  +hide-forwarded \\\r
110  +hide-from{block} \\\r
111  +hide-referer{forge} \\\r
112  -hide-user-agent \\\r
113  -image \\\r
114  +image-blocker{blank} \\\r
115  +no-cookies-keep \\\r
116  -no-cookies-read \\\r
117  -no-cookies-set \\\r
118  +no-popups \\\r
119  -vanilla-wafer \\\r
120  -wafer \\\r
121 }\r
122 /\r
123 \r
124 # Now set exceptions to the above defined policies #######\r
125 \r
126 # Sites that DO need cookies\r
127 {-no-cookies}\r
128  .redhat.com\r
129  .sun.com\r
130  .yahoo.com\r
131  .msdn.microsoft.com\r
132 \r
133 # This site requires cookies AND 'fast-redirects' on\r
134 {-no-cookies -fast-redirects}\r
135  .nytimes.com\r
136 \r
137 # Add custom headers, and turn off filtering of page source\r
138 {+add-header{X-Privacy: Yes please} #-add-header{*} \\\r
139  +add-header{X-User-Tracking: No thanks!} -filter}\r
140  privacy.net\r
141 \r
142 {+imageblock}\r
143  .adforce.imgis.com\r
144  .ad.preferences.com/image.*\r
145  .ads.web.aol.com\r
146  .ad-adex3.flycast.com\r
147  .ad.doubleclick.net\r
148  .ln.doubleclick.net\r
149  .ad.de.doubleclick.net\r
150  /.*/count\\.cgi\\?.*df=\r
151  194.221.183.22[1-7]\r
152  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
153 \r
154 # Block any URLs that match these patterns\r
155 {+block}\r
156  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
157  /.*/(plain|live|rotate)[-_.]?ads?/\r
158  /.*/(sponsor)s?[0-9]?/\r
159  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
160  /.*/adbanners/\r
161  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
162  /.*/banners?/\r
163  /.*/popupads/\r
164  /.*/advert[0-9]+\\.jpg\r
165  /ad_images/\r
166  /.*/ads/\r
167  /images/.*/.*_anim\\.gif\r
168  /rotations/ \r
169  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
170  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
171  .images.nytimes.com\r
172  .images.yahoo.com/adv/\r
173  /.*cnnstore\\.gif\r
174 \r
175 .fi\r
176 .sp\r
177 .PP\r
178 See the comments in the configuration files themselves, or the user-manual \r
179 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
180 options.\r
181 \r
182 .SH "FILES"\r
183 \fI/usr/sbin/junkbuster\fP\r
184 .br\r
185 \fI/etc/junkbuster/config\fP\r
186 .br\r
187 \fI/etc/junkbuster/ijb.action\fP\r
188 .br\r
189 \fI/etc/junkbuster/re_filterfile\fP\r
190 .br\r
191 \fI/var/log/junkbuster/logfile\fP\r
192 \r
193 .P\r
194 Various other files should be included, but may vary depending on platform \r
195 and build configuration. More documentation should be included in the local\r
196 documentation directory, though is not complete at this time.\r
197 \r
198 .SH NOTES\r
199 This is a development version of \fBJunkbuster\fP. Not all features are  \r
200 complete.\r
201 \r
202 .SH BUGS\r
203 Yes. HTTP/1.1 support is only partially implemented. See the user-manual for \r
204 how and where to report bugs.\r
205 \r
206 .SH SEE ALSO\r
207 .br\r
208 http://i.j.b./\r
209 .br\r
210 http://ijbswa.sourceforge.net/\r
211 .br\r
212 http://sourceforge.net/projects/ijbswa\r
213 .br\r
214 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
215 .br\r
216 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
217 .br\r
218 http://privacy.net/analyze/\r
219 .br\r
220 http://www.squid-cache.org/\r
221 \r
222 .SH DEVELOPMENT TEAM\r
223 .br\r
224  Stefan Waldherr \r
225 .br\r
226  Andreas Oesterhelt \r
227 .br\r
228  Jon Foster \r
229 .br\r
230  Markus Breitenbach\r
231 .br\r
232  Thomas Steudten\r
233 .br\r
234  David Schmidt\r
235 .br\r
236  Haroon Rafique\r
237 .br\r
238  Jorg Strohmayer\r
239 .br\r
240  Shamim Mohamed\r
241 .br\r
242  Sarantis Paskalis\r
243 .br\r
244  Gabriel L. Somlo\r
245 .br\r
246  John Venvertloh\r
247 .br\r
248  Hal Burgiss\r
249 \r
250 .SH COPYRIGHT AND LICENSE\r
251 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
252 Corporation. \r
253 .P\r
254 This program is free software; you can redistribute it and/or modify\r
255 it under the terms of the GNU General Public License as published by\r
256 the Free Software Foundation; either version 2 of the License, or\r
257 (at your option) any later version.\r
258 .P\r
259 This program is distributed in the hope that it will be useful,\r
260 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
261 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
262 GNU General Public License for more details.\r
263 .P\r
264 You should have received a copy of the GNU General Public License\r
265 along with this program; if not, write to the Free Software\r
266 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
267 .P\r
268 Internet Junkbuster\r
269 Proxy\r
270 is a\r
271 trademark\" legal.html#marks\r
272 of Junkbusters Corporation.\r