From dcb6d2261f6cc345036a0054be5904667754a2ab Mon Sep 17 00:00:00 2001 From: hal9 Date: Sat, 30 Mar 2002 04:15:53 +0000 Subject: [PATCH] - Fix privoxy.org/config links. - Paste in Bookmarklets from Toggle page. - Move Quickstart nearer top, and minor rework. --- doc/source/user-manual.sgml | 512 +++++++++++++++++++++--------------- 1 file changed, 300 insertions(+), 212 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index bca86a33..8f6ab5fb 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -6,7 +6,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.60 2002/03/27 01:57:34 hal9 Exp $ + $Id: user-manual.sgml,v 1.61 2002/03/29 01:31:08 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -28,7 +28,7 @@ Hal Burgiss Privoxy User Manual -$Id: user-manual.sgml,v 1.60 2002/03/27 01:57:34 hal9 Exp $ +$Id: user-manual.sgml,v 1.61 2002/03/29 01:31:08 hal9 Exp $ @@ -203,6 +203,12 @@ You can find the latest version of the user manual at Quickstart to Using <application>Privoxy</application> + + Before launching Privoxy for the first time, you + will want to configure your browser(s) to use Privoxy + and the HTTP and HTTPS proxy. The default is localhost for the proxy address, + and port 8118 (earlier versions used port 800). This is the one required + configuration that must be done! + + + + With Netscape (and + Mozilla), this can be set under Edit + -> Preferences -> Advanced -> Proxies -> HTTP Proxy. + For Internet Explorer: Tools > + Internet Properties -> Connections -> LAN Setting. Then, + check Use Proxy and fill in the appropriate info (Address: + localhost, Port: 8118). Include if HTTPS proxy support too. + + + + After doing this, flush your browser's disk and memory caches to force a + re-reading of all pages and get rid of any ads that may be cached. You + are now ready to start enjoying the benefits of using + Privoxy. + + + + + Privoxy is typically started by specifying the + main configuration file to be used on the command line. Example Unix startup + command: + + + + + + # /usr/sbin/privoxy /etc/privoxy/config + + + + + + An init script is provided for SuSE and Redhat. + + + +For for SuSE: /etc/rc.d/privoxy start + + + +For RedHat: /etc/rc.d/init.d/privoxy start + + + + + If no configuration file is specified on the command line, + Privoxy will look for a file named + config in the current directory. Except on Win32 where + it will try config.txt. If no file is specified on the + command line and no default configuration file can be found, + Privoxy will fail to start. + + + + + The included default configuration files should give a reasonable starting + point, though may be somewhat aggressive in blocking junk. Most of the + per site configuration is done in the actions files. These + are where various cookie actions are defined, ad and banner blocking, + and other aspects of Privoxy configuration. There + are several such files included, with varying levels of aggressiveness. + + + + You will probably want to keep an eye out for sites that require persistent + cookies, and add these to default.action as needed. By + default, most of these will be accepted only during the current browser + session, until you add them to the configuration. If you want the browser to + handle this instead, you will need to edit + default.action and disable this feature. If you use more + than one browser, it would make more sense to let + Privoxy handle this. In which case, the browser(s) + should be set to accept all cookies. + + + + Privoxy is HTTP/1.1 compliant, but not all 1.1 + features are as yet implemented. If browsers that support HTTP/1.1 (like + Mozilla or recent versions of I.E.) experience + problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look + under Edit -> Preferences -> Debug -> Networking. + Or set the +downgrade config option in + default.action. + + + + After running Privoxy for a while, you can + start to fine tune the configuration to suit your personal, or site, + preferences and requirements. There are many, many aspects that can + be customized. Actions (as specified in default.action) + can be adjusted by pointing your browser to + http://p.p/, + and then follow the link to edit the actions list. + (This is an internal page and does not require Internet access.) + + + + In fact, various aspects of Privoxy + configuration can be viewed from this page, including + current configuration parameters, source code version numbers, + the browser's request headers, and actions that apply + to a given URL. In addition to the default.action file + editor mentioned above, Privoxy can also + be turned on and off from this page. + + + + If you encounter problems, please verify it is a + Privoxy bug, by disabling + Privoxy, and then trying the same page. + Also, try another browser if possible to eliminate browser or site + problems. Before reporting it as a bug, see if there is not a configuration + option that is enabled that is causing the page not to load. You can then add + an exception for that page or site. For instance, try adding it to the + {fragile} section of default.action. + This will turn off most actions for this site. For more on troubleshooting + problem sites, see the Appendix. If a bug, please report it + to the developers (see below). + + + + + + +Command Line Options + + Privoxy may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + Privoxy will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + + + + + + + + <application>Privoxy</application> Configuration @@ -487,7 +710,7 @@ configuration section below. HB.) Privoxy can be reached by the special URL http://p.p/ (or alternately - http://www.privoxy.org/config/), + http://config.privoxy.org/), which is an internal page. You will see the following section: @@ -3014,203 +3237,6 @@ icon being being cached by the browser, which will speed up the display. - -Quickstart to Using <application>Privoxy</application> - - Install package, then run and enjoy! Privoxy - is typically started by specifying the main configuration file to be - used on the command line. Example Unix startup command: - - - - - - # /usr/sbin/privoxy /etc/privoxy/config - - - - - - An init script is provided for SuSE and Redhat. - - - -For for SuSE: /etc/rc.d/privoxy start - - - -For RedHat: /etc/rc.d/init.d/privoxy start - - - - - If no configuration file is specified on the command line, - Privoxy will look for a file named - config in the current directory. Except on Win32 where - it will try config.txt. If no file is specified on the - command line and no default configuration file can be found, - Privoxy will fail to start. - - - - Be sure your browser is set to use the proxy which is by default at - localhost, port 8118. With Netscape (and - Mozilla), this can be set under Edit - -> Preferences -> Advanced -> Proxies -> HTTP Proxy. - For Internet Explorer: Tools > - Internet Properties -> Connections -> LAN Setting. Then, - check Use Proxy and fill in the appropriate info (Address: - localhost, Port: 8118). Include if HTTPS proxy support too. - - - - The included default configuration files should give a reasonable starting - point, though may be somewhat aggressive in blocking junk. You will probably - want to keep an eye out for sites that require persistent cookies, and add these to - default.action as needed. By default, most of these will - be accepted only during the current browser session, until you add them to - the configuration. If you want the browser to handle this instead, you will - need to edit default.action and disable this feature. If you - use more than one browser, it would make more sense to let - Privoxy handle this. In which case, the - browser(s) should be set to accept all cookies. - - - - If a particular site shows problems loading properly, try adding it - to the {fragile} section of - default.action. This will turn off most actions for - this site. - - - - Privoxy is HTTP/1.1 compliant, but not all 1.1 - features are as yet implemented. If browsers that support HTTP/1.1 (like - Mozilla or recent versions of I.E.) experience - problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look - under Edit -> Preferences -> Debug -> Networking. - Or set the +downgrade config option in - default.action. - - - - After running Privoxy for a while, you can - start to fine tune the configuration to suit your personal, or site, - preferences and requirements. There are many, many aspects that can - be customized. Actions (as specified in default.action) - can be adjusted by pointing your browser to - http://p.p/, - and then follow the link to edit the actions list. - (This is an internal page and does not require Internet access.) - - - - In fact, various aspects of Privoxy - configuration can be viewed from this page, including - current configuration parameters, source code version numbers, - the browser's request headers, and actions that apply - to a given URL. In addition to the default.action file - editor mentioned above, Privoxy can also - be turned on and off from this page. - - - - If you encounter problems, please verify it is a - Privoxy bug, by disabling - Privoxy, and then trying the same page. - Also, try another browser if possible to eliminate browser or site - problems. Before reporting it as a bug, see if there is not a configuration - option that is enabled that is causing the page not to load. You can - then add an exception for that page or site. If a bug, please report it to - the developers (see below). - - - - - - - -Command Line Options - - Privoxy may be invoked with the following - command-line options: - - - - - - - - --version - - - Print version info and exit, Unix only. - - - - - --help - - - Print a short usage info and exit, Unix only. - - - - - --no-daemon - - - Don't become a daemon, i.e. don't fork and become process group - leader, don't detach from controlling tty. Unix only. - - - - - --pidfile FILE - - - - On startup, write the process ID to FILE. Delete the - FILE on exit. Failiure to create or delete the - FILE is non-fatal. If no FILE - option is given, no PID file will be used. Unix only. - - - - - --user USER[.GROUP] - - - - After (optionally) writing the PID file, assume the user ID of - USER, and if included the GID of GROUP. Exit if the - privileges are not sufficient to do so. Unix only. - - - - - configfile - - - If no configfile is included on the command line, - Privoxy will look for a file named - config in the current directory (except on Win32 - where it will look for config.txt instead). Specify - full path to avoid confusion. - - - - - - - - - - - - - - Contacting the Developers, Bug Reporting and Feature @@ -3601,7 +3627,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma <para> Since <application>Privoxy</application> proxies each requested web page, it is easy for <application>Privoxy</application> to - trap certain URLs. In this way, we can talk directly to + trap certain special URLs. In this way, we can talk directly to <application>Privoxy</application>, and see how it is configured, see how our rules are being applied, change these rules and other configuration options, and even turn @@ -3627,7 +3653,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/">http://www.privoxy.org/config/</ulink> + <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink> </para> </blockquote> <para> @@ -3643,7 +3669,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/show-status">http://www.privoxy.org/config/show-status</ulink> + <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink> </para> </blockquote> </listitem> @@ -3654,7 +3680,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/show-version">http://www.privoxy.org/config/show-version</ulink> + <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink> </para> </blockquote> </listitem> @@ -3665,7 +3691,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/show-request">http://www.privoxy.org/config/show-request</ulink> + <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink> </para> </blockquote> </listitem> @@ -3676,18 +3702,19 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink> + <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink> </para> </blockquote> </listitem> <listitem> <para> - Toggle Privoxy on or off: + Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues + to run, but only as a pass-through proxy, with no actions taking place: </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/toggle">http://www.privoxy.org/config/toggle</ulink> + <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink> </para> </blockquote> <para> @@ -3695,12 +3722,12 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/toggle?set=disable">http://www.privoxy.org/config/toggle?set=disable</ulink> + <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink> </para> </blockquote> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/toggle?set=enable">http://www.privoxy.org/config/toggle?set=enable</ulink> + <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink> </para> </blockquote> </listitem> @@ -3711,7 +3738,7 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> <blockquote> <para> - <ulink url="http://www.privoxy.org/config/edit-actions">http://www.privoxy.org/config/edit-actions</ulink> + <ulink url="http://config.privoxy.org/edit-actions">http://config.privoxy.org/edit-actions</ulink> </para> </blockquote> </listitem> @@ -3724,6 +3751,64 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma </para> +<sect3 id="bookmarklets"> +<title>Bookmarklets + + Here are some bookmarklets to allow you to easily access a + mini version of this page. They are designed for MS Internet + Explorer, but should work equally well in Netscape, Mozilla, and other + browsers which support JavaScript. They are designed to run directly from + your bookmarks - not by clicking the links below (although that will work for + testing). + + + To save them, right-click the link and choose Add to Favorites + (IE) or Add Bookmark (Netscape). You will get a warning that + the bookmark may not be safe - just click OK. Then you can run the + Bookmarklet directly from your favourites/bookmarks. For even faster access, + you can put them on the Links bar (IE) or the Personal + Toolbar (Netscape), and run them with a single click. + + + + + + + + Enable Privoxy + + + + + + Disable Privoxy + + + + + + Toggle Privoxy (Toggles between enabled and disabled) + + + + + + View Privoxy Status + + + + + + + + Credit: The site which gave me the general idea for these bookmarklets is + www.bookmarklets.com. They + have more information about bookmarklets. + + + + + @@ -3741,7 +3826,7 @@ For any other issues, feel free to use the http://www.privoxy.org/config/show-url-info + http://config.privoxy.org/show-url-info page that can show us very specifically how actions are being applied to any given URL. This is a big help for troubleshooting. @@ -4021,6 +4106,9 @@ For any other issues, feel free to use the