From 797ddff0b98384c2033537b283c9e6e43fba8df3 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Sun, 22 May 2016 12:44:32 +0000 Subject: [PATCH] Rebuild documentation --- AUTHORS | 5 +- INSTALL | 4 +- README | 22 ++--- .../developer-manual/introduction.html | 8 +- .../developer-manual/newrelease.html | 2 +- doc/webserver/faq/configuration.html | 4 +- doc/webserver/faq/contact.html | 8 +- doc/webserver/faq/copyright.html | 6 +- doc/webserver/faq/general.html | 10 +-- doc/webserver/faq/index.html | 42 +++++---- doc/webserver/faq/trouble.html | 87 ++++++++----------- doc/webserver/user-manual/actions-file.html | 2 +- doc/webserver/user-manual/appendix.html | 26 +++--- doc/webserver/user-manual/config.html | 86 ++++++++++++++++++ doc/webserver/user-manual/contact.html | 8 +- doc/webserver/user-manual/copyright.html | 2 +- doc/webserver/user-manual/index.html | 3 + doc/webserver/user-manual/installation.html | 4 +- 18 files changed, 206 insertions(+), 123 deletions(-) diff --git a/AUTHORS b/AUTHORS index 63138daa..e402a2de 100644 --- a/AUTHORS +++ b/AUTHORS @@ -126,6 +126,7 @@ include (in alphabetical order): Andreas Rutkauskas Bart Schelstraete Gregory Seidman + Atman Sense Chung-chieh Shan Benjamin C. Wiley Sittler Simon South @@ -166,6 +167,6 @@ GNU C Library written by Ulrich Drepper. If we've missed you off this list, please let us know! - Privoxy team. http://www.privoxy.org/ - + Privoxy team. https://www.privoxy.org/ + diff --git a/INSTALL b/INSTALL index a7725a68..4e6aac47 100644 --- a/INSTALL +++ b/INSTALL @@ -1,11 +1,11 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/INSTALL,v $ + * File : $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $ * * Purpose : INSTALL file to help with installing from source. * * Copyright : Written by and Copyright (C) 2001-2009 the - * Privoxy team. http://www.privoxy.org/ + * Privoxy team. https://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and diff --git a/README b/README index 39169915..8e35da3a 100644 --- a/README +++ b/README @@ -1,11 +1,11 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/README,v $ + * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ * * Purpose : README file to give a short intro. * * Copyright : Written by and Copyright (C) 2001-2011 the - * Privoxy team. http://www.privoxy.org/ + * Privoxy team. https://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -33,7 +33,7 @@ *********************************************************************/ This README is included with the development version of Privoxy 3.0.25. See -http://www.privoxy.org/ for more information. The current code maturity level +https://www.privoxy.org/ for more information. The current code maturity level is "UNRELEASED", but seems stable to us :). ------------------------------------------------------------------------------- @@ -51,9 +51,9 @@ Privoxy is an associated project of Software in the Public Interest (SPI). Helping hands and donations are welcome: - * http://www.privoxy.org/faq/general.html#PARTICIPATE + * https://www.privoxy.org/faq/general.html#PARTICIPATE - * http://www.privoxy.org/faq/general.html#DONATE + * https://www.privoxy.org/faq/general.html#DONATE ------------------------------------------------------------------------------- @@ -94,7 +94,7 @@ in '*.action' files. 'user.action' should be used for any actions customizations. On Unix-like systems, these files are typically installed in / etc/privoxy. On Windows, then wherever the executable itself is installed. There are many significant changes and advances from earlier versions. The User -Manual has an explanation of all configuration options, and examples: http:// +Manual has an explanation of all configuration options, and examples: https:// www.privoxy.org/user-manual/. Be sure to set your browser(s) for HTTP/HTTPS Proxy at :, or whatever @@ -123,7 +123,7 @@ 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, +documentation is posted on https://www.privoxy.org, in case you don't have it, or can't find it. ------------------------------------------------------------------------------- @@ -279,7 +279,7 @@ and you won't see them. Please send feedback on ads that slipped through, innocent images that were blocked, sites that don't work properly, and other configuration related -problem of default.action file, to http://sourceforge.net/tracker/?group_id= +problem of default.action file, to https://sourceforge.net/tracker/?group_id= 11118&atid=460288, the Actions File Tracker. ------------------------------------------------------------------------------- @@ -312,8 +312,10 @@ feel free to use one of the mailing lists. To discuss issues that haven't been completely diagnosed yet, please use the Privoxy users list. Technically interested users and people who wish to contribute to the project are always welcome on the developers list. You can find an overview of all Privoxy-related -mailing lists, including list archives, at: http://sourceforge.net/mail/? -group_id=11118. +mailing lists, including list archives, at: https://lists.privoxy.org/mailman/ +listinfo. The lists hosted on privoxy.org have been created in 2016, the +previously-used lists hosted at SourceForge are deprecated but the archives may +still be useful: https://sourceforge.net/mail/?group_id=11118. ------------------------------------------------------------------------------- diff --git a/doc/webserver/developer-manual/introduction.html b/doc/webserver/developer-manual/introduction.html index d92ad406..95ff1c54 100644 --- a/doc/webserver/developer-manual/introduction.html +++ b/doc/webserver/developer-manual/introduction.html @@ -56,10 +56,10 @@ to Privoxy Development

The first step is to join the developer's mailing list. You can submit your ideas, or even - better patches. Patches are best submitted to the Sourceforge tracker - set up for this purpose, but can be sent to the list for review + "https://lists.privoxy.org/mailman/listinfo/privoxy-devel" target= + "_top">privoxy-devel mailing list. You can submit your ideas, or + even better patches. Patches are best submitted to the Sourceforge + tracker set up for this purpose, but can be sent to the list for review too.

You will also need to have a cvs package installed, which will diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index 4b18f1ec..92906b0a 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -978,7 +978,7 @@

When all (or: most of the) packages have been uploaded and made available, send an email to the announce + "mailto:privoxy-announce@lists.privoxy.org" target="_top">announce mailing list, Subject: "Version X.Y.Z available for download". Be sure to include the 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.

+ privoxy-announce@lists.privoxy.org.

diff --git a/doc/webserver/faq/contact.html b/doc/webserver/faq/contact.html index 96d6ec57..96610d1d 100644 --- a/doc/webserver/faq/contact.html +++ b/doc/webserver/faq/contact.html @@ -208,7 +208,7 @@ Get Support

All users are welcome to discuss their issues on the users mailing list, where the developers also hang around.

@@ -313,7 +313,11 @@ contribute to the project are always welcome on the developers list. You can find an overview of all Privoxy-related mailing lists, including list - archives, at: https://lists.privoxy.org/mailman/listinfo. The lists + hosted on privoxy.org have been created in 2016, the previously-used + lists hosted at SourceForge are deprecated but the archives may still + be useful: https://sourceforge.net/mail/?group_id=11118.

diff --git a/doc/webserver/faq/copyright.html b/doc/webserver/faq/copyright.html index 60a69595..e910e592 100644 --- a/doc/webserver/faq/copyright.html +++ b/doc/webserver/faq/copyright.html @@ -43,7 +43,7 @@

Copyright © 2001-2016 by Privoxy Developers

+ "mailto:privoxy-devel@lists.privoxy.org">privoxy-devel@lists.privoxy.org>

Some source code is based on code Copyright © 1997 by Anonymous Coders and Junkbusters, Inc. and licensed under the 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/general.html b/doc/webserver/faq/general.html index 5b79f04c..1b07e511 100644 --- a/doc/webserver/faq/general.html +++ b/doc/webserver/faq/general.html @@ -498,12 +498,12 @@ lists.

So first thing, subscribe to the Privoxy Users or the Privoxy Developers mailing list, join the - discussion, help out other users, provide general feedback or report - problems you noticed.

+ "https://lists.privoxy.org/mailman/listinfo/privoxy-devel" target= + "_top">Privoxy Developers mailing list, join the discussion, help + out other users, provide general feedback or report problems you + noticed.

If you intend to help out with the trackers, you also might want to Privoxy has stopped working. -

5.11. I get a completely - blank page at one site. "View Source" - shows only: <html><body></body></html>. - Without Privoxy the page loads fine.
- -
5.12. My logs show many +
5.11. My logs show many "Unable to get my own hostname" lines. Why?
-
5.13. When I try to launch +
5.12. When I try to launch Privoxy, I get an error message "port 8118 is already in use" (or similar wording). Why?
-
5.14. Pages with UTF-8 +
5.13. Pages with UTF-8 fonts are garbled.
-
5.15. Why are binary +
5.14. Why are binary files (such as images) corrupted when Privoxy is used?
-
5.16. What is the +
5.15. What is the "demoronizer" and why is it there?
-
5.17. Why do I keep seeing +
5.16. Why do I keep seeing "PrivoxyWindowOpen()" in raw source code?
-
5.18. I am getting too many +
5.17. I am getting too many DNS errors like "404 No Such Domain". Why can't Privoxy do this better?
-
5.19. At one site Privoxy just +
5.18. At one site Privoxy just hangs, and starts taking all CPU. Why is this?
-
5.20. I just installed +
5.19. I just installed Privoxy, and all my browsing has slowed to a crawl. What gives?
-
5.21. Why do my filters +
5.20. Why do my filters work on some sites but not on others?
-
5.22. On some HTTPS sites +
5.21. On some HTTPS sites my browser warns me about unauthenticated content, the URL bar doesn't get highlighted and the lock symbol appears to be broken. What's going on?
-
5.23. I get selinux error +
5.22. I get selinux error messages. How can I fix this?
-
5.24. I compiled +
5.23. I compiled Privoxy with Gentoo's portage and it appears to be very slow. Why?
-
5.25. What are tainted +
5.24. What are tainted sockets and how do I prevent them?
+ +
5.25. After adding my + custom filters, Privoxy crashes + when visitting certain websites
@@ -524,9 +522,9 @@
-
7.1. License
+
7.1. License
-
7.2. History
+
7.2. History
diff --git a/doc/webserver/faq/trouble.html b/doc/webserver/faq/trouble.html index 569c6b0f..28949efe 100644 --- a/doc/webserver/faq/trouble.html +++ b/doc/webserver/faq/trouble.html @@ -382,44 +382,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua
-

5.11. I get a - completely blank page at one site. "View - Source" shows only: <html><body></body></html>. - Without Privoxy the page loads fine.

- -

Chances are that the site suffers from a bug in PHP, which results in empty pages being sent - if the client explicitly requests an uncompressed page, like - Privoxy does. This bug has been fixed - in PHP 4.2.3.

- -

To find out if this is in fact the source of the problem, try adding - the site to a -prevent-compression section in - user.action:

- - - - - -
- 
-   # Make exceptions for ill-behaved sites:
-   #
-   {-prevent-compression}
-    .example.com
-
-
- -

If that works, you may also want to report the problem to the site's - webmasters, telling them to use zlib.output_compression instead of - ob_gzhandler in their PHP applications (workaround) or upgrade to PHP - 4.2.3 or later (fix).

-
- -
-

5.12. My logs +

5.11. My logs show many "Unable to get my own hostname" lines. Why?

@@ -448,7 +411,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.13. When I try to launch +

5.12. When I try to launch Privoxy, I get an error message "port 8118 is already in use" (or similar wording). Why?

@@ -464,7 +427,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.14. Pages +

5.13. Pages with UTF-8 fonts are garbled.

This may be the result of an overly aggressive filter. The filters @@ -489,7 +452,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.15. Why +

5.14. Why are binary files (such as images) corrupted when Privoxy is used?

@@ -502,7 +465,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.16. What +

5.15. What is the "demoronizer" and why is it there?

@@ -530,7 +493,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.17. Why do I +

5.16. Why do I keep seeing "PrivoxyWindowOpen()" in raw source code?

@@ -551,7 +514,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.18. I am getting +

5.17. I am getting too many DNS errors like "404 No Such Domain". Why can't Privoxy do this better?

@@ -579,7 +542,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.19. At one site +

5.18. At one site Privoxy just hangs, and starts taking all CPU. Why is this?

This is probably a manifestation of the "100% @@ -598,7 +561,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.20. I just +

5.19. I just installed Privoxy, and all my browsing has slowed to a crawl. What gives?

@@ -612,7 +575,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.21. Why do +

5.20. Why do my filters work on some sites but not on others?

It's probably due to compression. It is a common practice for web @@ -629,7 +592,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.22. On +

5.21. On some HTTPS sites my browser warns me about unauthenticated content, the URL bar doesn't get highlighted and the lock symbol appears to be broken. What's going on?

@@ -675,7 +638,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.23. I get selinux +

5.22. I get selinux error messages. How can I fix this?

Please report the problem to the creator of your selinux @@ -700,7 +663,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.24. I +

5.23. I compiled Privoxy with Gentoo's portage and it appears to be very slow. Why?

@@ -723,7 +686,7 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua

-

5.25. +

5.24. What are tainted sockets and how do I prevent them?

Privoxy marks sockets as tainted @@ -756,6 +719,28 @@ Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua problem that may be worth fixing, the problem will be explicitly logged as error.

+ +
+

5.25. After adding my custom filters, Privoxy crashes when visitting certain + websites

+ +

This can happen if your custom filters require more memory than + Privoxy is allowed to use. Usually the + problem is that the operating system enforces a stack size limit that + isn't sufficient.

+ +

Unless the problem occurs with the filters available in the default + configuration, this is not considered a Privoxy bug.

+ +

To prevent the crashes you can rewrite your filter to use less + ressources, increase the relevant memory limit or recompile pcre to use + less stack space. For details please see the pcrestack man page and the documentation of your operating + system.

+
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 6e4183ad..47deb7c3 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -117,7 +117,7 @@ in default.action are:

- +

Table 1. Default Configurations

diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html index e31e01c6..080718e5 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -313,7 +313,7 @@
+
+ +
+

7.6.16. trust-x-forwarded-for

+ +
+
+
Specifies:
+ +
+

Whether or not Privoxy should use IP addresses specified + with the X-Forwarded-For header

+
+ +
Type of value:
+ +
+

0 or one

+
+ +
Default value:
+ +
+

0

+
+ +
Notes:
+ +
+
+ + + + + + + + +
Warning
+

This is an experimental feature. The syntax is + likely to change in future versions.

+
+
+ +

If clients reach Privoxy through another proxy, for example + a load balancer, Privoxy can't tell the client's IP address + from the connection. If multiple clients use the same proxy, + they will share the same client tag settings which is usually + not desired.

+ +

This option lets Privoxy use the X-Forwarded-For header + value as client IP address. If the proxy sets the header, + multiple clients using the same proxy do not share the same + client tag settings.

+ +

This option should only be enabled if Privoxy can only be + reached through a proxy and if the proxy can be trusted to set + the header correctly. It is recommended that ACL are used to + make sure only trusted systems can reach Privoxy.

+ +

If access to Privoxy isn't limited to trusted systems, this + option would allow malicious clients to change the client tags + for other clients or increase Privoxy's memory requirements by + registering lots of client tag settings for clients that don't + exist.

+
+ +
Examples:
+ +
+ + + diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html index 90f7b70a..1d869e90 100644 --- a/doc/webserver/user-manual/contact.html +++ b/doc/webserver/user-manual/contact.html @@ -208,7 +208,7 @@ Get Support

All users are welcome to discuss their issues on the users mailing list, where the developers also hang around.

@@ -313,7 +313,11 @@ contribute to the project are always welcome on the developers list. You can find an overview of all Privoxy-related mailing lists, including list - archives, at: https://lists.privoxy.org/mailman/listinfo. The lists + hosted on privoxy.org have been created in 2016, the previously-used + lists hosted at SourceForge are deprecated but the archives may still + be useful: https://sourceforge.net/mail/?group_id=11118.

diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html index 6781a8ae..ce642c8e 100644 --- a/doc/webserver/user-manual/copyright.html +++ b/doc/webserver/user-manual/copyright.html @@ -44,7 +44,7 @@

Copyright © 2001-2016 by Privoxy Developers

+ "mailto:privoxy-devel@lists.privoxy.org">privoxy-devel@lists.privoxy.org>

Some source code is based on code Copyright © 1997 by Anonymous Coders and Junkbusters, Inc. and licensed under the 7.6.15. client-tag-lifetime + +

7.6.16. trust-x-forwarded-for
diff --git a/doc/webserver/user-manual/installation.html b/doc/webserver/user-manual/installation.html index 62089ee0..0f0471bf 100644 --- a/doc/webserver/user-manual/installation.html +++ b/doc/webserver/user-manual/installation.html @@ -476,9 +476,9 @@

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.

+ privoxy-announce@lists.privoxy.org.

In order not to lose your personal changes and adjustments when updating to the latest default.action file we -- 2.39.2

+ 
+      # Allow systems that can reach Privoxy to provide the client
+      # IP address with a X-Forwarded-For header.
+      trust-x-forwarded-for 1
+