From 4fef8970e4e382c21598949e7b035e596a4a8048 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Fri, 25 Jan 2013 14:26:40 +0000 Subject: [PATCH] Rebuild documentation with the updated contact section --- doc/webserver/developer-manual/contact.html | 314 +++++++++--------- doc/webserver/developer-manual/copyright.html | 4 +- doc/webserver/developer-manual/index.html | 19 +- doc/webserver/faq/contact.html | 314 +++++++++--------- doc/webserver/faq/copyright.html | 4 +- doc/webserver/faq/index.html | 19 +- doc/webserver/user-manual/actions-file.html | 18 +- doc/webserver/user-manual/appendix.html | 28 +- doc/webserver/user-manual/configuration.html | 6 +- doc/webserver/user-manual/contact.html | 314 +++++++++--------- doc/webserver/user-manual/copyright.html | 2 +- doc/webserver/user-manual/filter-file.html | 2 +- doc/webserver/user-manual/index.html | 60 ++-- doc/webserver/user-manual/quickstart.html | 2 +- doc/webserver/user-manual/startup.html | 95 +----- doc/webserver/user-manual/whatsnew.html | 5 - 16 files changed, 580 insertions(+), 626 deletions(-) diff --git a/doc/webserver/developer-manual/contact.html b/doc/webserver/developer-manual/contact.html index 1c5345ef..16f3f1c2 100644 --- a/doc/webserver/developer-manual/contact.html +++ b/doc/webserver/developer-manual/contact.html @@ -44,10 +44,166 @@

We value your feedback. In fact, we rely on it to improve Privoxy and its configuration. However, please note - the following hints, so we can provide you with the best support:

+ the following hints, so we can provide you with the best support.

-

8.1. +

8.1. Please provide sufficient + information

+ +

A lot of support requests don't contain enough information and can't + be solved without a lot of back and forth which causes unnecessary + delays. Reading this section should help to prevent that.

+ +

Before contacting us to report a problem, please try to verify that + it is a Privoxy problem, and not a + browser or site problem or documented behaviour that just happens to be + different than what you expected. If unsure, try toggling + off Privoxy, and see if the + problem persists.

+ +

If you are using your own custom configuration, please try the + default configuration to see if the problem is configuration related. + If you're having problems with a feature that is disabled by default, + please ask around on the mailing list if others can reproduce the + problem.

+ +

If you aren't using the latest Privoxy version, the problem may have + been found and fixed in the meantime. We would appreciate if you could + take the time to upgrade to the latest version and verify that the problem + still exists.

+ +

Please be sure to provide the following information when reporting + problems or requesting support:

+ +
    +
  • +

    The exact Privoxy version you + are using.

    +
    • + +
  • +

    The operating system and versions you run Privoxy on, e.g. Windows XP SP2.

    +
    • + +
  • +

    The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

    +
    • + +
  • +

    The URL where the problem occurred, or some way for us to + duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

    +
    • + +
  • +

    Whether your version of Privoxy + is one supplied by the Privoxy + developers via SourceForge, or if you got your copy somewhere + else.

    +
    • + +
  • +

    Whether you are using Privoxy + together with another proxy such as Tor. If so, please temporary disable the other + proxy to see if the symptoms change.

    +
    • + +
  • +

    Whether you are using a personal firewall product. If so, does + Privoxy work without it?

    +
    • + +
  • +

    Any other pertinent information to help identify the problem + such as config or log file excerpts (yes, you should have log file + entries for each action taken). To get a meaningful logfile, please + make sure that the logfile directive is being used and the following + debug + options are enabled (all of them):

    + +

    + debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
    + + debug     2 # show each connection status
    + + debug     4 # show I/O status
    + + debug     8 # show header parsing
    + + debug   128 # debug redirects
    + debug   256 # debug GIF de-animation
    + + debug   512 # Common Log Format
    + + debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
    + + debug  4096 # Startup banner and warnings.
    + + debug  8192 # Non-fatal errors

    + +

    If you are having trouble with a filter, please additionally + enable

    + +

    + debug    64 # debug regular expression filters

    If + you are using Privoxy 3.0.17 or later and suspect that it + interprets the request or the response incorrectly, please enable + +

    + debug 32768 # log all data read from the network

    + +

    It's easy for us to ignore log messages that aren't relevant but + missing log messages may make it impossible to investigate a + problem. If you aren't sure which of the debug directives are + relevant, please just enable all of them and let us worry about + it.

    + +

    Note that Privoxy log files may contain sensitive information so + please don't submit any logfiles you didn't read first. You can + mask sensitive information as long as it's clear that you removed + something.

    +
    • +
+ +

You don't have to tell us your actual name when filing a problem + report, but if you don't, please use a nickname so we can differentiate + between your messages and the ones entered by other "anonymous" users + that may respond to your request if they have the same problem or + already found a solution. Note that due to spam the trackers may not + always allow to post without being logged into SourceForge. If that's + the case, you are still free to create a login that isn't directly + linked to your name, though.

+ +

Please also check the status of your request a few days after + submitting it, as we may request additional information. If you use a + SF id, you should automatically get a mail when someone responds to + your request. Please don't bother to add an email address when using + the tracker. If you prefer to communicate through email, just use one + of the mailing lists directly.

+ +

If you are new to reporting problems, you might be interested in + How to Report Bugs Effectively.

+ +

The appendix of the Privoxy User Manual also has helpful + information on understanding actions, and + action debugging.

+

+ +
+

8.2. Get Support

For casual users, our

-

8.2. Reporting +

8.3. Reporting Problems

"Problems" for our purposes, come in two @@ -108,7 +264,7 @@

-

8.2.1. +

8.3.1. Reporting Ads or Other Configuration Problems

Please send feedback on ads that slipped through, innocent images @@ -131,7 +287,7 @@

-

8.2.2. +

8.3.2. Reporting Bugs

Please report all bugs through our bug tracker: submit form. If already submitted, please feel free to add any info to the original report that might help to solve the issue.

- -

Please try to verify that it is a Privoxy bug, and not a browser or site bug or - documented behaviour that just happens to be different than what you - expected. If unsure, try toggling - off Privoxy, and see if the - problem persists.

- -

If you are using your own custom configuration, please try the - stock configs to see if the problem is configuration related. If - you're having problems with a feature that is disabled by default, - please ask around on the mailing list if others can reproduce the - problem.

- -

If you aren't using the latest Privoxy version, the bug may have - been found and fixed in the meantime. We would appreciate if you - could take the time to upgrade to the latest version (or even the latest CVS - snapshot) and verify that your bug still exists.

- -

Please be sure to provide the following information:

- -
    -
  • -

    The exact Privoxy version you - are using (if you got the source from CVS, please also provide - the source code revisions as shown in http://config.privoxy.org/show-version).

    -
    • - -
  • -

    The operating system and versions you run Privoxy on, (e.g. Windows XP SP2), if you are using a Unix - flavor, sending the output of "uname - -a" should do, in case of GNU/Linux, please also name the - distribution.

    -
    • - -
  • -

    The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

    -
    • - -
  • -

    The URL where the problem occurred, or some way for us to - duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

    -
    • - -
  • -

    Whether your version of Privoxy is one supplied by the Privoxy developers via SourceForge, or if - you got your copy somewhere else.

    -
    • - -
  • -

    Whether you are using Privoxy - in tandem with another proxy such as Tor. If so, please temporary disable the - other proxy to see if the symptoms change.

    -
    • - -
  • -

    Whether you are using a personal firewall product. If so, does - Privoxy work without it?

    -
    • - -
  • -

    Any other pertinent information to help identify the problem - such as config or log file excerpts (yes, you should have log - file entries for each action taken). To get a meaningful logfile, - please make sure that the logfile - directive is being used and the following debug - options are enabled:

    - -

    - debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
    - - debug     2 # show each connection status
    - - debug     4 # show I/O status
    - - debug     8 # show header parsing
    - - debug   128 # debug redirects
    - debug   256 # debug GIF de-animation
    - - debug   512 # Common Log Format
    - - debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
    - - debug  4096 # Startup banner and warnings.
    - - debug  8192 # Non-fatal errors

    If you - are having trouble with a filter, please additionally enable - -

    - debug    64 # debug regular expression filters

    If - you are using Privoxy 3.0.17 or later and suspect that it - interprets the request or the response incorrectly, please enable - -

    - debug 32768 # log all data read from the network

    Note - that Privoxy log files may contain sensitive information so - please don't submit any logfiles you didn't read first. You can - mask sensitive information as long as it's clear that you removed - something. -
    • -
- -

You don't have to tell us your actual name when filing a problem - report, but if you don't, please use a nickname so we can - differentiate between your messages and the ones entered by other - "anonymous" users that may respond to your request if they have the - same problem or already found a solution. Note that due to spam the - trackers may not always allow to post without being logged into - SourceForge. If that's the case, you are still free to create a login - that isn't directly linked to your name, though.

- -

Please also check the status of your request a few days after - submitting it, as we may request additional information. If you use a - SF id, you should automatically get a mail when someone responds to - your request. Please don't bother to add an email address when using - the tracker. If you prefer to communicate through email, just use one - of the mailing lists directly.

- -

If you are new to reporting problems, you might be interested in - How to Report Bugs Effectively.

- -

The appendix of the Privoxy User Manual also has - helpful information on understanding actions, and action - debugging.

-

8.3. +

8.4. Request New Features

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

-

8.4. +

8.5. Mailing Lists

If you prefer to communicate through email, instead of using a web diff --git a/doc/webserver/developer-manual/copyright.html b/doc/webserver/developer-manual/copyright.html index de82e5c9..1ffe6a5e 100644 --- a/doc/webserver/developer-manual/copyright.html +++ b/doc/webserver/developer-manual/copyright.html @@ -50,7 +50,7 @@ "CITETITLE">GNU General Public License.

-

9.1. License

+

9.1. License

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

-

9.2. History

+

9.2. History

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and Junkbusters Corporation. diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html index 71fc595d..b989dd58 100644 --- a/doc/webserver/developer-manual/index.html +++ b/doc/webserver/developer-manual/index.html @@ -325,26 +325,29 @@

-
8.1. Get +
8.1. Please + provide sufficient information
+ +
8.2. Get Support
-
8.2. Reporting +
8.3. Reporting Problems
-
8.2.1. Reporting Ads +
8.3.1. Reporting Ads or Other Configuration Problems
-
8.2.2. Reporting +
8.3.2. Reporting Bugs
-
8.3. Request New +
8.4. Request New Features
-
8.4. Mailing +
8.5. Mailing Lists
@@ -354,9 +357,9 @@
-
9.1. License
+
9.1. License
-
9.2. History
+
9.2. History
diff --git a/doc/webserver/faq/contact.html b/doc/webserver/faq/contact.html index ca2020e4..e8d9cf6c 100644 --- a/doc/webserver/faq/contact.html +++ b/doc/webserver/faq/contact.html @@ -45,10 +45,166 @@

We value your feedback. In fact, we rely on it to improve Privoxy and its configuration. However, please note - the following hints, so we can provide you with the best support:

+ the following hints, so we can provide you with the best support.

-

6.1. +

6.1. Please provide sufficient + information

+ +

A lot of support requests don't contain enough information and can't + be solved without a lot of back and forth which causes unnecessary + delays. Reading this section should help to prevent that.

+ +

Before contacting us to report a problem, please try to verify that + it is a Privoxy problem, and not a + browser or site problem or documented behaviour that just happens to be + different than what you expected. If unsure, try toggling + off Privoxy, and see if the + problem persists.

+ +

If you are using your own custom configuration, please try the + default configuration to see if the problem is configuration related. + If you're having problems with a feature that is disabled by default, + please ask around on the mailing list if others can reproduce the + problem.

+ +

If you aren't using the latest Privoxy version, the problem may have + been found and fixed in the meantime. We would appreciate if you could + take the time to upgrade to the latest version and verify that the problem + still exists.

+ +

Please be sure to provide the following information when reporting + problems or requesting support:

+ +
    +
  • +

    The exact Privoxy version you + are using.

    +
    • + +
  • +

    The operating system and versions you run Privoxy on, e.g. Windows XP SP2.

    +
    • + +
  • +

    The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

    +
    • + +
  • +

    The URL where the problem occurred, or some way for us to + duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

    +
    • + +
  • +

    Whether your version of Privoxy + is one supplied by the Privoxy + developers via SourceForge, or if you got your copy somewhere + else.

    +
    • + +
  • +

    Whether you are using Privoxy + together with another proxy such as Tor. If so, please temporary disable the other + proxy to see if the symptoms change.

    +
    • + +
  • +

    Whether you are using a personal firewall product. If so, does + Privoxy work without it?

    +
    • + +
  • +

    Any other pertinent information to help identify the problem + such as config or log file excerpts (yes, you should have log file + entries for each action taken). To get a meaningful logfile, please + make sure that the logfile directive is being used and the following + debug + options are enabled (all of them):

    + +

    + debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
    + + debug     2 # show each connection status
    + + debug     4 # show I/O status
    + + debug     8 # show header parsing
    + + debug   128 # debug redirects
    + debug   256 # debug GIF de-animation
    + + debug   512 # Common Log Format
    + + debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
    + + debug  4096 # Startup banner and warnings.
    + + debug  8192 # Non-fatal errors

    + +

    If you are having trouble with a filter, please additionally + enable

    + +

    + debug    64 # debug regular expression filters

    If + you are using Privoxy 3.0.17 or later and suspect that it + interprets the request or the response incorrectly, please enable + +

    + debug 32768 # log all data read from the network

    + +

    It's easy for us to ignore log messages that aren't relevant but + missing log messages may make it impossible to investigate a + problem. If you aren't sure which of the debug directives are + relevant, please just enable all of them and let us worry about + it.

    + +

    Note that Privoxy log files may contain sensitive information so + please don't submit any logfiles you didn't read first. You can + mask sensitive information as long as it's clear that you removed + something.

    +
    • +
+ +

You don't have to tell us your actual name when filing a problem + report, but if you don't, please use a nickname so we can differentiate + between your messages and the ones entered by other "anonymous" users + that may respond to your request if they have the same problem or + already found a solution. Note that due to spam the trackers may not + always allow to post without being logged into SourceForge. If that's + the case, you are still free to create a login that isn't directly + linked to your name, though.

+ +

Please also check the status of your request a few days after + submitting it, as we may request additional information. If you use a + SF id, you should automatically get a mail when someone responds to + your request. Please don't bother to add an email address when using + the tracker. If you prefer to communicate through email, just use one + of the mailing lists directly.

+ +

If you are new to reporting problems, you might be interested in + How to Report Bugs Effectively.

+ +

The appendix of the Privoxy User Manual also has helpful + information on understanding actions, and + action debugging.

+

+ +
+

6.2. Get Support

For casual users, our

-

6.2. Reporting +

6.3. Reporting Problems

"Problems" for our purposes, come in two @@ -109,7 +265,7 @@

-

6.2.1. +

6.3.1. Reporting Ads or Other Configuration Problems

Please send feedback on ads that slipped through, innocent images @@ -132,7 +288,7 @@

-

6.2.2. +

6.3.2. Reporting Bugs

Please report all bugs through our bug tracker: submit form. If already submitted, please feel free to add any info to the original report that might help to solve the issue.

- -

Please try to verify that it is a Privoxy bug, and not a browser or site bug or - documented behaviour that just happens to be different than what you - expected. If unsure, try toggling - off Privoxy, and see if the - problem persists.

- -

If you are using your own custom configuration, please try the - stock configs to see if the problem is configuration related. If - you're having problems with a feature that is disabled by default, - please ask around on the mailing list if others can reproduce the - problem.

- -

If you aren't using the latest Privoxy version, the bug may have - been found and fixed in the meantime. We would appreciate if you - could take the time to upgrade to the latest version (or even the latest CVS - snapshot) and verify that your bug still exists.

- -

Please be sure to provide the following information:

- -
    -
  • -

    The exact Privoxy version you - are using (if you got the source from CVS, please also provide - the source code revisions as shown in http://config.privoxy.org/show-version).

    -
    • - -
  • -

    The operating system and versions you run Privoxy on, (e.g. Windows XP SP2), if you are using a Unix - flavor, sending the output of "uname - -a" should do, in case of GNU/Linux, please also name the - distribution.

    -
    • - -
  • -

    The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

    -
    • - -
  • -

    The URL where the problem occurred, or some way for us to - duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

    -
    • - -
  • -

    Whether your version of Privoxy is one supplied by the Privoxy developers via SourceForge, or if - you got your copy somewhere else.

    -
    • - -
  • -

    Whether you are using Privoxy - in tandem with another proxy such as Tor. If so, please temporary disable the - other proxy to see if the symptoms change.

    -
    • - -
  • -

    Whether you are using a personal firewall product. If so, does - Privoxy work without it?

    -
    • - -
  • -

    Any other pertinent information to help identify the problem - such as config or log file excerpts (yes, you should have log - file entries for each action taken). To get a meaningful logfile, - please make sure that the logfile - directive is being used and the following debug - options are enabled:

    - -

    - debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
    - - debug     2 # show each connection status
    - - debug     4 # show I/O status
    - - debug     8 # show header parsing
    - - debug   128 # debug redirects
    - debug   256 # debug GIF de-animation
    - - debug   512 # Common Log Format
    - - debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
    - - debug  4096 # Startup banner and warnings.
    - - debug  8192 # Non-fatal errors

    If you - are having trouble with a filter, please additionally enable - -

    - debug    64 # debug regular expression filters

    If - you are using Privoxy 3.0.17 or later and suspect that it - interprets the request or the response incorrectly, please enable - -

    - debug 32768 # log all data read from the network

    Note - that Privoxy log files may contain sensitive information so - please don't submit any logfiles you didn't read first. You can - mask sensitive information as long as it's clear that you removed - something. -
    • -
- -

You don't have to tell us your actual name when filing a problem - report, but if you don't, please use a nickname so we can - differentiate between your messages and the ones entered by other - "anonymous" users that may respond to your request if they have the - same problem or already found a solution. Note that due to spam the - trackers may not always allow to post without being logged into - SourceForge. If that's the case, you are still free to create a login - that isn't directly linked to your name, though.

- -

Please also check the status of your request a few days after - submitting it, as we may request additional information. If you use a - SF id, you should automatically get a mail when someone responds to - your request. Please don't bother to add an email address when using - the tracker. If you prefer to communicate through email, just use one - of the mailing lists directly.

- -

If you are new to reporting problems, you might be interested in - How to Report Bugs Effectively.

- -

The appendix of the Privoxy User Manual also has - helpful information on understanding actions, and action - debugging.

-

6.3. +

6.4. Request New Features

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

-

6.4. +

6.5. 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 f582fda1..177db393 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 5676d1a7..a1e52447 100644 --- a/doc/webserver/faq/index.html +++ b/doc/webserver/faq/index.html @@ -481,26 +481,29 @@

-
6.1. Get +
6.1. Please + provide sufficient information
+ +
6.2. Get Support
-
6.2. Reporting +
6.3. Reporting Problems
-
6.2.1. Reporting Ads +
6.3.1. Reporting Ads or Other Configuration Problems
-
6.2.2. Reporting +
6.3.2. Reporting Bugs
-
6.3. Request New +
6.4. Request New Features
-
6.4. Mailing +
6.5. Mailing Lists
@@ -510,9 +513,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 9df397ef..5a3ac071 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

@@ -314,7 +314,7 @@ actions.

-

8.1. Finding the Right +

8.1. Finding the Right Mix

Note that some actions, like @@ -339,7 +339,7 @@

-

8.2. How to +

8.2. How to Edit

The easiest way to edit the actions files is with a browser by using @@ -529,7 +529,7 @@

-

8.4.1. The Domain +

8.4.1. The Domain Pattern

The matching of the domain part offers some flexible options: if @@ -634,7 +634,7 @@

-

8.4.2. The Path +

8.4.2. The Path Pattern

Privoxy uses

-

8.5.35. +

8.5.35. Summary

Note that many of these actions have the potential to cause a page @@ -4483,7 +4483,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 @@ -4532,7 +4532,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 @@ -4875,7 +4875,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 caee2e30..31238c81 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 @@

  • -

    Privoxy main page:

    +

    Privoxy main page:

    Show information about the current configuration, including - viewing and editing of actions files:

    + viewing and editing of actions files:

  • -

    Show the source code version numbers:

     +

    Show the source code version numbers:

  • -

    Show the browser's request headers:

     +

    Show the browser's request headers:

  • -

    Show which actions apply to a URL and why:

     +

    Show which actions apply to a URL and why:

    "off", "Privoxy" continues to run, but only as a pass-through proxy, with no actions taking place:

    + "AEN5869" id="AEN5869">

    http://config.privoxy.org/toggle

    -

    Short cuts. Turn off, then on:

    +

    Short cuts. Turn off, then on:

    http://config.privoxy.org/toggle?set=disable

    -
    +

    -

    6.1. Controlling +

    6.1. Controlling Privoxy with Your Web Browser

    Privoxy's user interface can be @@ -63,8 +63,8 @@ -

        Privoxy Menu

    +

        Privoxy Menu
    diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html index 96e35e1c..0024ac75 100644 --- a/doc/webserver/user-manual/contact.html +++ b/doc/webserver/user-manual/contact.html @@ -45,10 +45,166 @@

    We value your feedback. In fact, we rely on it to improve Privoxy and its configuration. However, please note - the following hints, so we can provide you with the best support:

    + the following hints, so we can provide you with the best support.

    -

    11.1. +

    11.1. Please provide sufficient + information

    + +

    A lot of support requests don't contain enough information and can't + be solved without a lot of back and forth which causes unnecessary + delays. Reading this section should help to prevent that.

    + +

    Before contacting us to report a problem, please try to verify that + it is a Privoxy problem, and not a + browser or site problem or documented behaviour that just happens to be + different than what you expected. If unsure, try toggling + off Privoxy, and see if the + problem persists.

    + +

    If you are using your own custom configuration, please try the + default configuration to see if the problem is configuration related. + If you're having problems with a feature that is disabled by default, + please ask around on the mailing list if others can reproduce the + problem.

    + +

    If you aren't using the latest Privoxy version, the problem may have + been found and fixed in the meantime. We would appreciate if you could + take the time to upgrade to the latest version and verify that the problem + still exists.

    + +

    Please be sure to provide the following information when reporting + problems or requesting support:

    + +
      +
    • +

      The exact Privoxy version you + are using.

      +
      • + +
    • +

      The operating system and versions you run Privoxy on, e.g. Windows XP SP2.

      +
      • + +
    • +

      The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

      +
      • + +
    • +

      The URL where the problem occurred, or some way for us to + duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

      +
      • + +
    • +

      Whether your version of Privoxy + is one supplied by the Privoxy + developers via SourceForge, or if you got your copy somewhere + else.

      +
      • + +
    • +

      Whether you are using Privoxy + together with another proxy such as Tor. If so, please temporary disable the other + proxy to see if the symptoms change.

      +
      • + +
    • +

      Whether you are using a personal firewall product. If so, does + Privoxy work without it?

      +
      • + +
    • +

      Any other pertinent information to help identify the problem + such as config or log file excerpts (yes, you should have log file + entries for each action taken). To get a meaningful logfile, please + make sure that the logfile directive is being used and the following + debug + options are enabled (all of them):

      + +

      + debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
      + + debug     2 # show each connection status
      + + debug     4 # show I/O status
      + + debug     8 # show header parsing
      + + debug   128 # debug redirects
      + debug   256 # debug GIF de-animation
      + + debug   512 # Common Log Format
      + + debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
      + + debug  4096 # Startup banner and warnings.
      + + debug  8192 # Non-fatal errors

      + +

      If you are having trouble with a filter, please additionally + enable

      + +

      + debug    64 # debug regular expression filters

      If + you are using Privoxy 3.0.17 or later and suspect that it + interprets the request or the response incorrectly, please enable + +

      + debug 32768 # log all data read from the network

      + +

      It's easy for us to ignore log messages that aren't relevant but + missing log messages may make it impossible to investigate a + problem. If you aren't sure which of the debug directives are + relevant, please just enable all of them and let us worry about + it.

      + +

      Note that Privoxy log files may contain sensitive information so + please don't submit any logfiles you didn't read first. You can + mask sensitive information as long as it's clear that you removed + something.

      +
      • +
    + +

    You don't have to tell us your actual name when filing a problem + report, but if you don't, please use a nickname so we can differentiate + between your messages and the ones entered by other "anonymous" users + that may respond to your request if they have the same problem or + already found a solution. Note that due to spam the trackers may not + always allow to post without being logged into SourceForge. If that's + the case, you are still free to create a login that isn't directly + linked to your name, though.

    + +

    Please also check the status of your request a few days after + submitting it, as we may request additional information. If you use a + SF id, you should automatically get a mail when someone responds to + your request. Please don't bother to add an email address when using + the tracker. If you prefer to communicate through email, just use one + of the mailing lists directly.

    + +

    If you are new to reporting problems, you might be interested in + How to Report Bugs Effectively.

    + +

    The appendix of the Privoxy User Manual also has helpful + information on understanding actions, and + action debugging.

    +

    + +
    +

    11.2. Get Support

    For casual users, our

    -

    11.2. Reporting +

    11.3. Reporting Problems

    "Problems" for our purposes, come in two @@ -109,7 +265,7 @@

-

11.2.1. +

11.3.1. Reporting Ads or Other Configuration Problems

Please send feedback on ads that slipped through, innocent images @@ -132,7 +288,7 @@

-

11.2.2. +

11.3.2. Reporting Bugs

Please report all bugs through our bug tracker: submit form. If already submitted, please feel free to add any info to the original report that might help to solve the issue.

- -

Please try to verify that it is a Privoxy bug, and not a browser or site bug or - documented behaviour that just happens to be different than what you - expected. If unsure, try toggling - off Privoxy, and see if the - problem persists.

- -

If you are using your own custom configuration, please try the - stock configs to see if the problem is configuration related. If - you're having problems with a feature that is disabled by default, - please ask around on the mailing list if others can reproduce the - problem.

- -

If you aren't using the latest Privoxy version, the bug may have - been found and fixed in the meantime. We would appreciate if you - could take the time to upgrade to the latest version (or even the latest CVS - snapshot) and verify that your bug still exists.

- -

Please be sure to provide the following information:

- -
    -
  • -

    The exact Privoxy version you - are using (if you got the source from CVS, please also provide - the source code revisions as shown in http://config.privoxy.org/show-version).

    -
    • - -
  • -

    The operating system and versions you run Privoxy on, (e.g. Windows XP SP2), if you are using a Unix - flavor, sending the output of "uname - -a" should do, in case of GNU/Linux, please also name the - distribution.

    -
    • - -
  • -

    The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac).

    -
    • - -
  • -

    The URL where the problem occurred, or some way for us to - duplicate the problem (e.g. http://somesite.example.com/?somethingelse=123).

    -
    • - -
  • -

    Whether your version of Privoxy is one supplied by the Privoxy developers via SourceForge, or if - you got your copy somewhere else.

    -
    • - -
  • -

    Whether you are using Privoxy - in tandem with another proxy such as Tor. If so, please temporary disable the - other proxy to see if the symptoms change.

    -
    • - -
  • -

    Whether you are using a personal firewall product. If so, does - Privoxy work without it?

    -
    • - -
  • -

    Any other pertinent information to help identify the problem - such as config or log file excerpts (yes, you should have log - file entries for each action taken). To get a meaningful logfile, - please make sure that the logfile - directive is being used and the following debug - options are enabled:

    - -

    - debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
    - - debug     2 # show each connection status
    - - debug     4 # show I/O status
    - - debug     8 # show header parsing
    - - debug   128 # debug redirects
    - debug   256 # debug GIF de-animation
    - - debug   512 # Common Log Format
    - - debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
    - - debug  4096 # Startup banner and warnings.
    - - debug  8192 # Non-fatal errors

    If you - are having trouble with a filter, please additionally enable - -

    - debug    64 # debug regular expression filters

    If - you are using Privoxy 3.0.17 or later and suspect that it - interprets the request or the response incorrectly, please enable - -

    - debug 32768 # log all data read from the network

    Note - that Privoxy log files may contain sensitive information so - please don't submit any logfiles you didn't read first. You can - mask sensitive information as long as it's clear that you removed - something. -
    • -
- -

You don't have to tell us your actual name when filing a problem - report, but if you don't, please use a nickname so we can - differentiate between your messages and the ones entered by other - "anonymous" users that may respond to your request if they have the - same problem or already found a solution. Note that due to spam the - trackers may not always allow to post without being logged into - SourceForge. If that's the case, you are still free to create a login - that isn't directly linked to your name, though.

- -

Please also check the status of your request a few days after - submitting it, as we may request additional information. If you use a - SF id, you should automatically get a mail when someone responds to - your request. Please don't bother to add an email address when using - the tracker. If you prefer to communicate through email, just use one - of the mailing lists directly.

- -

If you are new to reporting problems, you might be interested in - How to Report Bugs Effectively.

- -

The appendix of the Privoxy User Manual also has - helpful information on understanding actions, and action - debugging.

-

11.3. +

11.4. Request New Features

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

-

11.4. +

11.5. Mailing Lists

If you prefer to communicate through email, instead of using a web diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html index 875a830c..c55e69e8 100644 --- a/doc/webserver/user-manual/copyright.html +++ b/doc/webserver/user-manual/copyright.html @@ -51,7 +51,7 @@ "CITETITLE">GNU General Public License.

-

12.1. License

+

12.1. License

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

-

9.1. Filter File +

9.1. Filter File Tutorial

Now, let's complete our "foo" content diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html index e0b68be3..6c891d0e 100644 --- a/doc/webserver/user-manual/index.html +++ b/doc/webserver/user-manual/index.html @@ -23,7 +23,7 @@ 2001-2013 by Privoxy Developers

-

$Id: user-manual.sgml,v 2.163 2013/01/18 12:31:41 +

$Id: user-manual.sgml,v 2.165 2013/01/20 18:10:28 fabiankeil Exp $

@@ -153,25 +153,18 @@
-
5.1. Red Hat and - Fedora
+
5.1. Debian
-
5.2. Debian
+
5.2. Windows
-
5.3. Windows
- -
5.4. Solaris, NetBSD, +
5.3. Solaris, NetBSD, FreeBSD, HP-UX and others
-
5.5. OS/2
- -
5.6. Mac OS X
+
5.4. OS/2
-
5.7. AmigaOS
+
5.5. Mac OS X
-
5.8. Gentoo
- -
5.9. Command Line +
5.6. Command Line Options
@@ -180,7 +173,7 @@
-
6.1. Controlling Privoxy +
6.1. Controlling Privoxy with Your Web Browser
6.2. Configuration @@ -349,10 +342,10 @@
-
8.1. Finding the Right +
8.1. Finding the Right Mix
-
8.2. How to Edit
+
8.2. How to Edit
8.3. How Actions are Applied to Requests
@@ -362,10 +355,10 @@
-
8.4.1. The Domain +
8.4.1. The Domain Pattern
-
8.4.2. The Path +
8.4.2. The Path Pattern
8.4.3. The Tag @@ -479,7 +472,7 @@ "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker
8.5.35. Summary
+ "actions-file.html#AEN4740">Summary
@@ -491,13 +484,13 @@
8.7.1. match-all.action
+ "actions-file.html#AEN4804">match-all.action
8.7.2. default.action
+ "actions-file.html#AEN4826">default.action
8.7.3. user.action
+ "actions-file.html#AEN4939">user.action
@@ -507,7 +500,7 @@
-
9.1. Filter File +
9.1. Filter File Tutorial
9.2. The @@ -522,26 +515,29 @@
-
11.1. Get +
11.1. Please + provide sufficient information
+ +
11.2. Get Support
-
11.2. Reporting +
11.3. Reporting Problems
-
11.2.1. Reporting Ads +
11.3.1. Reporting Ads or Other Configuration Problems
-
11.2.2. Reporting +
11.3.2. Reporting Bugs
-
11.3. Request New +
11.4. Request New Features
-
11.4. Mailing +
11.5. Mailing Lists
@@ -551,7 +547,7 @@
-
12.1. License
+
12.1. License
12.2. History
@@ -568,7 +564,7 @@
14.1. Regular Expressions
-
14.2. Privoxy's Internal +
14.2. Privoxy's Internal Pages
diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html index f44495bd..d33e87c8 100644 --- a/doc/webserver/user-manual/quickstart.html +++ b/doc/webserver/user-manual/quickstart.html @@ -343,7 +343,7 @@ "GUIBUTTON">Edit":

- +

Figure 1. Actions Files in Use

diff --git a/doc/webserver/user-manual/startup.html b/doc/webserver/user-manual/startup.html index 45545a6d..49c1d507 100644 --- a/doc/webserver/user-manual/startup.html +++ b/doc/webserver/user-manual/startup.html @@ -55,7 +55,7 @@ protocols.

- +

Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and HTTPS (SSL) Settings

@@ -112,7 +112,7 @@ only HTTP and HTTPS (SSL)!

- +

Figure 3. Proxy Configuration Showing Internet Explorer HTTP and HTTPS (Secure) Settings

@@ -137,38 +137,7 @@ will try config.txt.

-

5.1. Red Hat - and Fedora

- -

A default Red Hat installation may not start Privoxy upon boot. It will use the file /etc/privoxy/config as its main configuration file.

- - - - - -
- 
- # /etc/rc.d/init.d/privoxy start
-
-
- -

Or ...

- - - - - -
- 
- # service privoxy start
-
-
-
- -
-

5.2. +

5.1. Debian

We use a script. Note that Debian typically starts

-

5.3. +

5.2. Windows

Click on the Privoxy Icon to start @@ -209,7 +178,7 @@

-

5.4. +

5.3. Solaris, NetBSD, FreeBSD, HP-UX and others

Example Unix startup command:

@@ -226,7 +195,7 @@

-

5.5. OS/2

+

5.4. OS/2

During installation, Privoxy is configured to start automatically when the system restarts. You can @@ -236,7 +205,7 @@

-

5.6. Mac OS +

5.5. Mac OS X

After downloading the privoxy software, unzip the downloaded file by @@ -264,55 +233,7 @@

-

5.7. - 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).

-
- -
-

5.8. - 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
-
-
-
-
- -
-

5.9. Command +

5.6. Command Line Options

Privoxy may be invoked with the diff --git a/doc/webserver/user-manual/whatsnew.html b/doc/webserver/user-manual/whatsnew.html index 216cae84..57f52b5c 100644 --- a/doc/webserver/user-manual/whatsnew.html +++ b/doc/webserver/user-manual/whatsnew.html @@ -900,11 +900,6 @@ yourself.

-
  • -

    standard.action has been merged into - the default.action file.

    -
    • -

  • In the default configuration only fatal errors are logged now. You can change that in the debug -- 2.49.0