X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=b4ad6a3b873d08378acd05eab66b0c37718f9c55;hp=969cea2d56a1d22f8ad6c9fa990e67d420f239f5;hb=9448b3b6afaaa1ba52b6dd0995052ace74415798;hpb=d8f504084688130e8898969c8ceedd2fe6573afe
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 969cea2d..b4ad6a3b 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -13,7 +13,7 @@
-
+
@@ -36,7 +36,7 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.187 2014/06/03 10:33:59 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.203 2016/02/26 12:27:32 fabiankeil Exp $
Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/
See LICENSE.
@@ -62,7 +62,7 @@
-$Id: user-manual.sgml,v 2.187 2014/06/03 10:33:59 fabiankeil Exp $
+$Id: user-manual.sgml,v 2.203 2016/02/26 12:27:32 fabiankeil Exp $
-
Please see the section Contacting the
@@ -1078,6 +1066,29 @@ How to install the binary packages depends on your operating system:
+
+FreeBSD and ElectroBSD
+
+ To start Privoxy upon booting, add
+ "privoxy_enable='YES'" to /etc/rc.conf.
+ Privoxy will use
+ /usr/local/etc/privoxy/config as its main
+ configuration file.
+
+
+ If you installed Privoxy into a jail, the
+ paths above are relative to the jail root.
+
+
+ To start Privoxy manually, run:
+
+
+
+ # service privoxy onestart
+
+
+
+
Windows
@@ -1097,15 +1108,21 @@ Click on the &my-app; Icon to start Privoxy. If no co
-Solaris, NetBSD, FreeBSD, HP-UX and others
+Generic instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)
Example Unix startup command:
- # /usr/sbin/privoxy /etc/privoxy/config
+ # /usr/sbin/privoxy --user privoxy /etc/privoxy/config
+
+ Note that if you installed Privoxy through
+ a package manager, the package will probably contain a platform-specific
+ script or configuration file to start Privoxy
+ upon boot.
+
@@ -1121,32 +1138,21 @@ Example Unix startup command:
Mac OS X
- After downloading the privoxy software, unzip the downloaded file by
- double-clicking on the zip file icon. Then, double-click on the
- installer package icon and follow the installation process.
-
-
- The privoxy service will automatically start after a successful
- installation. In addition, the privoxy service will automatically
- start every time your computer starts up.
-
-
- To prevent the privoxy service from automatically starting when your
- computer starts up, remove or rename the folder named
- /Library/StartupItems/Privoxy.
-
-
- A simple application named Privoxy Utility has been created which
- enables administrators to easily start and stop the privoxy service.
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
- In addition, the Privoxy Utility presents a simple way for
- administrators to edit the various privoxy config files. A method
- to uninstall the software is also available.
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
+ (on OS X 10.5 and higher) or the folder named
+ /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
- An administrator username and password must be supplied in order for
- the Privoxy Utility to perform any of the tasks.
+ To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.
@@ -1402,7 +1408,7 @@ for details.
-
+Controlling Privoxy with Your Web BrowserPrivoxy's user interface can be reached through the special
@@ -1458,10 +1464,7 @@ for details.
it as a test to see whether it is Privoxy
causing the problem or not. Privoxy continues
to run as a proxy in this case, but all manipulation is disabled, i.e.
- Privoxy acts like a normal forwarding proxy. There
- is even a toggle Bookmarklet offered, so
- that you can toggle Privoxy with one click from
- your browser.
+ Privoxy acts like a normal forwarding proxy.
@@ -1870,7 +1873,7 @@ for details.
-
+Finding the Right Mix
Note that some actions, like cookie suppression
@@ -1895,7 +1898,7 @@ for details.
-
+How to Edit
The easiest way to edit the actions files is with a browser by
@@ -2216,7 +2219,7 @@ for details.
-The Path Pattern
+The Path PatternPrivoxy uses modern POSIX 1003.2
@@ -2793,7 +2796,7 @@ for details.
Type:
- Parameterized.
+ Multi-value.
@@ -2880,7 +2883,7 @@ for details.
Type:
- Parameterized.
+ Multi-value.
@@ -3631,7 +3634,7 @@ problem-host.example.com
Type:
- Parameterized.
+ Multi-value.
@@ -3843,7 +3846,7 @@ problem-host.example.com
Type:
- Parameterized.
+ Multi-value.
@@ -4160,7 +4163,7 @@ new action
Type:
- Multi-value.
+ Parameterized.
@@ -4193,6 +4196,32 @@ new action
for socks5 connections (with remote DNS resolution).
+
+
+ forward-webserver 127.0.0.1:80 to use the HTTP
+ server listening at 127.0.0.1 port 80 without adjusting the
+ request headers.
+
+
+ This makes it more convenient to use Privoxy to make
+ existing websites available as onion services as well.
+
+
+ Many websites serve content with hardcoded URLs and
+ can't be easily adjusted to change the domain based
+ on the one used by the client.
+
+
+ Putting Privoxy between Tor and the webserver (or an stunnel
+ that forwards to the webserver) allows to rewrite headers and
+ content to make client and server happy at the same time.
+
+
+ Using Privoxy for webservers that are only reachable through
+ onion addresses and whose location is supposed to be secret
+ is not recommended and should not be necessary anyway.
+
+
@@ -4215,7 +4244,8 @@ new action
If the ports are missing or invalid, default values will be used. This might change
in the future and you shouldn't rely on it. Otherwise incorrect syntax causes Privoxy
- to exit.
+ to exit. Due to design limitations, invalid parameter syntax isn't detected until the
+ action is used the first time.
Use the show-url-info CGI page
@@ -4230,15 +4260,17 @@ new action
-# Always use direct connections for requests previously tagged as
+# Use an ssh tunnel for requests previously tagged as
# User-Agent: fetch libfetch/2.0 and make sure
# resuming downloads continues to work.
+#
# This way you can continue to use Tor for your normal browsing,
# without overloading the Tor network with your FreeBSD ports updates
# or downloads of bigger files like ISOs.
+#
# Note that HTTP headers are easy to fake and therefore their
# values are as (un)trustworthy as your clients and users.
-{+forward-override{forward .} \
+{+forward-override{forward-socks5 10.0.0.2:2222 .} \
-hide-if-modified-since \
-overwrite-last-modified \
}
@@ -5368,9 +5400,15 @@ new action
filter file section.
- This action will be ignored if you use it together with
- block.
- It can be combined with
+ Requests can't be blocked and redirected at the same time,
+ applying this action together with
+ block
+ is a configuration error. Currently the request is blocked
+ and an error message logged, the behavior may change in the
+ future and result in Privoxy rejecting the action file.
+
+
+ This action can be combined with
fast-redirects{check-decoded-url}
to redirect to a decoded version of a rewritten URL.
@@ -5420,6 +5458,12 @@ search.msn.com//results\.aspx\?q=
{+redirect{s@toChange=[^&]+@toChange=bar@}}
example.com/.*toChange=(?!bar)
+# Add a shortcut to look up illumos bugs
+{+redirect{s@^http://i([0-9]+)/.*@https://www.illumos.org/issues/$1@}}
+# Redirected URL = http://i4974/
+# Redirect Destination = https://www.illumos.org/issues/4974
+i[0-9][0-9][0-9][0-9]*/
+
# Redirect remote requests for this manual
# to the local version delivered by Privoxy
{+redirect{s@^http://www@http://config@}}
@@ -5460,7 +5504,7 @@ www.privoxy.org/user-manual/
Type:
- Parameterized.
+ Multi-value.
@@ -5543,7 +5587,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
Type:
- Parameterized.
+ Multi-value.
@@ -5814,7 +5858,7 @@ TAG:^image/
-
+Summary
Note that many of these actions have the potential to cause a page to
@@ -5957,7 +6001,7 @@ hal stop here
and user.action file and see how all these pieces come together:
-
+match-all.action
Remember all actions are disabled when matching starts,
@@ -6000,7 +6044,7 @@ hal stop here
-
+default.action
@@ -6289,7 +6333,7 @@ wiki.
-user.action
+user.action
So far we are painting with a broad brush by setting general policies,
@@ -6703,7 +6747,7 @@ stupid-server.example.com/
-Filter File Tutorial
+Filter File Tutorial
Now, let's complete our foo content filter. We have already defined
the heading, but the jobs are still missing. Since all it does is to replace
@@ -7456,6 +7500,8 @@ done
EXTERNAL-FILTER: rotate-image Rotate an image by 180 degree. Test filter with limited value.
/usr/local/bin/convert - -rotate 180 -
+EXTERNAL-FILTER: citation-needed Adds a "[citation needed]" tag to an image. The coordinates may need adjustment.
+/usr/local/bin/convert - -pointsize 16 -fill white -annotate +17+418 "[citation needed]" -
@@ -7871,7 +7917,7 @@ Requests
-
+Privoxy's Internal Pages
@@ -7988,84 +8034,6 @@ Requests
-
- These may be bookmarked for quick reference. See next.
-
-
-
-
-Bookmarklets
-
- Below are some bookmarklets to allow you to easily access a
- mini version of some of Privoxy's
- special pages. They are designed for MS Internet Explorer, but should work
- equally well in Netscape, Mozilla, and other browsers which support
- JavaScript. They are designed to run directly from your bookmarks - not by
- clicking the links below (although that should work for testing).
-
-
- To save them, right-click the link and choose Add to Favorites
- (IE) or Add Bookmark (Netscape). You will get a warning that
- the bookmark may not be safe - just click OK. Then you can run the
- Bookmarklet directly from your favorites/bookmarks. For even faster access,
- you can put them on the Links bar (IE) or the Personal
- Toolbar (Netscape), and run them with a single click.
-
-
-
-
-
-
-
- Privoxy - Enable
-
-
-
-
-
- Privoxy - Disable
-
-
-
-
-
- Privoxy - Toggle Privoxy (Toggles between enabled and disabled)
-
-
-
-
-
- Privoxy- View Status
-
-
-
-
-
- Privoxy - Why?
-
-
-
-
-
-
- Credit: The site which gave us the general idea for these bookmarklets is
- www.bookmarklets.com. They
- have more information about bookmarklets.
-
-
-
-
-
@@ -8217,8 +8185,7 @@ Requests
One quick test to see if Privoxy is causing a problem
or not, is to disable it temporarily. This should be the first troubleshooting
- step. See the Bookmarklets section on a quick
- and easy way to do this (be sure to flush caches afterward!). Looking at the
+ step (be sure to flush caches afterward!). Looking at the
logs is a good idea too. (Note that both the toggle feature and logging are
enabled via config file settings, and may need to be
turned on.)