From e1cb1adbdddac3bd536132926479436743fe46a0 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Mon, 6 Oct 2014 10:20:31 +0000 Subject: [PATCH] Rebuild docs --- AUTHORS | 1 + doc/webserver/faq/configuration.html | 14 ++-- doc/webserver/faq/copyright.html | 4 +- doc/webserver/faq/general.html | 78 +++++++++------------ doc/webserver/faq/index.html | 40 +++++------ doc/webserver/faq/misc.html | 18 ++--- doc/webserver/faq/trouble.html | 4 +- doc/webserver/user-manual/actions-file.html | 16 ++--- doc/webserver/user-manual/appendix.html | 28 ++++---- doc/webserver/user-manual/config.html | 39 +++++------ doc/webserver/user-manual/copyright.html | 1 + doc/webserver/user-manual/filter-file.html | 14 +++- doc/webserver/user-manual/index.html | 18 ++--- doc/webserver/user-manual/startup.html | 4 +- 14 files changed, 139 insertions(+), 140 deletions(-) diff --git a/AUTHORS b/AUTHORS index 739fae45..05fc0736 100644 --- a/AUTHORS +++ b/AUTHORS @@ -54,6 +54,7 @@ alphabetical order): Clifford Caoile Edward Carrel Wan-Teh Chang + Sam Chen Ramkumar Chinchani Billy Crook Frédéric Crozat diff --git a/doc/webserver/faq/configuration.html b/doc/webserver/faq/configuration.html index 35192061..06c793d9 100644 --- a/doc/webserver/faq/configuration.html +++ b/doc/webserver/faq/configuration.html @@ -42,7 +42,7 @@ Configuration
-

3.1. What exactly is an +

3.1. What exactly is an "actions" file?

Privoxy utilizes the concept of @@ -88,7 +88,7 @@

-

3.3. How are actions +

3.3. How are actions files configured? What is the easiest way to do this?

Actions files are just text files in a special syntax and can be @@ -106,7 +106,7 @@

-

3.4. There are several +

3.4. There are several different "actions" files. What are the differences?

@@ -299,7 +299,7 @@

-

3.11. What is the +

3.11. What is the default.filter file? What is a "filter"?

@@ -410,7 +410,7 @@

-

3.13. Instead of ads, +

3.13. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.

@@ -437,7 +437,7 @@

-

3.14. Why would anybody +

3.14. Why would anybody want to see a checkerboard pattern?

Remember that telling which image @@ -453,7 +453,7 @@

-

3.15. I see some images +

3.15. I see some images being replaced with text instead of the checkerboard image. Why and how do I get rid of this?

diff --git a/doc/webserver/faq/copyright.html b/doc/webserver/faq/copyright.html index 38f29b73..19e484a4 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/general.html b/doc/webserver/faq/general.html index b9119fba..8635eae4 100644 --- a/doc/webserver/faq/general.html +++ b/doc/webserver/faq/general.html @@ -523,51 +523,39 @@

-

Privoxy is developed by unpaid - volunteers and thus our current running costs are pretty low. - Nevertheless, we have plans that will cost money in the future. They - include, but aren't limited to spending money on:

- -
    -
  • -

    Hardware to help make sure Privoxy keeps running on platforms the - developers currently can't test on and can be ported to - others.

    -
    • - -
  • -

    Technical books to educate our developers about said platforms - or to improve their knowledge in general.

    -
    • - -
  • -

    More reliable hosting,

    -
    • -
- -

We would like to get this money through donations made by our - users.

- -

Privoxy has therefore become an - associated project of Software in the Public Interest (SPI), which allows us to - receive donations. In the United States they are tax-deductible, in a - few other western countries they might be tax-deductible in the - future.

- -

If you read this section before you may notice that paying for the - project domain privoxy.org is no longer on the list. It has been - transferred to SPI is sponsored by Mythic Beasts Ltd.

- -

If you enjoy our software and feel like helping out with a - donation, please have a look at SPI's donation - page to see what the options are. If you have any questions - regarding donations please mail to either the public user mailing - list or, if it's a private matter, to Fabian Keil (Privoxy's - SPI liason) directly.

+

Donations are welcome. Our TODO list is rather long and being able to pay one + (or more) developers to work on Privoxy a couple of weeks in a row + would make a huge difference.

+ +

Privoxy is an associated project + of Software in the + Public Interest (SPI), which allows us to receive tax-deductible + donations in the United States. If you want to donate through SPI, + please use SPI's donation page to see what the options are.

+ +

You can also donate to Privoxy using a bank account managed by + Zwiebelfreunde + e.V.:

+ +

+  Name on Account: Zwiebelfreunde e.V.
+  IBAN: DE95430609671126825604
+  BIC: GENODEM1GLS
+  Bank: GLS Bank

+ +

Donations made through Zwiebelfreunde e.V. are tax-deductible in + Germany and other countries that recognize German charitable clubs. + Feel free to use the Subject field to provide a name to be credited + and a list of TODO list items you are interested in the most. For + example: Max Mustermann: #16, #1, #14.

+ +

If you have any questions regarding donations please mail to + either the public user mailing list or, if it's a private matter, to + Fabian Keil + (Privoxy's SPI liason) directly.

diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html index 0f486469..eb5a1970 100644 --- a/doc/webserver/faq/index.html +++ b/doc/webserver/faq/index.html @@ -182,17 +182,17 @@
-
3.1. What exactly is an +
3.1. What exactly is an "actions" file?
3.2. The "actions" concept confuses me. Please list some of these "actions".
-
3.3. How are actions +
3.3. How are actions files configured? What is the easiest way to do this?
-
3.4. There are several +
3.4. There are several different "actions" files. What are the differences?
@@ -217,21 +217,21 @@ change the configuration with a browser? Does that not raise security issues? -
3.11. What is the +
3.11. What is the default.filter file? What is a "filter"?
3.12. How can I set up Privoxy to act as a proxy for my LAN?
-
3.13. Instead of ads, now +
3.13. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.
-
3.14. Why would anybody +
3.14. Why would anybody want to see a checkerboard pattern?
-
3.15. I see some images +
3.15. I see some images being replaced with text instead of the checkerboard image. Why and how do I get rid of this?
@@ -292,7 +292,7 @@
-
4.1. How much does Privoxy slow my +
4.1. How much does Privoxy slow my browsing down? This has to add extra time to browsing.
4.2. I notice considerable @@ -313,32 +313,32 @@
4.7. How can I hide my IP address?
-
4.8. Can Privoxy guarantee I am +
4.8. Can Privoxy guarantee I am anonymous?
-
4.9. A test site says I am not +
4.9. A test site says I am not using a Proxy.
4.10. How do I use Privoxy together with Tor?
-
4.11. Might some things break +
4.11. Might some things break because header information or content is being altered?
-
4.12. Can Privoxy act as a +
4.12. Can Privoxy act as a "caching" proxy to speed up web browsing?
-
4.13. What about as a firewall? +
4.13. What about as a firewall? Can Privoxy protect me?
-
4.14. I have large empty spaces / +
4.14. I have large empty spaces / a checkerboard pattern now where ads used to be. Why?
-
4.15. How can Privoxy filter +
4.15. How can Privoxy filter Secure (HTTPS) URLs?
-
4.16. Privoxy runs as a +
4.16. Privoxy runs as a "server". How secure is it? Do I need to take any special precautions?
@@ -387,14 +387,14 @@
-
5.1. I cannot connect to any +
5.1. I cannot connect to any websites. Or, I am getting "connection refused" message with every web page. Why?
5.2. Why am I getting a 503 Error (WSAECONNREFUSED) on every page?
-
5.3. I just added a new rule, +
5.3. I just added a new rule, but the steenkin ad is still getting through. How?
5.4. One of my favorite sites @@ -520,9 +520,9 @@
-
7.1. License
+
7.1. License
-
7.2. History
+
7.2. History
diff --git a/doc/webserver/faq/misc.html b/doc/webserver/faq/misc.html index 7ff717fe..42fcd345 100644 --- a/doc/webserver/faq/misc.html +++ b/doc/webserver/faq/misc.html @@ -41,7 +41,7 @@

4. Miscellaneous

-

4.1. How much does +

4.1. How much does Privoxy slow my browsing down? This has to add extra time to browsing.

@@ -201,7 +201,7 @@

-

4.8. Can Privoxy +

4.8. Can Privoxy guarantee I am anonymous?

No. Your chances of remaining anonymous are improved, but unless you @@ -246,7 +246,7 @@

-

4.9. A test site says I +

4.9. A test site says I am not using a Proxy.

Good! Actually, they are probably testing for some other kinds of @@ -369,7 +369,7 @@

-

4.11. Might some things +

4.11. Might some things break because header information or content is being altered?

Definitely. It is common for sites to use browser type, browser @@ -409,7 +409,7 @@

-

4.12. Can Privoxy act as +

4.12. Can Privoxy act as a "caching" proxy to speed up web browsing?

@@ -425,7 +425,7 @@

-

4.13. What about as a +

4.13. What about as a firewall? Can Privoxy protect me?

Not in the way you mean, or in the way some firewall vendors claim @@ -436,7 +436,7 @@

-

4.14. I have large empty +

4.14. I have large empty spaces / a checkerboard pattern now where ads used to be. Why?

It is technically possible to eliminate banners and ads in a way @@ -464,7 +464,7 @@

-

4.15. How can Privoxy +

4.15. How can Privoxy filter Secure (HTTPS) URLs?

Since secure HTTP connections are encrypted SSL sessions between @@ -498,7 +498,7 @@

-

4.16. Privoxy runs as a +

4.16. Privoxy runs as a "server". How secure is it? Do I need to take any special precautions?

diff --git a/doc/webserver/faq/trouble.html b/doc/webserver/faq/trouble.html index 213d4a96..94bf0363 100644 --- a/doc/webserver/faq/trouble.html +++ b/doc/webserver/faq/trouble.html @@ -44,7 +44,7 @@ Troubleshooting

-

5.1. I cannot connect +

5.1. I cannot connect to any websites. Or, I am getting "connection refused" message with every web page. Why?

@@ -94,7 +94,7 @@

-

5.3. I just added a +

5.3. I just added a new rule, but the steenkin ad is still getting through. How?

If the ad had been displayed before you added its URL, it will diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 8f0f2b32..c9652e6c 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 @@ -644,7 +644,7 @@

-

8.4.2. The Path +

8.4.2. The Path Pattern

Privoxy uses

-

8.5.36. +

8.5.36. Summary

Note that many of these actions have the potential to cause a page @@ -4648,7 +4648,7 @@ TAG:^image/ together:

-

8.7.1. +

8.7.1. match-all.action

Remember all actions @@ -4697,7 +4697,7 @@ TAG:^image/

-

8.7.2. +

8.7.2. default.action

If you aren't a developer, there's no need for you to edit the @@ -5040,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 22b40dca..038b1760 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 @@

@@ -724,20 +716,21 @@

Depending on the debug options below, the logfile may be a privacy risk if third parties can get access to it. As most users will never look at it, Privoxy 3.0.7 and later only log fatal - errors by default.

+ "APPLICATION">Privoxy only logs fatal errors by + default.

For most troubleshooting purposes, you will have to change that, please refer to the debugging section for details.

-

Your logfile will grow indefinitely, and you will probably - want to periodically remove it. On Unix systems, you can do - this with a cron job (see "man - cron").

-

Any log files must be writable by whatever user Privoxy is being run as (on Unix, default user id is "privoxy").

+ +

To prevent the logfile from growing indefinitely, it is + recommended to periodically rotate or shorten it. Many + operating systems support log rotation out of the box, some + require additional software to do it. For details, please refer + to the documentation for your operating system.

@@ -907,11 +900,6 @@ problem. They can produce a hell of an output (especially 16).

-

Privoxy used to ship with - the debug levels recommended above enabled by default, but due - to privacy concerns 3.0.7 and later are configured to only log - fatal errors.

-

If you are used to the more verbose settings, simply enable the debug lines below again.

@@ -2882,6 +2870,15 @@ limit the resources used by Privoxy.

+

Another relevant limit to keep in mind is the maximum number + of file descriptors the operating system is enforcing. + Privoxy needs two file + descriptors for each client request that isn't answered by + Privoxy itself and one for + each configuration file. Therefore it's reasonable to limit the + client connections to a bit less that half the number of file + descriptors Privoxy is allowed to use.

+

If Privoxy is only used by a single trusted user, limiting the number of client connections is probably unnecessary. If there are multiple diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html index 6864deed..efee2299 100644 --- a/doc/webserver/user-manual/copyright.html +++ b/doc/webserver/user-manual/copyright.html @@ -506,6 +506,7 @@ Public License instead of this License.  Clifford Caoile
 Edward Carrel
 Wan-Teh Chang
+  Sam Chen
 Ramkumar Chinchani
 Billy Crook
 Frédéric Crozat
diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html index c3c080b0..15472717 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 @@ -388,6 +388,18 @@ s/(<body [^>]*)onunload(.*>)/$1never$2/iU contain "OnUnload", but the page's content does.

+ + + + +
+ 
+# Completely removeKill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
+#
+s/(<body [^>]*)onunload(.*>)/$1never$2/iU
+
+
+

The last example is from the fun department:

diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html index becab072..6a0e65f9 100644 --- a/doc/webserver/user-manual/index.html +++ b/doc/webserver/user-manual/index.html @@ -348,10 +348,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
@@ -364,7 +364,7 @@
8.4.1. The Host Pattern
-
8.4.2. The Path +
8.4.2. The Path Pattern
8.4.3. The Tag @@ -485,7 +485,7 @@ "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker
8.5.36. Summary
+ "actions-file.html#AEN4920">Summary
@@ -497,13 +497,13 @@
8.7.1. match-all.action
+ "actions-file.html#AEN4984">match-all.action
8.7.2. default.action
+ "actions-file.html#AEN5006">default.action
8.7.3. user.action
+ "actions-file.html#AEN5119">user.action
@@ -513,7 +513,7 @@
-
9.1. Filter File +
9.1. Filter File Tutorial
9.2. The @@ -584,7 +584,7 @@
14.1. Regular Expressions
-
14.2. Privoxy's Internal +
14.2. Privoxy's Internal Pages
diff --git a/doc/webserver/user-manual/startup.html b/doc/webserver/user-manual/startup.html index 4d2418a0..6ef5d8a3 100644 --- a/doc/webserver/user-manual/startup.html +++ b/doc/webserver/user-manual/startup.html @@ -57,11 +57,11 @@
-

Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and +

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

-

+

-- 2.39.2