X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=ef21bd299b4a97f7363d096416ed4b4f83bcf755;hp=68673ad8fc7390fd6c75276359f24b9f10c42a22;hb=f6d1a7ca82613239a15439cc9b3613750d5f55c5;hpb=4ca1b3964ffd8d2ac27cf2a9f4de9bb7ac67259e
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 68673ad8..ef21bd29 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -11,11 +11,11 @@
-
-
+
+
-
-
+
+
@@ -34,9 +34,9 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 2.145 2011/12/26 17:04:19 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.159 2013/01/09 15:03:06 fabiankeil Exp $
- Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
@@ -55,12 +55,12 @@
- Copyright &my-copy; 2001-2011 by
+ Copyright &my-copy; 2001-2013 by
Privoxy Developers
-$Id: user-manual.sgml,v 2.145 2011/12/26 17:04:19 fabiankeil Exp $
+$Id: user-manual.sgml,v 2.159 2013/01/09 15:03:06 fabiankeil Exp $Mac OS X
- Unzip the downloaded file (you can either double-click on the zip file
- icon from the Finder, or from the desktop if you downloaded it there).
- Then, double-click on the package installer icon and follow the
- installation process.
+ Installation instructions for the OS X platform depend upon whether
+ you downloaded a ready-built installation package (.pkg or .mpkg) or have
+ downloaded the source code.
+
+
+
+Installation from ready-built package
+
+ The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
+ .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
+ installation will start; double-clicking the latter will unzip the .mpkg file
+ which can then be double-clicked to commence the installation.
+
+
+ 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 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.
- The privoxy service will automatically start after a successful
- installation (in addition to 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.
+ 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. This application controls the privoxy service (e.g.
- starting and stopping the service as well as uninstalling the software).
+ 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.
@@ -402,13 +454,6 @@ How to install the binary packages depends on your operating system:
Keeping your Installation Up-to-Date
-
- As user feedback comes in and development continues, we will make updated versions
- of both the main actions file (as a separate
- package) and the software itself (including the actions file) available for
- download.
-
If you wish to receive an email notification whenever we release updates of
@@ -2388,6 +2433,27 @@ must find a better place for this paragraph
+
+
+ --config-test
+
+
+ Exit after loading the configuration files before binding to
+ the listen address. The exit code signals whether or not the
+ configuration files have been successfully loaded.
+
+
+ If the exit code is 1, at least one of the configuration files
+ is invalid, if it is 0, all the configuration files have been
+ successfully loaded (but may still contain errors that can
+ currently only be detected at run time).
+
+
+ This option doesn't affect the log setting, combination with
+ --no-daemon is recommended if a configured
+ log file shouldn't be used.
+
+ --version
@@ -3899,7 +3965,7 @@ for details.
and use their output as input.
- If the request URL gets changed, &my-app; will detect that and use the new
+ If the request URI gets changed, &my-app; will detect that and use the new
one. This can be used to rewrite the request destination behind the client's
back, for example to specify a Tor exit relay for certain requests.
@@ -3921,7 +3987,7 @@ for details.
{+client-header-filter{hide-tor-exit-notation}}
/
-
+
@@ -4015,6 +4081,22 @@ TAG:^User-Agent: fetch libfetch/
TAG:^User-Agent: Ubuntu APT-HTTP/
TAG:^User-Agent: MPlayer/
+
+
+
+# Tag all requests with the Range header set
+{+client-header-tagger{range-requests}}
+/
+
+# Disable filtering for the tagged requests.
+#
+# With filtering enabled Privoxy would remove the Range headers
+# to be able to filter the whole response. The downside is that
+# it prevents clients from resuming downloads or skipping over
+# parts of multimedia files.
+{-filter -deanimate-gifs}
+TAG:^RANGE-REQUEST$
+
@@ -5989,6 +6071,94 @@ new action
+
+
+
+limit-cookie-lifetime
+
+
+
+ Typical use:
+
+ Limit the lifetime of HTTP cookies to a couple of minutes or hours.
+
+
+
+
+ Effect:
+
+
+ Overwrites the expires field in Set-Cookie server headers if it's above the specified limit.
+
+
+
+
+
+ Type:
+
+
+ Parameterized.
+
+
+
+
+ Parameter:
+
+
+ The lifetime limit in minutes, or 0.
+
+
+
+
+
+ Notes:
+
+
+ This action reduces the lifetime of HTTP cookies coming from the
+ server to the specified number of minutes, starting from the time
+ the cookie passes Privoxy.
+
+
+ Cookies with a lifetime below the limit are not modified.
+ The lifetime of session cookies is set to the specified limit.
+
+
+ The effect of this action depends on the server.
+
+
+ In case of servers which refresh their cookies with each response
+ (or at least frequently), the lifetime limit set by this action
+ is updated as well.
+ Thus, a session associated with the cookie continues to work with
+ this action enabled, as long as a new request is made before the
+ last limit set is reached.
+
+
+ However, some servers send their cookies once, with a lifetime of several
+ years (the year 2037 is a popular choice), and do not refresh them
+ until a certain event in the future, for example the user logging out.
+ In this case this action may limit the absolute lifetime of the session,
+ even if requests are made frequently.
+
+
+ If the parameter is 0, this action behaves like
+ session-cookies-only.
+
+
+
+
+
+ Example usages:
+
+
+ +limit-cookie-lifetime{60}
+
+
+
+
+
+
+
prevent-compression
@@ -6245,6 +6415,10 @@ new action
either provided as parameter, or derived by applying a
single pcrs command to the original URL.
+
+ The syntax for pcrs commands is documented in the
+ filter file section.
+
This action will be ignored if you use it together with
block.
@@ -7865,7 +8039,7 @@ pre-defined filters for your convenience:
- refresh tags
+ refresh-tags
Disable any refresh tags if the interval is greater than nine seconds (so
@@ -9439,1015 +9613,6 @@ In file: user.action [ View ][ Edit ] style.
- - Small fixes in the actions chapter
- - Small clarifications in the quickstart to ad blocking
- - Removed from s since the new doc CSS
- renders them red (bad in TOC).
-
- Revision 1.120 2002/05/23 19:16:43 roro
- Correct Debian specials (installation and startup).
-
- Revision 1.119 2002/05/22 17:17:05 oes
- Added Security hint
-
- Revision 1.118 2002/05/21 04:54:55 hal9
- -New Section: Quickstart to Ad Blocking
- -Reformat Actions Anatomy to match new CGI layout
-
- Revision 1.117 2002/05/17 13:56:16 oes
- - Reworked & extended Templates chapter
- - Small changes to Regex appendix
- - #included authors.sgml into (C) and hist chapter
-
- Revision 1.116 2002/05/17 03:23:46 hal9
- Fixing merge conflict in Quickstart section.
-
- Revision 1.115 2002/05/16 16:25:00 oes
- Extended the Filter File chapter & minor fixes
-
- Revision 1.114 2002/05/16 09:42:50 oes
- More ulink->link, added some hints to Quickstart section
-
- Revision 1.113 2002/05/15 21:07:25 oes
- Extended and further commented the example actions files
-
- Revision 1.112 2002/05/15 03:57:14 hal9
- Spell check. A few minor edits here and there for better syntax and
- clarification.
-
- Revision 1.111 2002/05/14 23:01:36 oes
- Fixing the fixes
-
- Revision 1.110 2002/05/14 19:10:45 oes
- Restored alphabetical order of actions
-
- Revision 1.109 2002/05/14 17:23:11 oes
- Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs
-
- Revision 1.108 2002/05/14 15:29:12 oes
- Completed proofreading the actions chapter
-
- Revision 1.107 2002/05/12 03:20:41 hal9
- Small clarifications for 127.0.0.1 vs localhost for listen-address since this
- apparently an important distinction for some OS's.
-
- Revision 1.106 2002/05/10 01:48:20 hal9
- This is mostly proposed copyright/licensing additions and changes. Docs
- are still GPL, but licensing and copyright are more visible. Also, copyright
- changed in doc header comments (eliminate references to JB except FAQ).
-
- Revision 1.105 2002/05/05 20:26:02 hal9
- Sorting out license vs copyright in these docs.
-
- Revision 1.104 2002/05/04 08:44:45 swa
- bumped version
-
- Revision 1.103 2002/05/04 00:40:53 hal9
- -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in.
- -Some minor additions to Quickstart.
-
- Revision 1.102 2002/05/03 17:46:00 oes
- Further proofread & reactivated short build instructions
-
- Revision 1.101 2002/05/03 03:58:30 hal9
- Move the user-manual config directive to top of section. Add note about
- Privoxy needing read permissions for configs, and write for logs.
-
- Revision 1.100 2002/04/29 03:05:55 hal9
- Add clarification on differences of new actions files.
-
- Revision 1.99 2002/04/28 16:59:05 swa
- more structure in starting section
-
- Revision 1.98 2002/04/28 05:43:59 hal9
- This is the break up of configuration.html into multiple files. This
- will probably break links elsewhere :(
-
- Revision 1.97 2002/04/27 21:04:42 hal9
- -Rewrite of Actions File example.
- -Add section for user-manual directive in config.
-
- Revision 1.96 2002/04/27 05:32:00 hal9
- -Add short section to Filter Files to tie in with +filter action.
- -Start rewrite of examples in Actions Examples (not finished).
-
- Revision 1.95 2002/04/26 17:23:29 swa
- bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
-
- Revision 1.94 2002/04/26 05:24:36 hal9
- -Add most of Andreas suggestions to Chain of Events section.
- -A few other minor corrections and touch up.
-
- Revision 1.92 2002/04/25 18:55:13 hal9
- More catchups on new actions files, and new actions names.
- Other assorted cleanups, and minor modifications.
-
- Revision 1.91 2002/04/24 02:39:31 hal9
- Add 'Chain of Events' section.
-
- Revision 1.90 2002/04/23 21:41:25 hal9
- Linuxconf is deprecated on RH, substitute chkconfig.
-
- Revision 1.89 2002/04/23 21:05:28 oes
- Added hint for startup on Red Hat
-
- Revision 1.88 2002/04/23 05:37:54 hal9
- Add AmigaOS install stuff.
-
- Revision 1.87 2002/04/23 02:53:15 david__schmidt
- Updated Mac OS X installation section
- Added a few English tweaks here an there
-
- Revision 1.86 2002/04/21 01:46:32 hal9
- Re-write actions section.
-
- Revision 1.85 2002/04/18 21:23:23 hal9
- Fix ugly typo (mine).
-
- Revision 1.84 2002/04/18 21:17:13 hal9
- Spell Redhat correctly (ie Red Hat). A few minor grammar corrections.
-
- Revision 1.83 2002/04/18 18:21:12 oes
- Added RPM install detail
-
- Revision 1.82 2002/04/18 12:04:50 oes
- Cosmetics
-
- Revision 1.81 2002/04/18 11:50:24 oes
- Extended Install section - needs fixing by packagers
-
- Revision 1.80 2002/04/18 10:45:19 oes
- Moved text to buildsource.sgml, renamed some filters, details
-
- Revision 1.79 2002/04/18 03:18:06 hal9
- Spellcheck, and minor touchups.
-
- Revision 1.78 2002/04/17 18:04:16 oes
- Proofreading part 2
-
- Revision 1.77 2002/04/17 13:51:23 oes
- Proofreading, part one
-
- Revision 1.76 2002/04/16 04:25:51 hal9
- -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section.
- -Note about proxy may need requests to re-read config files.
-
- Revision 1.75 2002/04/12 02:08:48 david__schmidt
- Remove OS/2 building info... it is already in the developer-manual
-
- Revision 1.74 2002/04/11 00:54:38 hal9
- Add small section on submitting actions.
-
- Revision 1.73 2002/04/10 18:45:15 swa
- generated
-
- Revision 1.72 2002/04/10 04:06:19 hal9
- Added actions feedback to Bookmarklets section
-
- Revision 1.71 2002/04/08 22:59:26 hal9
- Version update. Spell chkconfig correctly :)
-
- Revision 1.70 2002/04/08 20:53:56 swa
- ?
-
- Revision 1.69 2002/04/06 05:07:29 hal9
- -Add privoxy-man-page.sgml, for man page.
- -Add authors.sgml for AUTHORS (and p-authors.sgml)
- -Reworked various aspects of various docs.
- -Added additional comments to sub-docs.
-
- Revision 1.68 2002/04/04 18:46:47 swa
- consistent look. reuse of copyright, history et. al.
-
- Revision 1.67 2002/04/04 17:27:57 swa
- more single file to be included at multiple points. make maintaining easier
-
- Revision 1.66 2002/04/04 06:48:37 hal9
- Structural changes to allow for conditional inclusion/exclusion of content
- based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
- definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
- eventually be set by Makefile.
- More boilerplate text for use across multiple docs.
-
- Revision 1.65 2002/04/03 19:52:07 swa
- enhance squid section due to user suggestion
-
- Revision 1.64 2002/04/03 03:53:43 hal9
- A few minor bug fixes, and touch ups. Ready for review.
-
- Revision 1.63 2002/04/01 16:24:49 hal9
- Define entities to include boilerplate text. See doc/source/*.
-
- Revision 1.62 2002/03/30 04:15:53 hal9
- - Fix privoxy.org/config links.
- - Paste in Bookmarklets from Toggle page.
- - Move Quickstart nearer top, and minor rework.
-
- Revision 1.61 2002/03/29 01:31:08 hal9
- Minor update.
-
- Revision 1.60 2002/03/27 01:57:34 hal9
- Added more to Anatomy section.
-
- Revision 1.59 2002/03/27 00:54:33 hal9
- Touch up intro for new name.
-
- Revision 1.58 2002/03/26 22:29:55 swa
- we have a new homepage!
-
- Revision 1.57 2002/03/24 20:33:30 hal9
- A few minor catch ups with name change.
-
- Revision 1.56 2002/03/24 16:17:06 swa
- configure needs to be generated.
-
- Revision 1.55 2002/03/24 16:08:08 swa
- we are too lazy to make a block-built
- privoxy logo. hence removed the option.
-
- Revision 1.54 2002/03/24 15:46:20 swa
- name change related issue.
-
- Revision 1.53 2002/03/24 11:51:00 swa
- name change. changed filenames.
-
- Revision 1.52 2002/03/24 11:01:06 swa
- name change
-
- Revision 1.51 2002/03/23 15:13:11 swa
- renamed every reference to the old name with foobar.
- fixed "application foobar application" tag, fixed
- "the foobar" with "foobar". left junkbustser in cvs
- comments and remarks to history untouched.
-
- Revision 1.50 2002/03/23 05:06:21 hal9
- Touch up.
-
- Revision 1.49 2002/03/21 17:01:05 hal9
- New section in Appendix.
-
- Revision 1.48 2002/03/12 06:33:01 hal9
- Catching up to Andreas and re_filterfile changes.
-
- Revision 1.47 2002/03/11 13:13:27 swa
- correct feedback channels
-
- Revision 1.46 2002/03/10 00:51:08 hal9
- Added section on JB internal pages in Appendix.
-
- Revision 1.45 2002/03/09 17:43:53 swa
- more distros
-
- Revision 1.44 2002/03/09 17:08:48 hal9
- New section on Jon's actions file editor, and move some stuff around.
-
- Revision 1.43 2002/03/08 00:47:32 hal9
- Added imageblock{pattern}.
-
- Revision 1.42 2002/03/07 18:16:55 swa
- looks better
-
- Revision 1.41 2002/03/07 16:46:43 hal9
- Fix a few markup problems for jade.
-
- Revision 1.40 2002/03/07 16:28:39 swa
- provide correct feedback channels
-
- Revision 1.39 2002/03/06 16:19:28 hal9
- Note on perceived filtering slowdown per FR.
-
- Revision 1.38 2002/03/05 23:55:14 hal9
- Stupid I did it again. Double hyphen in comment breaks jade.
-
- Revision 1.37 2002/03/05 23:53:49 hal9
- jade barfs on '- -' embedded in comments. - -user option broke it.
-
- Revision 1.36 2002/03/05 22:53:28 hal9
- Add new - - user option.
-
- Revision 1.35 2002/03/05 00:17:27 hal9
- Added section on command line options.
-
- Revision 1.34 2002/03/04 19:32:07 oes
- Changed default port to 8118
-
- Revision 1.33 2002/03/03 19:46:13 hal9
- Emphasis on where/how to report bugs, etc
-
- Revision 1.32 2002/03/03 09:26:06 joergs
- AmigaOS changes, config is now loaded from PROGDIR: instead of
- AmiTCP:db/junkbuster/ if no configuration file is specified on the
- command line.
-
- Revision 1.31 2002/03/02 22:45:52 david__schmidt
- Just tweaking
-
- Revision 1.30 2002/03/02 22:00:14 hal9
- Updated 'New Features' list. Ran through spell-checker.
-
- Revision 1.29 2002/03/02 20:34:07 david__schmidt
- Update OS/2 build section
-
- Revision 1.28 2002/02/24 14:34:24 jongfoster
- Formatting changes. Now changing the doctype to DocBook XML 4.1
- will work - no other changes are needed.
-
- Revision 1.27 2002/01/11 14:14:32 hal9
- Added a very short section on Templates
-
- Revision 1.26 2002/01/09 20:02:50 hal9
- Fix bug re: auto-detect config file changes.
-
- Revision 1.25 2002/01/09 18:20:30 hal9
- Touch ups for *.action files.
-
- Revision 1.24 2001/12/02 01:13:42 hal9
- Fix typo.
-
- Revision 1.23 2001/12/02 00:20:41 hal9
- Updates for recent changes.
-
- Revision 1.22 2001/11/05 23:57:51 hal9
- Minor update for startup now daemon mode.
-
- Revision 1.21 2001/10/31 21:11:03 hal9
- Correct 2 minor errors
-
- Revision 1.18 2001/10/24 18:45:26 hal9
- *** empty log message ***
-
- Revision 1.17 2001/10/24 17:10:55 hal9
- Catching up with Jon's recent work, and a few other things.
-
- Revision 1.16 2001/10/21 17:19:21 swa
- wrong url in documentation
-
- Revision 1.15 2001/10/14 23:46:24 hal9
- Various minor changes. Fleshed out SEE ALSO section.
-
- Revision 1.13 2001/10/10 17:28:33 hal9
- Very minor changes.
-
- Revision 1.12 2001/09/28 02:57:04 hal9
- Ditto :/
-
- Revision 1.11 2001/09/28 02:25:20 hal9
- Ditto.
-
- Revision 1.9 2001/09/27 23:50:29 hal9
- A few changes. A short section on regular expression in appendix.
-
- Revision 1.8 2001/09/25 00:34:59 hal9
- Some additions, and re-arranging.
-
- Revision 1.7 2001/09/24 14:31:36 hal9
- Diddling.
-
- Revision 1.6 2001/09/24 14:10:32 hal9
- Including David's OS/2 installation instructions.
-
- Revision 1.2 2001/09/13 15:27:40 swa
- cosmetics
-
- Revision 1.1 2001/09/12 15:36:41 swa
- source files for junkbuster documentation
-
- Revision 1.3 2001/09/10 17:43:59 swa
- first proposal of a structure.
-
- Revision 1.2 2001/06/13 14:28:31 swa
- docs should have an author.
-
- Revision 1.1 2001/06/13 14:20:37 swa
- first import of project's documentation for the webserver.
-
-->
</article>