*** empty log message ***
[privoxy.git] / doc / text / user-manual.txt
index 8ff73fd..dd5865f 100644 (file)
@@ -59,15 +59,15 @@ New Features
 In addition to Junkbuster's traditional features of ad and banner blocking and
 cookie management, this is a list of new features currently under development:
 
-  * Modularized configuration that will allow for system wide settings, and
-    individual user settings.
+  * A browser based configuration utility (WIP at http://i.j.b).
    
-  * A browser based GUI configuration utility (not finished).
+  * Modularized configuration that will allow for system wide settings, and
+    individual user settings. (not implemented yet)
    
   * Blocking of annoying pop-up browser windows (previously available as a
     patch).
    
-  * Partial support for HTTP/1.1.
+  * Support for HTTP/1.1 (partially implemented at this point).
    
   * Support for Perl Compatible Regular Expressions in the configuration files,
     and generally a more sophisticated configuration syntax over previous
@@ -77,6 +77,8 @@ cookie management, this is a list of new features currently under development:
    
   * Multi-threaded.
    
+In addition, the configuration is more versatile overall.
+
 -------------------------------------------------------------------------------
 
 Installation
@@ -109,7 +111,7 @@ tree.
 
 Then, in either case, to build from source:
 
- autoconf       #recommended for CVS source                                    
+ autoconf           #recommended for CVS source                                
  ./configure                                                                   
  make                                                                          
  su                                                                            
@@ -124,7 +126,7 @@ Red Hat
 
 To build Redhat RPM packages, install source as above. Then:
 
- autoconf       #recommended for CVS source                                    
+ autoconf              #recommended for CVS source                             
  ./configure                                                                   
  make redhat-dist                                                              
                                                                                
@@ -149,7 +151,7 @@ SuSE
 
 To build SuSE RPM packages, install source as above. Then:
 
- autoconf       #recommended for CVS source                                    
+ autoconf             #recommended for CVS source                              
  ./configure                                                                   
  make suse-dist                                                                
                                                                                
@@ -234,10 +236,11 @@ there are only three default configuration files (this will change in time):
   * The main configuration file is named config on Linux, Unix, BSD, and OS/2,
     and junkbustr.txt on Windows. On Amiga, it is AmiTCP:db/junkbuster/config.
    
-  * The actionsfile file is used to define various actions relating to images,
-    banners, pop-ups, banners and cookies. There is a CGI based editor for this
-    file that can be accessed via http://ijbswa.sourceforge.net/config/. (Still
-    under active development.)
+  * The actionsfile file is used to define various "actions" relating to
+    images, banners, pop-ups, access restrictions, banners and cookies. There
+    is a CGI based editor for this file that can be accessed via http://i.j.b./
+    . This is the easiest method of configuring actions. (Still under active
+    development.)
    
   * The re_filterfile file can be used to rewrite the raw page content,
     including text as well as embedded HTML and JavaScript.
@@ -247,6 +250,11 @@ maximum flexibility. All files use the "#" character to denote a comment. Such
 lines are not processed by Junkbuster. After making any changes, restart
 Junkbuster in order for the changes to take effect.
 
+While under development, the configuration content is subject to change. The
+below documentation may not be accurate by the time you read this. Also, what
+constitutes a "default" setting, may change, so please check all your
+configuration files on important issues.
+
 -------------------------------------------------------------------------------
 
 The Main Configuration File
@@ -404,10 +412,10 @@ under proxy configuration, list the proxy server as "localhost" and the port as
 If you already have another service running on port 8000, or if you want to
 serve requests from other machines (e.g. on your local network) as well, you
 will need to override the default. The syntax is "listen-address
-[<ip-address>]:<port>". If you leave out the IP adress, junkbuster will bind to
-all interfaces (addresses) on your machine and may become reachable from the
-internet. In that case, consider using access control lists (acl's) (see
-"aclfile" above).
+[<ip-address>]:<port>". If you leave out the IP address, junkbuster will bind
+to all interfaces (addresses) on your machine and may become reachable from the
+Internet. In that case, consider using access control lists (acl's) (see
+"aclfile" above), or a firewall.
 
 For example, suppose you are running Junkbuster on a machine which has the
 address 192.168.0.1 on your local private network (192.168.0.0) and has another
@@ -479,23 +487,24 @@ Default: Multi-threaded mode.
 "toggle" allows you to temporarily disable all Junkbuster's filtering. Just set
 "toggle 0".
 
-The Windows version of Junkbuster puts an icon in the system tray, which allows
-you to change this option without having to edit this file. If you right-click
-on that icon (or select the "Options" menu), one choice is "Enable". Clicking
-on enable toggles Junkbuster on and off. This is useful if you want to
-temporarily disable Junkbuster, e.g., to access a site that requires cookies
-which you normally have blocked.
+The Windows version of Junkbuster puts an icon in the system tray, which also
+allows you to change this option. If you right-click on that icon (or select
+the "Options" menu), one choice is "Enable". Clicking on enable toggles
+Junkbuster on and off. This is useful if you want to temporarily disable
+Junkbuster, e.g., to access a site that requires cookies which you normally
+have blocked. This can also be toggled via a web browser at the Junkbuster
+internal address of http://i.j.b./ on any platform.
 
 "toggle 1" means Junkbuster runs normally, "toggle 0" means that Junkbuster
-becomes a non-anonymizing non-blocking proxy. Default: 1.
+becomes a non-anonymizing non-blocking proxy. Default: 1 (on).
 
   toggle 1
    
 
 For content filtering, i.e. the "+filter" and "+deanimate-gif" actions, it is
-neccessary that Junkbuster buffers up the entire document body. This can be
+neccessary that Junkbuster buffers the entire document body. This can be
 potentially dangerous, since a server could just keep sending data indefinitely
-and wait for your RAM to exhaust.
+and wait for your RAM to exhaust. With nasty consequences.
 
 The buffer-limit option lets you set the maximum size in Kbytes that each
 buffer may use. When the documents buffer exceeds this size, it is flushed to
@@ -510,7 +519,7 @@ increasing the "buffer-limit" Kbytes each, unless you have enabled
 To enable the web-based actionsfile editor set enable-edit-actions to 1, or 0
 to disable. Note that you must have compiled JunkBuster with support for this
 feature, otherwise this option has no effect. This internal page can be reached
-at http://ijbswa.sourceforge.net/config/.
+at http://i.j.b./.
 
 Security note: If this is enabled, anyone who can use the proxy can edit the
 actions file, and their changes will affect all users. For shared proxies, you
@@ -525,8 +534,8 @@ compiled JunkBuster with support for this feature, otherwise this option has no
 effect.
 
 Security note: If this is enabled, anyone who can use the proxy can toggle it
-on or off, and their changes will affect all users. For shared proxies, you
-probably want to disable this. Default: enabled.
+on or off (see http://i.j.b./), and their changes will affect all users. For
+shared proxies, you probably want to disable this. Default: enabled.
 
   enable-remote-toggle 1
    
@@ -864,8 +873,12 @@ compared to all patterns in this file. Every time it matches, the list of
 applicable actions for the URL is incrementally updated. You can trace this
 process by visiting http://i.j.b/show-url-info.
 
+The actions file can be edited with a browser by loading http://i.j.b, and then
+select "Edit Actions".
+
 There are four types of lines in this file: comments (begin with a "#"
-character), actions, aliases and patterns, all of which are explained below.
+character), actions, aliases and patterns, all of which are explained below, as
+well as the configuration file syntax that Junkbuster understands. 
 
 -------------------------------------------------------------------------------
 
@@ -1378,9 +1391,9 @@ Debug -> Networking. Or set the "+downgrade" config option in actionsfile.
 After running Junkbuster 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" (from
-actionsfile) can be adjusted by pointing your browser to http://
-ijbswa.sourceforge.net/config/, and then follow the link to "edit the actions
-list". (This is an internal page and does not require Internet access.)
+actionsfile) can be adjusted by pointing your browser to http://i.j.b./, 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 Junkbuster configuration can be viewed from this
 page, including current configuration parameters, source code version numbers,
@@ -1445,7 +1458,7 @@ See also
 
   http://ijbswa.sourceforge.net/
 
-  http://ijbswa.sourceforge.net/config/
+  http://i.j.b./
 
   http://www.junkbusters.com/ht/en/cookies.html