X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=8ed11aab9d3f7453a5f83e8c696211ed81d0e1db;hb=4c4af19863193dd2a1b504bcd627417e29d41b70;hp=85894e7ad791edc84ca15793671d6034a75186ef;hpb=cfa94e1bc59ff181fe557dc411f252a39605013c;p=privoxy.git
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 85894e7a..8ed11aab 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -9,13 +9,15 @@
+
-
-
+
+
+
-
-
+
+
@@ -28,15 +30,11 @@
Privoxy">
]>
- Copyright &my-copy; 2001-2013 by
- Privoxy Developers
+ Copyright &my-copy; 2001-2018 by
+ Privoxy Developers
-$Id: user-manual.sgml,v 2.161 2013/01/12 12:21:38 fabiankeil Exp $
-
@@ -99,14 +95,11 @@ Hal.
You can find the latest version of the Privoxy User Manual at http://www.privoxy.org/user-manual/.
+ url="https://www.privoxy.org/user-manual/">https://www.privoxy.org/user-manual/.
Please see the Contact section on how to
contact the developers.
-
-
-
@@ -115,7 +108,7 @@ Hal.
Introduction
This documentation is included with the current &p-status; version of
- Privoxy, v.&p-version;Privoxy, &p-version;
Since this is a &p-status; version, not all new features are well tested. This
documentation may be slightly out of sync as a result (especially with
- CVS sources). And there may be bugs, though hopefully
+ git sources).
+ And there may be bugs, though hopefully
not many!
]]>
@@ -160,7 +154,7 @@ Hal.
Privoxy is available both in convenient pre-compiled
packages for a wide range of operating systems, and as raw source code.
For most users, we recommend using the packages, which can be downloaded from our
- Privoxy Project
+ Privoxy Project
Page.
@@ -242,7 +236,6 @@ How to install the binary packages depends on your operating system:
system. Check that no Junkbuster
or Privoxy objects are in
your startup folder.
-
@@ -282,1120 +275,251 @@ How to install the binary packages depends on your operating system:
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').
-
-
- 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.
-
-
- To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
- administrator account.
-
-
-
-Installation from source
-
- To build and install the Privoxy source code on OS X you will need to obtain
- the macsetup module from the Privoxy Sourceforge CVS repository (refer to
- Sourceforge help for details of how to set up a CVS client to have read-only
- access to the repository). This module contains scripts that leverage the usual
- open-source tools (available as part of Apple's free of charge Xcode
- distribution or via the usual open-source software package managers for OS X
- (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
- and associated files. The macsetup module's README file contains complete
- instructions for its use.
-
-
- 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.
-
-
- 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').
-
-
- To manually start or stop the privoxy service, use the Privoxy Utility
- for Mac OS X (also part of the macsetup module). This application can start
- and stop the privoxy service and display its log and configuration files.
-
-
- To uninstall, run the macsetup module's uninstall.sh as sudo from an
- administrator account.
-
-
-
-
-FreeBSD
-
-
- Privoxy is part of FreeBSD's Ports Collection, you can build and install
- it with cd /usr/ports/www/privoxy; make install clean.
-
-
- If you don't use the ports, you can fetch and install
- the package with pkg_add -r privoxy.
-
-
- The port skeleton and the package can also be downloaded from the
- File Release
- Page, but there's no reason to use them unless you're interested in the
- beta releases which are only available there.
-
-
-
-
-
-
-Building from Source
-
-
- The most convenient way to obtain the Privoxy sources
- is to download the source tarball from our
- project download
- page.
-
-
-
- If you like to live on the bleeding edge and are not afraid of using
- possibly unstable development versions, you can check out the up-to-the-minute
- version directly from the
- CVS repository.
-
-
-
-
-&buildsource;
-
-
-
-
-Keeping your Installation Up-to-Date
-
-
- If you wish to receive an email notification whenever we release updates of
- Privoxy or the actions file, subscribe
- to our announce mailing list, ijbswa-announce@lists.sourceforge.net.
-
-
-
- In order not to lose your personal changes and adjustments when updating
- to the latest default.action file we strongly
- recommend that you use user.action and
- user.filter for your local
- customizations of Privoxy. See the Chapter on actions files for details.
-
-
-
-
-
-
-
-
-
-
-
-What's New in this Release
-
- Privoxy 3.0.20 is a beta release.
- The changes since 3.0.19 stable are:
-
-
-
-
-
-
- Bug fixes:
-
-
-
- Client sockets are now properly shutdown and drained before being
- closed. This fixes page truncation issues with clients that aggressively
- pipeline data on platforms that otherwise discard already written data.
- The issue mainly affected Opera users and was initially reported
- by Kevin in #3464439, szotsaki provided additional information to track
- down the cause.
-
-
-
-
- Fix latency calculation for shared connections (disabled by default).
- It was broken since their introduction in 2009. The calculated latency
- for most connections would be 0 in which case the timeout detection
- failed to account for the real latency.
-
-
-
-
- Reject URLs with invalid port. Previously they were parsed incorrectly and
- characters between the port number and the first slash were silently
- dropped as shown by curl test 187.
-
-
-
-
- The default-server-timeout and socket-timeout directives accept 0 as
- valid value.
-
-
-
-
- Fix a race condition on Windows that could cause Privoxy to become
- unresponsive after toggling it on or off through the taskbar icon.
- Reported by Tim H. in #3525694.
-
-
-
-
- Fix the compilation on Windows when configured without IPv6 support.
-
-
-
-
- Fix an assertion that could cause debug builds to abort() in case of
- socks5 connection failures with "debug 2" enabled.
-
-
-
-
- Fix an assertion that could cause debug builds to abort() if a filter
- contained nul bytes in the replacement text.
-
-
-
-
-
-
-
- General improvements:
-
-
-
- Significantly improved keep-alive support for both client and server
- connections.
-
-
-
-
- New debug log level 65536 which logs all actions that were applied to
- the request.
-
-
-
-
- New directive client-header-order to forward client headers in a
- different order than the one in which they arrived.
-
-
-
-
- New directive tolerate-pipelining to allow client-side pipelining.
- If enabled (3.0.20 beta enables it by default), Privoxy will keep
- pipelined client requests around to deal with them once the current
- request has been served.
-
-
-
-
- New --config-test option to let Privoxy exit after checking whether or not
- the configuration seems valid. The limitations noted in TODO #22 and #23
- still apply. Based on a patch by Ramkumar Chinchani.
-
-
-
-
- New limit-cookie-lifetime{} action to let cookies expire before the end
- of the session. Suggested by Rick Sykes in #1049575.
-
-
-
-
- Increase the hard-coded maximum number of actions and filter files from
- 10 to 30 (each). It doesn't significantly affect Privoxy's memory usage
- and recompiling wasn't an option for all Privoxy users that reached the
- limit.
-
-
-
-
- Add support for chunk-encoded client request bodies. Previously
- chunk-encoded request bodies weren't guaranteed to be forwarded correctly,
- so this can also be considered a bug fix although chunk-encoded request
- bodies aren't commonly used in the real world.
-
-
-
-
- Add support for Tor's optimistic-data SOCKS extension, which can reduce the
- latency for requests on newly created connections. Currently only the
- headers are sent optimistically and only if the client request has already
- been read completely which rules out requests with large bodies.
-
-
-
-
- After preventing the client from pipelining, don't signal keep-alive
- intentions. When looking at the response headers alone, it previously
- wasn't obvious from the client's perspective that no additional responses
- should be expected.
-
-
-
-
- Stop considering client sockets tainted after receving a request with body.
- It hasn't been necessary for a while now and unnecessarily causes test
- failures when using curl's test suite.
-
-
-
-
- Allow HTTP/1.0 clients to signal interest in keep-alive through the
- Proxy-Connection header. While such client are rare in the real world, it
- doesn't hurt and couple of curl tests rely on it.
-
-
-
-
- Only remove duplicated Content-Type headers when filters are enabled.
- If they are not it doesn't cause ill effects and the user might not want it.
- Downgrade the removal message to LOG_LEVEL_HEADER to clarify that it's not
- an error in Privoxy and is unlikely to cause any problems in general.
- Anonymously reported in #3599335.
-
-
-
-
- Set the socket option SO_LINGER for the client socket.
-
-
-
-
- Move several variable declarations to the beginning of their code block.
- It's required when compiling with gcc 2.95 which is still used on some
- platforms. Initial patch submitted by Simon South in #3564815.
-
-
-
-
- Optionally try to sanity-check strptime() results before trusting them.
- Broken strptime() implementations have caused problems in the past and
- the most recent offender seems to be FreeBSD's libc (standards/173421).
-
-
-
-
- When filtering is enabled, let Range headers pass if the range starts at
- the beginning. This should work around (or at least reduce ) the video
- playback issues with various Apple clients as reported by Duc in #3426305.
-
-
-
-
- Do not confuse a client hanging up with a connection time out. If a client
- closes its side of the connection without sending a request line, do not
- send the CLIENT_CONNECTION_TIMEOUT_RESPONSE, but report the condition
- properly.
-
-
-
-
- Allow closing curly braces as part of action values as long as they are
- escaped.
-
-
-
-
- On Windows, the logfile is now written before showing the GUI error
- message which blocks until the user acknowledges it.
- Reported by Adriaan in #3593603.
-
-
-
-
- Remove an unreasonable parameter limit in the CGI interface. The new
- parameter limit depends on the memory available and is currently unlikely
- to be reachable, due to other limits in both Privoxy and common clients.
- Reported by Andrew on ijbswa-users@.
-
-
-
-
- Decrease the chances of parse failures after requests with unsupported
- methods were sent to the CGI interface.
-
-
-
-
-
-
-
- Action file improvements:
-
-
-
- Remove the comment that indicated that updated default.action versions
- are released on their own.
-
-
-
-
- Block 'optimize.indieclick.com/' and 'optimized-by.rubiconproject.com/'
-
-
-
-
- Unblock 'adjamblog.wordpress.com/' and 'adjamblog.files.wordpress.com/'.
- Reported by Ryan Farmer in #3496116.
-
-
-
-
- Unblock '/.*Bugtracker'. Reported by pwhk in #3522341.
-
-
-
-
- Add test URLs for '.freebsd.org' and '.watson.org'.
-
-
-
-
- Unblock '.urbandictionary.com/popular'.
-
-
-
-
- Block '.adnxs.com/'.
-
-
-
-
- Block 'farm.plista.com/widgetdata.php'.
-
-
-
-
- Block 'rotation.linuxnewmedia.com/'.
-
-
-
-
- Block 'reklamy.sfd.pl/'. Reported by kacperdominik in #3399948.
-
-
-
-
- Block 'g.adspeed.net/'.
-
-
-
-
- Unblock 'websupport.wdc.com/'. Reported by Adam Piggot in #3577851.
-
-
-
-
- Block '/openx/www/delivery/'.
-
-
-
-
- Disable fast-redirects for '.googleapis.com/'.
-
-
-
-
- Block 'imp.double.net/'. Reported by David Bo in #3070411.
-
-
-
-
- Block 'gm-link.com/' whis is used for email tracking.
- Reported by David Bo in #1812733.
-
-
-
-
- Verify that requests to "bwp." are blocked. URL taken from #1736879
- submitted by Francois Marier.
-
-
-
-
- Block '/.*bannerid='. Reported by Adam Piggott in #2975779.
-
-
-
-
- Block 'cltomedia.info/delivery/' and '.adexprt.com/'.
- Anonymously reported in #2965254.
-
-
-
-
- Block 'de17a.com/'. Reported by David Bo in #3061472.
-
-
-
-
- Block 'oskar.tradera.com/'. Reported by David Bo in #3060596.
-
-
-
-
- Block '/scripts/webtrends\.js'. Reported by johnd16 in #3002729.
-
-
-
-
- Block requests for 'pool.*.adhese.com/'. Reported by johnd16 in #3002716.
-
-
-
-
- Update path pattern for Coremetrics and add tests.
- Pattern and URLs submitted by Adam Piggott #3168443.
-
-
-
-
- Enable +fast-redirects{check-decoded-url} for 'tr.anp.se/'.
- Reported by David Bo in #3268832.
-
-
-
-
- Unblock '.conrad.se/newsletter/banners/'. Reported by David Bo in #3413824.
-
-
-
-
- Block '.tynt.com/'. Reported by Dan Stahlke in #3421767.
-
-
-
-
- Unblock '.bbci.co.uk/radio/'. Reported by Adam Piggott in #3569603.
-
-
-
-
- Block requests to 'service.maxymiser.net/'.
- Reported by johnd16 in #3118401 (with a previous URL).
-
-
-
-
- Disable fast-redirects for Google's "let's pretend your computer is
- infected" page.
-
-
-
-
- Unblock '/.*download' to resolve actionsfile feedback #3498129.
- Submitted by Steven Kolins (soundcloud.com not working).
-
-
-
-
- Unblock '.wlxrs.com/' which is required by hotmail.com.
- Fixes #3413827 submitted by David Bo.
-
-
-
-
- Add two unblock patterns for popup radio and TV players.
- Submitted by Adam Piggott in #3596089.
-
-
-
-
-
-
-
- Filter file improvements & bug fixes:
-
-
-
- Add a referer tagger.
-
-
-
-
- Reduce the likelihood that the google filter messes up HTML-generating
- JavaScript. Reported by Zeno Kugy in #3520260.
-
-
-
-
-
-
-
- Documentation improvements:
-
-
-
- Revised all OS X sections due to new packaging module (OSXPackageBuilder).
-
-
-
-
- Update the list of supported operating systems to clarify that all Windows
- versions after 95 are expected to work and note that the platform-specific
- code for AmigaOS and QNX currently isn't maintained.
-
-
-
-
- Update 'Signals' section, the only explicitly handled signals are SIGINT,
- SIGTERM and SIGHUP.
-
-
-
-
- Add Haiku to the list of operating systems on which Privoxy is known to
- run.
-
-
-
-
- Add DragonFly to the list of BSDs on which Privoxy is known to run.
-
-
-
-
- Removed references to redhat-specific documentation set since it no longer
- exists.
-
-
-
-
- Removed references to building PDFs since we no longer do so.
-
-
-
-
- Multiple listen-address directives are supported since 3.0.18, correct the
- documentation to say so.
-
-
-
-
- Remove bogus section about long and short being preferable to int.
-
-
-
-
- Corrected some Internet JunkBuster references to Privoxy.
-
-
-
-
- Removed references to www.junkbusters.com since it is no longer
- maintained. Reported by Angelina Matson.
-
-
-
-
- Various grammar and spelling corrections
-
-
-
-
- Add a client-header-tagger{} example for disabling filtering for range
- requests.
-
-
-
-
- Correct a URL in the "Privoxy with Tor" FAQ.
-
-
-
-
- Spell 'refresh-tags' correctly. Reported by Don in #3571927.
-
-
-
-
- Sort manpage options alphabetically.
-
-
-
-
- Remove an incorrect sentence in the toggle section. The toggle state
- doesn't affect whether or not the Windows version uses the tray icon.
- Reported by Zeno Kugy in #3596395.
-
-
-
-
- Add new contributors since 3.0.19.
-
-
-
-
-
-
-
- Log message improvements:
-
-
-
- When stopping to watch a client socket due to pipelining, additionally log
- the socket number.
-
-
-
-
- Log the client socket and its condition before closing it. This makes it
- more obvious that the socket actually gets closed and should help when
- diagnosing problems like #3464439.
-
-
-
-
- In case of SOCKS5 failures, do not explicitly log the server's response.
- It hasn't helped so far and the response can already be logged by enabling
- "debug 32768" anyway. This reverts v1.81 and the follow-up bug fix v1.84.
-
-
-
-
- Relocate the connection-accepted message from listen_loop() to serve().
- This way it's printed by the thread that is actually serving the
- connection which is nice when grepping for thread ids in log files.
-
-
-
-
-
-
-
- Code cleanups:
-
-
-
- Remove compatibility layer for versions prior to 3.0 since it has been
- obsolete for more than 10 years now.
-
-
-
-
- Remove the ijb_isupper() and ijb_tolower() macros from parsers.c since
- they aren't used in this file.
-
-
-
-
- Removed the 'Functions declared include:' comment sections since they tend
- to be incomplete, incorrect and out of date and the benefit seems
- questionable.
-
-
-
-
- Various comment grammar and comprehensibility improvements.
-
-
-
-
- Remove a pointless fflush() call in chat(). Flushing all streams pretty
- much all the time for no obvious reason is ridiculous.
-
-
-
-
- Relocate ijb_isupper()'s definition to project.h and get the ijb_tolower()
- definition from there, too.
-
-
-
-
- Relocate ijb_isdigit()'s definition to project.h.
-
-
-
-
- Rename ijb_foo macros to privoxy_foo.
-
-
-
-
- Add malloc_or_die() which will allow to simplify code paths where malloc()
- failures don't need to be handled gracefully.
-
-
-
-
- Add strdup_or_die() which will allow to simplify code paths where strdup()
- failures don't need to be handled gracefully.
-
-
-
-
- Replace strdup() calls with strdup_or_die() calls where it's safe and
- simplifies the code.
-
-
-
-
- Fix white-space around parentheses.
-
-
-
-
- Add missing white-space behind if's and the following parentheses.
-
-
-
-
- Unwrap a memcpy() call in resolve_hostname_to_ip().
-
-
-
-
- Declare pcrs_get_delimiter()'s delimiters[] static const.
-
-
-
-
- Various optimisations to remove dead code and merge inefficient code
- structures for improved clarity, performance or code compactness.
-
-
-
-
- Various data type corrections.
-
-
-
-
- Change visibility of several code segments when compiling without
- FEATURE_CONNECTION_KEEP_ALIVE enabled for clarity.
-
-
-
-
- In pcrs_get_delimiter(), do not use delimiters ouside the ASCII range.
- Fixes a clang complaint.
-
-
-
-
- Fix an error message in get_last_url() nobody is supposed to see.
- Reported by Matthew Fischer in #3507301.
-
-
-
-
- Fix a typo in the no-zlib-support complaint. Patch submitted by Matthew
- Fischer in #3507304.
-
-
-
-
- Shorten ssplit()'s prototype by removing the last two arguments. We always
- want to skip empty fields and ignore leading delimiters, so having
- parameters for this only complicates the API.
-
-
-
-
- Use an enum for the type of the action value.
-
-
-
-
- Rename action_name's member takes_value to value_type as it isn't used as
- boolean.
-
-
-
-
- Turn family mismatches in match_sockaddr() into fatal errors.
-
-
-
-
- Let enlist_unique_header() verify that the caller didn't pass a header
- containing either \r or \n.
-
-
-
-
- Change the hashes used in load_config() to unsigned int. That's what
- hash_string() actually returns and using a potentiallly larger type
- is at best useless.
-
-
-
-
- Use privoxy_tolower() instead of vanilla tolower() with manual casting of
- the argument.
-
-
-
-
- Catch ssplit() failures in parse_cgi_parameters().
-
-
-
-
-
-
-
- Privoxy-Regression-Test:
-
-
-
- Add an 'Overwrite condition' directive to skip any matching tests before
- it. As it has a global scope, using it is more convenient than clowning
- around with the Ignore directive.
-
-
-
-
- Log to STDOUT instead of STDERR.
-
-
-
-
- Include the Privoxy version in the output.
-
-
-
-
- Various grammar and spelling corrections in documentation and code.
-
-
-
-
- Additional tests for range requests with filtering enabled.
-
-
-
-
- Tests with mostly invalid range request.
-
-
-
-
- Add a couple of hide-if-modified-since{} tests with different date formats.
-
-
-
-
- Cleaned up the format of the regression-tests.action file to match the
- format of default.action.
-
-
-
-
- Remove the "Copyright" line from print_version(). When using --help, every
- line of screen space matters and thus shouldn't be wasted on things the
- user doesn't care about.
-
-
-
-
-
-
-
- Privoxy-Log-Parser:
-
-
-
- Improve the --statistics performance by skipping sanity checks for input
- that shouldn't affect the results anyway. Add a --strict-checks option
- that enables some of the checks again, just in case anybody cares.
-
-
-
-
- The distribution of client requests per connection is included in
- the --statistic output.
-
-
-
-
- The --accept-unknown-messages option has been removed and the behavior
- is now the default.
-
-
-
-
- Accept and (mostly) highlight new log messages introduced with
- Privoxy 3.0.20.
-
-
-
-
-
-
-
- uagen:
-
-
-
- Bump generated Firefox version to 17.
-
-
-
-
-
-
-
- GNUmakefile improvements:
-
-
-
- The dok-tidy target no longer taints documents with a tidy-mark
-
-
-
-
- Change RA_MODE from 0664 to 0644. Suggested by Markus Dittrich in
- #3505445.
-
-
-
-
- Remove tidy's clean flag as it changes the scope of attributes.
- Link-specific colors end up being applied to all text. Reported by Adam
- Piggott in #3569551.
-
-
-
-
- Leave it up to the user whether or not smart tags are inserted.
-
-
-
-
- Let w3m itself do the line wrapping for the config file. It works better
- than fmt as it can honour pre tags causing less unintentional line breaks.
-
-
-
-
- Ditch a pointless '-r' passed to rm to delete files.
-
-
-
-
- The config-file target now requires less manual intervention and updates
- the original config.
-
-
-
-
- Change WDUMP to generate ASCII. Add WDUMP_UTF8 to allow UTF-8 in the
- AUTHORS file so the names are right.
-
-
-
-
- Stop pretending that lynx and links are supported for the documentation.
-
-
-
-
-
-
-
- configure improvements:
-
-
-
- On Haiku, do not pass -lpthread to the compiler. Haiku's pthreads
- implementation is contained in its system library, libroot, so no
- additional library needs to be searched.
- Patch submitted by Simon South in #3564815.
-
-
-
-
- Additional Haiku-specific improvements. Disable checks intended for
- multi-user systems as Haiku is presently single-user. Group Haiku-specific
- settings in their own section, following the pattern for Solaris, OS/2 and
- AmigaOS. Add additional library-related settings to remove the need for
- providing configure with custom LDFLAGS.
- Submitted by Simon South in #3574538.
- *** Version 3.0.19 Stable ***
-
-
-
-
-
-
-
- Bug fixes:
-
-
-
- Prevent a segmentation fault when de-chunking buffered content.
- It could be triggered by malicious web servers if Privoxy was
- configured to filter the content and running on a platform
- where SIZE_T_MAX isn't larger than UINT_MAX, which probably
- includes most 32-bit systems. On those platforms, all Privoxy
- versions before 3.0.19 appear to be affected.
- To be on the safe side, this bug should be presumed to allow
- code execution as proving that it doesn't seems unrealistic.
-
-
-
-
- Do not expect a response from the SOCKS4/4A server until it
- got something to respond to. This regression was introduced
- in 3.0.18 and prevented the SOCKS4/4A negotiation from working.
- Reported by qqqqqw in #3459781.
-
-
-
-
-
-
-
- General improvements:
-
-
-
- Fix an off-by-one in an error message about connect failures.
-
-
-
-
- Use a GNUMakefile variable for the webserver root directory and
- update the path. Sourceforge changed it which broke various
- web-related targets.
-
-
-
-
- Update the CODE_STATUS description.
-
-
-
-
-
-
+ 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').
+
+
+ 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.
+
+
+ To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
+ administrator account.
+
+
+
+Installation from source
+
+ To build and install the Privoxy source code on OS X you will need to obtain
+ the macsetup module from the Privoxy Sourceforge CVS repository (refer to
+ Sourceforge help for details of how to set up a CVS client to have read-only
+ access to the repository). This module contains scripts that leverage the usual
+ open-source tools (available as part of Apple's free of charge Xcode
+ distribution or via the usual open-source software package managers for OS X
+ (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
+ and associated files. The macsetup module's README file contains complete
+ instructions for its use.
+
+
+ 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.
+
+
+ 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').
+
+
+ To manually start or stop the privoxy service, use the Privoxy Utility
+ for Mac OS X (also part of the macsetup module). This application can start
+ and stop the privoxy service and display its log and configuration files.
+
+
+ To uninstall, run the macsetup module's uninstall.sh as sudo from an
+ administrator account.
+
+
+
+
+FreeBSD
+
+
+ Privoxy is part of FreeBSD's Ports Collection, you can build and install
+ it with cd /usr/ports/www/privoxy; make install clean.
+
+
+
+
+
+
+Building from Source
+
+
+ The most convenient way to obtain the Privoxy source
+ code is to download the source tarball from our
+
+ project download page,
+ or you can get the up-to-the-minute, possibly unstable, development version from
+ https://www.privoxy.org/.
+
+&buildsource;
+
+
+
+ Windows
+
+ Setup
+
+ Install the Cygwin utilities needed to build Privoxy.
+ If you have a 64 bit CPU (which most people do by now), get the
+ Cygwin setup-x86_64.exe program here
+ (the .sig file is here).
+
+
+ Run the setup program and from View / Category select:
+
+
+ Devel
+ autoconf 2.5
+ automake 1.15
+ binutils
+ cmake
+ gcc-core
+ gcc-g++
+ git
+ make
+ mingw64-i686-gcc-core
+ mingw64-i686-zlib
+ Editors
+ vim
+ Libs
+ libxslt: GNOME XSLT library (runtime)
+ Net
+ curl
+ openssh
+ Text
+ docbook-dssl
+ docbook-sgml31
+ docbook-utils
+ openjade
+ Utils
+ gnupg
+ Web
+ w3m
+
+
+
+ If you haven't already downloaded the Privoxy source code, get it now:
+
+
+ mkdir <root-dir>
+ cd <root-dir>
+ git clone https://www.privoxy.org/git/privoxy.git
+
+
+
+ Get the source code (.zip or .tar.gz) for tidy from
+
+ https://github.com/htacg/tidy-html5/releases,
+ unzip into <root-dir> and build the software:
+
+
+ cd <root-dir>
+ cd tidy-html5-x.y.z/build/cmake
+ cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local
+ make && make install
+
+
+
+ If you want to be able to make a Windows release package, get the NSIS .zip file from
+
+
+ https://sourceforge.net/projects/nsis/files/NSIS%203/
+ and extract the NSIS directory to privoxy/windows.
+ Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg:
+
+
+# Path to NSIS
+MAKENSIS = ./nsis/makensis.exe
+
+
+
+
+ Build
+
+
+ To build just the Privoxy executable and not the whole installation package, do:
+
+
+ cd <root-dir>/privoxy
+ ./windows/MYconfigure && make
+
+
+
+ Privoxy uses the GNU Autotools
+ for building software, so the process is:
+
+
+ $ autoheader # creates config.h.in
+ $ autoconf # uses config.h.in to create the configure shell script
+ $ ./configure [options] # creates GNUmakefile
+ $ make [options] # builds the program
+
+
+
+ The usual configure options for building a native Windows application under cygwin are
+
+
+
+ --host=i686-w64-mingw32
+ --enable-mingw32
+ --enable-zlib
+ --enable-static-linking
+ --disable-pthread
+ --disable-dynamic-pcre
+
+
+
+ You can set the CFLAGS and LDFLAGS envars before
+ running configure to set compiler and linker flags. For example:
+
+
+
+ $ export CFLAGS="-O2" # set gcc optimization level
+ $ export LDFLAGS="-Wl,--nxcompat" # Enable DEP
+ $ ./configure --host=i686-w64-mingw32 --enable-mingw32 --enable-zlib \
+ > --enable-static-linking --disable-pthread --disable-dynamic-pcre
+ $ make # build Privoxy
+
+
+
+ See the Developer's Manual
+ for building a Windows release package.
+
+
+
+
+
+
+
+
+Keeping your Installation Up-to-Date
+
+
+ If you wish to receive an email notification whenever we release updates of
+ Privoxy or the actions file, subscribe
+ to our announce mailing list, privoxy-announce@lists.privoxy.org.
+
+
+
+ In order not to lose your personal changes and adjustments when updating
+ to the latest default.action file we strongly
+ recommend that you use user.action and
+ user.filter for your local
+ customizations of Privoxy. See the Chapter on actions files for details.
+
+
+
+
+
+
+
+
+
+
+
+What's New in this Release
+
+&changelog;
@@ -1407,7 +531,6 @@ How to install the binary packages depends on your operating system:
versions of Privoxy:
-
@@ -1438,12 +561,6 @@ How to install the binary packages depends on your operating system:
files, thinking you will want to do that yourself.
-
-
- standard.action has been merged into
- the default.action file.
-
-
In the default configuration only fatal errors are logged now.
@@ -1498,11 +615,9 @@ How to install the binary packages depends on your operating system:
that filtering does not work on compressed pages, so if you use, or want to
use, filtering, you will need to force compression off. Example:
-
{ +filter{google} +prevent-compression }
.google.
-
Or if you use a number of filters, or filter many sites, you may just want
to turn off compression for all sites in
@@ -1530,14 +645,13 @@ How to install the binary packages depends on your operating system:
-->
-Quickstart to Using Privoxy
-
+
@@ -1622,18 +736,6 @@ How to install the binary packages depends on your operating system:
-
-
Please see the section Contacting the
@@ -1649,7 +751,6 @@ How to install the binary packages depends on your operating system:
-
@@ -1726,7 +827,6 @@ How to install the binary packages depends on your operating system:
set-image-blocker:
-
@@ -1801,7 +901,6 @@ How to install the binary packages depends on your operating system:
-
Advanced users will eventually want to explore &my-app;
@@ -1847,7 +946,6 @@ How to install the binary packages depends on your operating system:
A quick and simple step by step example:
-
@@ -1871,7 +969,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -1917,7 +1013,6 @@ How to install the binary packages depends on your operating system:
-
This is a very crude and simple example. There might be good reasons to use a
@@ -1965,7 +1060,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -1986,7 +1079,6 @@ How to install the binary packages depends on your operating system:
Tools -> Options -> Advanced -> Network ->Connection -> Settings
-
@@ -1995,7 +1087,6 @@ How to install the binary packages depends on your operating system:
Edit -> Preferences -> General -> Connection Settings -> Manual Proxy Configuration
-
@@ -2009,7 +1100,6 @@ How to install the binary packages depends on your operating system:
Edit -> Preferences -> Advanced -> Proxies -> HTTP Proxy
-
@@ -2029,7 +1119,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -2061,41 +1149,38 @@ How to install the binary packages depends on your operating system:
directory. Except on Win32 where it will try config.txt.
-
-Red Hat and Fedora
+
+Debian
- A default Red Hat installation may not start &my-app; upon boot. It will use
- the file /etc/privoxy/config as its main configuration
+ We use a script. Note that Debian typically starts &my-app; upon booting per
+ default. It will use the file
+ /etc/privoxy/config as its main configuration
file.
-
- # /etc/rc.d/init.d/privoxy start
+ # /etc/init.d/privoxy start
-
+
+
+
+FreeBSD and ElectroBSD
- Or ...
+ 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.
-
- # service privoxy start
-
+ If you installed Privoxy into a jail, the
+ paths above are relative to the jail root.
-
-
-
-Debian
- We use a script. Note that Debian typically starts &my-app; upon booting per
- default. It will use the file
- /etc/privoxy/config as its main configuration
- file.
+ To start Privoxy manually, run:
-
- # /etc/init.d/privoxy start
+ # service privoxy onestart
-
@@ -2117,14 +1202,18 @@ 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.
@@ -2141,71 +1230,24 @@ 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.
-
-
- 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.
+ 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.
- An administrator username and password must be supplied in order for
- the Privoxy Utility to perform any of the tasks.
+ 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').
-
-
-
-
-AmigaOS
- Start Privoxy (with RUN <>NIL:) in your
- startnet script (AmiTCP), in
- s:user-startup (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx).
- Privoxy will automatically quit when you quit your
- TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
- Privoxy is still running).
+ 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.
-
-Gentoo
-
- A script is again used. It will use the file /etc/privoxy/config
- as its main configuration file.
-
-
-
- /etc/init.d/privoxy start
-
-
-
- Note that Privoxy is not automatically started at
- boot time by default. You can change this with the rc-update
- command.
-
-
-
- rc-update add privoxy default
-
-
-
-
+Controlling Privoxy with Your Web BrowserPrivoxy's user interface can be reached through the special
@@ -2465,14 +1506,12 @@ for details.
(shortcut: http://p.p/),
which is a built-in page and works without Internet access.
You will see the following section:
-
-
+ Privoxy Menu
-
▪ View & change the current configuration
@@ -2491,7 +1530,7 @@ for details.
▪ Documentation
+ url="https://www.privoxy.org/&p-version;/user-manual/">Documentation
@@ -2513,10 +1552,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.
@@ -2539,9 +1575,9 @@ for details.
Configuration Files Overview
- For Unix, *BSD and Linux, all configuration files are located in
- /etc/privoxy/ by default. For MS Windows, OS/2, and
- AmigaOS these are all in the same directory as the
+ For Unix, *BSD and GNU/Linux, all configuration files are located in
+ /etc/privoxy/ by default. For MS Windows and OS/2
+ these are all in the same directory as the
Privoxy executable.
@@ -2553,13 +1589,12 @@ for details.
principle configuration files are:
-
The main configuration file is named config
- on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt
+ on GNU/Linux, Unix, BSD, and OS/2, and config.txt
on Windows. This is a required file.
@@ -2611,7 +1646,6 @@ for details.
-
The syntax of the configuration and filter files may change between different
@@ -2697,7 +1731,6 @@ for details.
are three action files included with Privoxy with
differing purposes:
-
@@ -2760,7 +1793,6 @@ for details.
The default profiles, and their associated actions, as pre-defined in
default.action are:
-
Default Configurations
@@ -2878,11 +1910,9 @@ for details.