From b3f59b0454830df19485fd6a66a802d7ec57799e Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Fri, 18 Jul 2014 10:19:46 +0000 Subject: [PATCH] Regenerate docs --- AUTHORS | 4 ++ INSTALL | 6 +-- README | 44 ++++++++++----- doc/webserver/faq/contact.html | 22 ++++++-- doc/webserver/faq/copyright.html | 4 +- doc/webserver/faq/index.html | 11 ++-- doc/webserver/user-manual/actions-file.html | 59 ++++++++++++++++----- doc/webserver/user-manual/appendix.html | 28 +++++----- doc/webserver/user-manual/config.html | 16 +++--- doc/webserver/user-manual/contact.html | 22 ++++++-- doc/webserver/user-manual/filter-file.html | 8 ++- doc/webserver/user-manual/index.html | 21 ++++---- 12 files changed, 173 insertions(+), 72 deletions(-) diff --git a/AUTHORS b/AUTHORS index fb7ec691..739fae45 100644 --- a/AUTHORS +++ b/AUTHORS @@ -41,6 +41,7 @@ Thanks to the many people who have tested Privoxy, reported bugs, provided patches, made suggestions or contributed in some way. These include (in alphabetical order): + Anatoly Arzhnikov Ken Arromdee Natxo Asenjo Devin Bayer @@ -51,6 +52,7 @@ alphabetical order): Reiner Buehl Andrew J. Caines Clifford Caoile + Edward Carrel Wan-Teh Chang Ramkumar Chinchani Billy Crook @@ -115,8 +117,10 @@ alphabetical order): Spinor S. Peter Thoenen Martin Thomas + Reuben Thomas Bobby G. Vinyard Jochen Voss + David Wagner Glenn Washburn Song Weijia Jörg Weinmann diff --git a/INSTALL b/INSTALL index f7763cf1..4dd449b0 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $ + * File : $Source: /cvsroot/ijbswa/current/INSTALL,v $ * * Purpose : INSTALL file to help with installing from source. * @@ -40,8 +40,8 @@ compiler like gcc are required. When building from a source tarball, first unpack the source: - tar xzvf privoxy-3.0.21-stable-src.tar.gz - cd privoxy-3.0.21-stable + tar xzvf privoxy-3.0.22-beta-src.tar.gz + cd privoxy-3.0.22-beta For retrieving the current CVS sources, you'll need a CVS client installed. Note that sources from CVS are typically development quality, and may not be diff --git a/README b/README index 7e8331a4..cdb1a5f6 100644 --- a/README +++ b/README @@ -32,8 +32,9 @@ * *********************************************************************/ -This README is included with Privoxy 3.0.21. See http://www.privoxy.org/ for -more information. The current code maturity level is "stable". +This README is included with the development version of Privoxy 3.0.22. See +http://www.privoxy.org/ for more information. The current code maturity level +is "UNRELEASED", but seems stable to us :). ------------------------------------------------------------------------------- @@ -104,16 +105,22 @@ try it with FTP or other protocols for the simple reason it does not work. The actions list can be configured via the web interface accessed via http:// p.p/, as well other options. +All configuration files are subject to unannounced changes during the +development process. + ------------------------------------------------------------------------------- 5. DOCUMENTATION -There should be documentation in the 'doc' subdirectory. In particular, see the -User Manual there, the FAQ, and those interested in Privoxy development, should -look at developer-manual. +There should be documentation in the 'doc' subdirectory, but it may not be +completed at this point. In particular, see the User Manual there, the FAQ, and +those interested in Privoxy development, should look at developer-manual. -The source and configuration files are all well commented. The main -configuration files are: 'config', 'default.action', and 'default.filter'. +The most up to date source of information on the current development version, +may still be either comments in the source code, or the included configuration +files. The source and configuration files are all well commented. The main +configuration files are: 'config', 'default.action', and 'default.filter' in +the top-level source directory. Included documentation may vary according to platform and packager. All documentation is posted on http://www.privoxy.org, in case you don't have it, @@ -266,7 +273,8 @@ and you won't see them. function properly due to one Privoxy "action" or another being turned "on". * "Bugs" in the programming code that makes up Privoxy, such as that might - cause a crash. + cause a crash. Documentation issues, for example spelling errors and + unclear descriptions, are bugs, too. ------------------------------------------------------------------------------- @@ -285,8 +293,8 @@ available from our the files section of our project page. 6.3.2. Reporting Bugs -Please report all bugs through our bug tracker: http://sourceforge.net/tracker -/?group_id=11118&atid=111118. +Please report bugs that aren't security issues through our bug tracker: http:// +sourceforge.net/tracker/?group_id=11118&atid=111118. Before doing so, please make sure that the bug has not already been submitted and observe the additional hints at the top of the submit form. If already @@ -295,7 +303,19 @@ help to solve the issue. ------------------------------------------------------------------------------- -6.4. Request New Features +6.4. Reporting security problems + +If you discovered a security problem or merely suspect that a bug might be a +security issue, please mail Fabian Keil (OpenPGP +fingerprint: 4F36 C17F 3816 9136 54A1 E850 6918 2291 8BA2 371C). + +Usually you should get a response within a day, otherwise it's likely that +either your mail or the response didn't make it. If that happens, please mail +to the developer list to request a status update. + +------------------------------------------------------------------------------- + +6.5. Request New Features You are welcome to submit ideas on new features or other proposals for improvement through our feature request tracker at http://sourceforge.net/ @@ -303,7 +323,7 @@ tracker/?atid=361118&group_id=11118. ------------------------------------------------------------------------------- -6.5. Mailing Lists +6.6. Mailing Lists If you prefer to communicate through email, instead of using a web interface, feel free to use one of the mailing lists. To discuss issues that haven't been diff --git a/doc/webserver/faq/contact.html b/doc/webserver/faq/contact.html index 57dca029..730fdcab 100644 --- a/doc/webserver/faq/contact.html +++ b/doc/webserver/faq/contact.html @@ -292,7 +292,8 @@

6.3.2. Reporting Bugs

-

Please report all bugs through our bug tracker: Please report bugs that aren't security issues through our bug + tracker: http://sourceforge.net/tracker/?group_id=11118&atid=111118.

@@ -308,7 +309,22 @@
-

6.4. +

6.4. + Reporting security problems

+ +

If you discovered a security problem or merely suspect that a bug + might be a security issue, please mail Fabian Keil + <fk@fabiankeil.de> (OpenPGP fingerprint: 4F36 C17F 3816 9136 54A1 + E850 6918 2291 8BA2 371C).

+ +

Usually you should get a response within a day, otherwise it's + likely that either your mail or the response didn't make it. If that + happens, please mail to the developer list to request a status + update.

+

+ +
+

6.5. Request New Features

You are welcome to submit ideas on new features or other proposals @@ -318,7 +334,7 @@

-

6.5. +

6.6. Mailing Lists

If you prefer to communicate through email, instead of using a web diff --git a/doc/webserver/faq/copyright.html b/doc/webserver/faq/copyright.html index 3e445e96..38f29b73 100644 --- a/doc/webserver/faq/copyright.html +++ b/doc/webserver/faq/copyright.html @@ -55,7 +55,7 @@ "APPLICATION">Privoxy.

-

7.1. License

+

7.1. License

Privoxy is free software; you can redistribute it and/or modify it under the terms of the

-

7.2. History

+

7.2. History

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and Junkbusters Corporation. diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html index eb7102db..0f486469 100644 --- a/doc/webserver/faq/index.html +++ b/doc/webserver/faq/index.html @@ -504,10 +504,13 @@ -

6.4. Request New +
6.4. Reporting + security problems
+ +
6.5. Request New Features
-
6.5. Mailing +
6.6. Mailing Lists
@@ -517,9 +520,9 @@
-
7.1. License
+
7.1. License
-
7.2. History
+
7.2. History
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 993e9ca5..8f0f2b32 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -2050,7 +2050,10 @@ problem-host.example.com

External filters are scripts or programs that can modify the content in case common filters aren't powerful - enough.

+ enough. With the exception that this action doesn't use + pcrs-based filters, the notes in the filter + section apply.

@@ -2859,7 +2862,9 @@ problem-host.example.com

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.

+ Privoxy to exit. Due to design limitations, invalid + parameter syntax isn't detected until the action is + used the first time.

Use the

@@ -4456,7 +4489,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
-

8.5.36. +

8.5.36. Summary

Note that many of these actions have the potential to cause a page @@ -4615,7 +4648,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not together:

-

8.7.1. +

8.7.1. match-all.action

Remember all actions @@ -4664,7 +4697,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not

-

8.7.2. +

8.7.2. default.action

If you aren't a developer, there's no need for you to edit the @@ -5007,7 +5040,7 @@ wiki.

-

8.7.3. +

8.7.3. user.action

So far we are painting with a broad brush by setting general diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html index 34cf2ecf..22b40dca 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -293,7 +293,7 @@

-

14.2. Privoxy's +

14.2. Privoxy's Internal Pages

Since Privoxy proxies each @@ -313,7 +313,7 @@

diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html index 603801f9..87dbab66 100644 --- a/doc/webserver/user-manual/contact.html +++ b/doc/webserver/user-manual/contact.html @@ -292,7 +292,8 @@

11.3.2. Reporting Bugs

-

Please report all bugs through our bug tracker: Please report bugs that aren't security issues through our bug + tracker: http://sourceforge.net/tracker/?group_id=11118&atid=111118.

@@ -308,7 +309,22 @@

-

11.4. +

11.4. Reporting security problems

+ +

If you discovered a security problem or merely suspect that a bug + might be a security issue, please mail Fabian Keil + <fk@fabiankeil.de> (OpenPGP fingerprint: 4F36 C17F 3816 9136 54A1 + E850 6918 2291 8BA2 371C).

+ +

Usually you should get a response within a day, otherwise it's + likely that either your mail or the response didn't make it. If that + happens, please mail to the developer list to request a status + update.

+

+ +
+

11.5. Request New Features

You are welcome to submit ideas on new features or other proposals @@ -318,7 +334,7 @@

-

11.5. +

11.6. Mailing Lists

If you prefer to communicate through email, instead of using a web diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html index 09acb904..c3c080b0 100644 --- a/doc/webserver/user-manual/filter-file.html +++ b/doc/webserver/user-manual/filter-file.html @@ -177,7 +177,7 @@ FILTER: foo Replace all "foo" with "bar" started.

-

9.1. Filter File +

9.1. Filter File Tutorial

Now, let's complete our "foo" content @@ -902,6 +902,12 @@ while read line; \ do \ echo "$line"; \ 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]" - diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html index c1c1df77..becab072 100644 --- a/doc/webserver/user-manual/index.html +++ b/doc/webserver/user-manual/index.html @@ -23,7 +23,7 @@ 2001-2014 by Privoxy Developers

-

$Id: user-manual.sgml,v 2.183 2014/05/26 10:48:39 +

$Id: user-manual.sgml,v 2.193 2014/07/18 10:01:39 fabiankeil Exp $

@@ -485,7 +485,7 @@ "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker
8.5.36. Summary
+ "actions-file.html#AEN4923">Summary @@ -497,13 +497,13 @@
8.7.1. match-all.action
+ "actions-file.html#AEN4987">match-all.action
8.7.2. default.action
+ "actions-file.html#AEN5009">default.action
8.7.3. user.action
+ "actions-file.html#AEN5122">user.action
@@ -513,7 +513,7 @@
-
9.1. Filter File +
9.1. Filter File Tutorial
9.2. The @@ -551,10 +551,13 @@
-
11.4. Request New +
11.4. Reporting + security problems
+ +
11.5. Request New Features
-
11.5. Mailing +
11.6. Mailing Lists
@@ -581,7 +584,7 @@
14.1. Regular Expressions
-
14.2. Privoxy's Internal +
14.2. Privoxy's Internal Pages
-- 2.39.2 

-# 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     \
 }
@@ -4012,11 +4019,15 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
               
The syntax for pcrs commands is documented in the filter file section.

 
-              
This action will be ignored if you use it together with
-              block. It can be combined
-              with fast-redirects{check-decoded-url}
+              
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.

 
               
Use this action carefully, make sure not to create
@@ -4059,6 +4070,19 @@ undeadly.org/cgi\?action=article&sid=\d*$
 {+redirect{s@^http://[^/]*/results\.aspx\?q=([^&]*).*@http://search.yahoo.com/search?p=$1@}}
 search.msn.com//results\.aspx\?q=
 
+# Redirect http://example.com/&bla=fasel&toChange=foo (and any other value but "bar")
+# to       http://example.com/&bla=fasel&toChange=bar
+#
+# The URL pattern makes sure that the following request isn't redirected again.
+{+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@}}
@@ -4208,6 +4232,15 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
 {+server-header-tagger{content-type}}
 /
 
+# If the response has a tag starting with 'image/' enable an external
+# filter that only applies to images.
+#
+# Note that the filter is not available by default, it's just a
+# silly example.
+{+external-filter{rotate-image} +force-text-mode}
+TAG:^image/
+