From: swa <swa@users.sourceforge.net> Date: Fri, 26 Apr 2002 17:24:31 +0000 (+0000) Subject: bookmarks cleaned, changed structure of user manual, screen and programlisting cleanu... X-Git-Tag: v_3_0_branchpoint~202 X-Git-Url: http://www.privoxy.org/gitweb/@default-cgi@/faq/%22https:/developer-manual/static/@default-cgi@toggle?a=commitdiff_plain;h=6956ba51e2d97c18695d2fa5bf5e549ff4f75ca2;p=privoxy.git bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot --- diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index e40d991b..3c09f25c 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: buildsource.sgml,v 1.5 2002/04/18 12:11:50 oes Exp $ + $Id: buildsource.sgml,v 1.6 2002/04/26 05:25:23 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -43,7 +43,7 @@ <screen> tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz] cd privoxy-&p-version;<![%p-not-stable;[-beta]]> - </screen> +</screen> </para> <para> @@ -57,7 +57,7 @@ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current cd current - </screen> +</screen> </para> <para> @@ -78,7 +78,7 @@ su make -n install # (to see where all the files will go) make install # (to really install) - </screen> +</screen> </para> <para> @@ -89,7 +89,7 @@ <para> <screen> make - </screen> +</screen> </para> <para> diff --git a/doc/source/contacting.sgml b/doc/source/contacting.sgml index a09e76cf..b55b3511 100644 --- a/doc/source/contacting.sgml +++ b/doc/source/contacting.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: contacting.sgml,v 1.9 2002/04/26 05:25:23 hal9 Exp $ + $Id: contacting.sgml,v 1.10 2002/04/26 12:06:52 swa Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -31,24 +31,27 @@ <para> We value your feedback. However, to provide you with the best support, please - note: - - <itemizedlist> + note the following sections. +</para> - <listitem> +<sect2 id="contact-support"><title>Get Support</title> + <para> <literallayout class="normal"> -Use the Sourceforge Support Forum to get help: - +To get support, use the Sourceforge Support Forum: + <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">http://sourceforge.net/tracker/?group_id=11118&atid=211118</ulink> </literallayout> - </listitem> - - <listitem> + </para> +</sect2> + +<sect2 id="contact-bugs"><title>Report bugs</title> + <para> <literallayout class="normal"> -Submit bugs only through our Sourceforge Bug Forum: - +To submit bugs, use the Sourceforge Bug Forum: + <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">http://sourceforge.net/tracker/?group_id=11118&atid=111118</ulink>. </literallayout> + </para> <para> Make sure that the bug has not already been submitted. Please try to verify that it is a <application>Privoxy</application> bug, and not a @@ -60,39 +63,45 @@ Submit bugs only through our Sourceforge Bug Forum: pertinent log data, any other relevant details (please be specific) and, if possible, some way to reproduce the bug. </para> - </listitem> - - <listitem> +</sect2> + +<sect2 id="contact-feature"><title>Request new features</title> + <para> <literallayout class="normal"> -Submit feature requests only through our Sourceforge feature request forum: - +To submit ideas on new features, use the Sourceforge feature request forum: + <ulink url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"></ulink>. </literallayout> - </listitem> - + </para> +</sect2> - <listitem> - <literallayout class="normal"> +<sect2 id="contact-ads"><title>Report ads or other filter problems</title> + <para> +<!-- <literallayout class="normal"> --> You can also send feedback on websites that Privoxy has problems with. Please bookmark the following link: <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"><quote>Privoxy - Submit Filter Feedback</quote></ulink>. Once you surf to a page with problems, use the bookmark to send us feedback. We will look into the issue as soon as possible. - </literallayout> - </listitem> - +<!-- </literallayout> --> + </para> +<para> + New, improved <filename>default.action</filename> files will occasionally be made + available based on your feedback. These will be announced on the <ulink + url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink> + list. +</para> +</sect2> - <listitem> +<sect2 id="contact-other"><title>Other</title> + <para> <literallayout class="normal"> For any other issues, feel free to use the mailing lists: <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>. </literallayout> + </para> <para> Anyone interested in actively participating in development and related discussions can also join the appropriate mailing list. Archives are - available, too. + available, too. See the page on Sourceforge. </para> - </listitem> - - </itemizedlist> -</para> - +</sect2> diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 2820f445..2c45d423 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -21,7 +21,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $ + $Id: developer-manual.sgml,v 1.36 2002/04/26 05:25:23 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -44,7 +44,7 @@ <artheader> <title>Privoxy Developer Manual</title> - <pubdate>$Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $</pubdate> + <pubdate>$Id: developer-manual.sgml,v 1.36 2002/04/26 05:25:23 hal9 Exp $</pubdate> <authorgroup> <author> @@ -1720,7 +1720,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting> <para><emphasis>Example for file comments:</emphasis></para> <programlisting> -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.36 2002/04/26 05:25:23 hal9 Exp $"; /********************************************************************* * * File : $S<!-- Break CVS Substitution -->ource$ @@ -1780,7 +1780,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; <programlisting> #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.36 2002/04/26 05:25:23 hal9 Exp $" /********************************************************************* * * File : $S<!-- Break CVS Substitution -->ource$ @@ -1986,7 +1986,7 @@ at sourceforge. Three simple steps: <para> <programlisting> {+add-header{X-Actions-File-Version: A.B} -filter -no-popups} - </programlisting> +</programlisting> </para> <para> Then change the version info in doc/webserver/actions/index.php, @@ -2035,7 +2035,7 @@ at sourceforge. Three simple steps: cd dist cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current - </programlisting> +</programlisting> </para> <para> @@ -2060,7 +2060,7 @@ at sourceforge. Three simple steps: <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then do: @@ -2068,7 +2068,7 @@ at sourceforge. Three simple steps: <para> <programlisting> make tarball-dist - </programlisting> +</programlisting> </para> <para> To upload the package to Sourceforge, simply issue @@ -2076,7 +2076,7 @@ at sourceforge. Three simple steps: <para> <programlisting> make tarball-upload - </programlisting> +</programlisting> </para> <para> Go to the displayed URL and release the file publicly on Sourceforge. @@ -2095,7 +2095,7 @@ at sourceforge. Three simple steps: <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then do @@ -2103,7 +2103,7 @@ at sourceforge. Three simple steps: <para> <programlisting> make suse-dist (or make redhat-dist) - </programlisting> +</programlisting> </para> <para> To upload the package to Sourceforge, simply issue @@ -2111,7 +2111,7 @@ at sourceforge. Three simple steps: <para> <programlisting> make suse-upload (or make redhat-upload) - </programlisting> +</programlisting> </para> <para> Go to the displayed URL and release the file publicly on Sourceforge. @@ -2128,7 +2128,7 @@ at sourceforge. Three simple steps: <para> <programlisting> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup - </programlisting> +</programlisting> </para> <para> You will need a mix of development tools. @@ -2148,7 +2148,7 @@ at sourceforge. Three simple steps: <para> <programlisting> installExeName='privoxyos2_setup_X.Y.Z.exe' - </programlisting> +</programlisting> </para> <para> Next, edit the <filename>IJB.wis</filename> file so the release number matches @@ -2157,7 +2157,7 @@ at sourceforge. Three simple steps: <para> <programlisting> PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z" - </programlisting> +</programlisting> </para> <para> You're now ready to build. Run: @@ -2165,7 +2165,7 @@ at sourceforge. Three simple steps: <para> <programlisting> os2build - </programlisting> +</programlisting> </para> <para> You will find the WarpIN-installable executable in the @@ -2183,7 +2183,7 @@ at sourceforge. Three simple steps: <para> <programlisting> ssh cf.sourceforge.net - </programlisting> +</programlisting> </para> <para> Choose the right operating system (not the Debian one). @@ -2195,7 +2195,7 @@ at sourceforge. Three simple steps: <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then run @@ -2203,7 +2203,7 @@ at sourceforge. Three simple steps: <para> <programlisting> gmake solaris-dist - </programlisting> +</programlisting> </para> <para> which creates a gzip'ed tar archive. Sadly, you cannot use <command>make @@ -2228,7 +2228,7 @@ at sourceforge. Three simple steps: <para> <programlisting> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup - </programlisting> +</programlisting> </para> <para> Then you can build the package. This is fully automated, and is @@ -2239,7 +2239,7 @@ at sourceforge. Three simple steps: <programlisting> cd winsetup make - </programlisting> +</programlisting> </para> <para> Now you can manually rename <filename>privoxy_setup.exe</filename> to @@ -2259,7 +2259,7 @@ at sourceforge. Three simple steps: <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then do FIXME. @@ -2275,7 +2275,7 @@ at sourceforge. Three simple steps: <para> <programlisting> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup - </programlisting> +</programlisting> </para> <para> Then run: @@ -2284,7 +2284,7 @@ at sourceforge. Three simple steps: <programlisting> cd osxsetup build - </programlisting> +</programlisting> </para> <para> This will run <filename>autoheader</filename>, <filename>autoconf</filename> and @@ -2301,7 +2301,7 @@ at sourceforge. Three simple steps: <para> <programlisting> zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - </programlisting> +</programlisting> </para> <para> You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to @@ -2318,7 +2318,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> ssh cf.sourceforge.net - </programlisting> +</programlisting> </para> <para> Choose the right operating system. @@ -2330,7 +2330,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then run: @@ -2338,7 +2338,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> gmake freebsd-dist - </programlisting> +</programlisting> </para> <para> which creates a gzip'ed tar archive. Sadly, you cannot use <command>make @@ -2359,7 +2359,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then do FIXME. @@ -2376,7 +2376,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then do FIXME. @@ -2390,7 +2390,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> ssh cf.sourceforge.net - </programlisting> +</programlisting> </para> <para> Choose the right operating system. @@ -2402,7 +2402,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <programlisting> cd current autoheader && autoconf && ./configure - </programlisting> +</programlisting> </para> <para> Then run: @@ -2410,7 +2410,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> make aix-dist - </programlisting> +</programlisting> </para> <para> which creates a gzip'ed tar archive. Sadly, you cannot use <command>make @@ -2450,7 +2450,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> make dok # (or make redkat-dok if make dok doesn't work for you) - </programlisting> +</programlisting> </para> <para> That will generate <filename>doc/webserver/user-manual</filename>, @@ -2476,7 +2476,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg <para> <programlisting> make webserver - </programlisting> +</programlisting> </para> <para> This will do the upload to <ulink url="http://www.privoxy.org/">the @@ -2542,6 +2542,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.36 2002/04/26 05:25:23 hal9 + Mass commit to catch a few scattered fixes. + Revision 1.35 2002/04/17 15:16:15 oes Added link to docbook crash course diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml index 4a844610..97e9eddc 100644 --- a/doc/source/faq.sgml +++ b/doc/source/faq.sgml @@ -22,7 +22,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: faq.sgml,v 1.49 2002/04/12 10:10:18 swa Exp $ + $Id: faq.sgml,v 1.50 2002/04/26 05:25:23 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -60,7 +60,7 @@ <artheader> <title>Privoxy Frequently Asked Questions</title> -<pubdate>$Id: faq.sgml,v 1.49 2002/04/12 10:10:18 swa Exp $</pubdate> +<pubdate>$Id: faq.sgml,v 1.50 2002/04/26 05:25:23 hal9 Exp $</pubdate> <authorgroup> <author> @@ -560,6 +560,7 @@ FIXME: Commenting these out until we have some data there. HB 03/17/02. </sect2> --> +<!-- <sect2 renderas="sect3" id="configfiles"> <title>What are the differences between intermediate.action, basic.action, etc.?</title> <para> @@ -584,7 +585,7 @@ following table shows you, which features are enabled in each configuration. <entry>advanced.action</entry> </row> </thead> - +--> <!-- <tfoot> --> <!-- <row> --> <!-- <entry>f1</entry> --> @@ -594,9 +595,9 @@ following table shows you, which features are enabled in each configuration. <!-- <entry>f5</entry> --> <!-- </row> --> <!-- </tfoot> --> - +<!-- <tbody> -<!-- new row --> + <row> <entry>ad-filtering</entry> <entry>?</entry> @@ -604,7 +605,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>blank image</entry> <entry>?</entry> @@ -612,7 +613,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>de-animate GIFs</entry> <entry>?</entry> @@ -620,7 +621,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>referer forging</entry> <entry>?</entry> @@ -628,7 +629,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>jon's +no-cookies-keep (i.e. session cookies only)</entry> <entry>?</entry> @@ -636,7 +637,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>no-popup windows</entry> <entry>?</entry> @@ -644,7 +645,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>fast redirects</entry> <entry>?</entry> @@ -652,7 +653,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>hide-referrer</entry> <entry>?</entry> @@ -660,7 +661,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>hide-useragent</entry> <entry>?</entry> @@ -668,7 +669,7 @@ following table shows you, which features are enabled in each configuration. <entry>x</entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>content-modification</entry> <entry>?</entry> @@ -676,7 +677,7 @@ following table shows you, which features are enabled in each configuration. <entry></entry> <entry>x</entry> </row> -<!-- new row --> + <row> <entry>feature-x</entry> <entry>?</entry> @@ -684,7 +685,7 @@ following table shows you, which features are enabled in each configuration. <entry></entry> <entry></entry> </row> -<!-- new row --> + <row> <entry>feature-y</entry> <entry>?</entry> @@ -692,7 +693,7 @@ following table shows you, which features are enabled in each configuration. <entry></entry> <entry></entry> </row> -<!-- new row --> + <row> <entry>feature-z</entry> <entry>?</entry> @@ -700,13 +701,15 @@ following table shows you, which features are enabled in each configuration. <entry></entry> <entry></entry> </row> -<!-- finish --> + </tbody> </tgroup> </table> </para> </sect2> + --> + <sect2 renderas="sect3" id="browseconfig"> <title>Why can I change the configuration with a browser? Does that not raise security issues?</title> <para> @@ -775,7 +778,7 @@ problem. <para> <screen> listen-address 192.168.1.1:8118 - </screen> +</screen> </para> <para> @@ -1027,10 +1030,7 @@ FIXME: commented out until we have data. HB 03/18/02. <sect2 renderas="sect3" id="newads"><title>How can I submit new ads?</title> <para> - Beginning with <application>Privoxy v2.9.14</application>, missed ads and - banners and other actions file problems, can be submitted by accessing - <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"><quote>actions file feedback system</quote></ulink> - from <ulink url="http://p.p/">http://p.p/</ulink>. +Please see the <ulink url="contact.html">Contact section</ulink>. </para> <para> @@ -1038,14 +1038,6 @@ FIXME: commented out until we have data. HB 03/18/02. or <application>Junkbuster</application>. </para> -<para> - There will soon be regularly updated actions files posted. These - will be announced on the - <ulink - url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink> - list. -</para> - </sect2> <sect2 renderas="sect3" id="ip"><title>How can I hide my IP address?</title> @@ -1358,17 +1350,6 @@ What can I do?</title> </sect2> -<sect2 renderas="sect3" id="bugs"> -<title>Where can I get help? Report bugs? Feature Requests? Etc?</title> -<para> - Feedback is encouraged, whether good, bad or ugly. Please see the contact - page in the <ulink url="../user-manual/contact.html">user-manual</ulink> for - details. - -</para> - -</sect2> - <sect2 renderas="sect3"> <title id="time">What time is it?</title> <para> @@ -1453,6 +1434,9 @@ FIXME: Commented out until we have something to put here. HB 03/18/02. Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: faq.sgml,v $ +Revision 1.50 2002/04/26 05:25:23 hal9 +Mass commit to catch a few scattered fixes. + Revision 1.49 2002/04/12 10:10:18 swa version update diff --git a/doc/source/newfeatures.sgml b/doc/source/newfeatures.sgml index 51e9e604..c2abc5a0 100644 --- a/doc/source/newfeatures.sgml +++ b/doc/source/newfeatures.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: newfeatures.sgml,v 1.5 2002/04/18 01:05:12 hal9 Exp $ + $Id: newfeatures.sgml,v 1.6 2002/04/18 10:16:36 oes Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -28,6 +28,13 @@ <para> <itemizedlist> + <listitem> + <para> + FIXME: complete the list of features. change the order: most important + features to the top of the list. prefix new features with "NEW". + </para> + </listitem> + <listitem> <para> Integrated browser based configuration and control utility at <ulink @@ -113,14 +120,6 @@ </para> </listitem> - <listitem> - <para> - Builds from source on most UNIX-like systems. Packages available for: Linux - (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11, - NetBSD and AmigaOS. - </para> - </listitem> - <listitem> <para> Every feature now controllable on a per-site or per-location basis, configuration diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 26228e62..0df6e76a 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -17,7 +17,7 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $ + $Id: readme.sgml,v 1.10 2002/04/26 05:25:23 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -80,7 +80,6 @@ <literal> <msgtext> <literallayout> - /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ @@ -113,7 +112,7 @@ * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * *********************************************************************/ - </literallayout> +</literallayout> </msgtext> </literal> </para> @@ -258,10 +257,10 @@ <LiteralLayout> ------------------------------------------------------------------------- ijbswa-developers@lists.sourceforge.net - </LiteralLayout> +</LiteralLayout> </para> <para> - $Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $ + $Id: readme.sgml,v 1.10 2002/04/26 05:25:23 hal9 Exp $ </para> </article> diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml index 2fa8f0c9..330bd28b 100644 --- a/doc/source/supported.sgml +++ b/doc/source/supported.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: supported.sgml,v 1.6 2002/04/17 13:55:07 oes Exp $ + $Id: supported.sgml,v 1.7 2002/04/18 01:05:56 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -23,12 +23,13 @@ user-manual faq + newfeatures --> <para> - At present, <application>Privoxy</application> is known to run on Win32, Mac - OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and - many flavors of Unix. + At present, <application>Privoxy</application> is known to run on + Windows(95, 98, ME, 2000, XP), Linux (RedHat, Suse, Debian), Mac OSX, + OS/2, AmigaOS, FreeBSD, NetBSD, BeOS, and many more flavors of Unix. </para> <![%p-supp-userman;[ diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 4cbf7e65..30b9c8ef 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -25,7 +25,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.92 2002/04/25 18:55:13 hal9 Exp $ + $Id: user-manual.sgml,v 1.94 2002/04/26 05:24:36 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -46,7 +46,7 @@ <artheader> <title>Privoxy User Manual</title> -<pubdate>$Id: user-manual.sgml,v 1.92 2002/04/25 18:55:13 hal9 Exp $</pubdate> +<pubdate>$Id: user-manual.sgml,v 1.94 2002/04/26 05:24:36 hal9 Exp $</pubdate> <authorgroup> <author> @@ -99,7 +99,6 @@ </sect1> <!-- ~~~~~ New section ~~~~~ --> - <sect1 label="1" id="introduction"><title>Introduction</title> <para> This documentation is included with the current &p-status; version of @@ -123,15 +122,13 @@ ]]> <!-- ~~~~~ New section ~~~~~ --> -<sect2 id="newfeatures"> -<title>New Features</title> +<sect2 id="features"><title>Features</title> <para> In addition to <application>Internet Junkbuster's</application> traditional features of ad and banner blocking and cookie management, <application>Privoxy</application> provides new features<![%p-not-stable;[, some of them currently under development]]>: </para> - <!-- Include newfeatures.sgml boilerplate here: --> &newfeatures; <!-- end boilerplate --> @@ -149,7 +146,9 @@ <application>Privoxy</application> is available both in convenient pre-compiled packages for a wide range of operating systems, and as raw source code. For most users, we recommend using the packages, which can be downloaded from our - <ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink>. + <ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project + Page</ulink>. For installing and compiling the source code, please look + into our Developer Manual. </para> <para> @@ -158,16 +157,13 @@ version directly from <ulink url="http://sourceforge.net/cvs/?group_id=11118">the CVS repository</ulink> or simply download <ulink url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz">the nightly CVS - tarball.</ulink> + tarball.</ulink> Again, we refer you to the Developer Manual. </para> <!-- Include supported.sgml boilerplate --> &supported; <!-- end boilerplate --> -<!-- ~~~~~ New section ~~~~~ --> -<sect2 id="installation-packages"><title>Binary Packages</title> - <para> Note: If you have a previous <application>Junkbuster</application> or <application>Privoxy</application> installation on your system, you @@ -178,15 +174,12 @@ <para> In any case <emphasis>be sure to backup your old configuration if it is valuable to you.</emphasis> See the - <link linkend="upgradersnote">note to upgraders</link>. -</para> - -<para> - How to install the binary packages depends on your operating system: + <link linkend="upgradersnote">note to upgraders</link> section + below. </para> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-pack-rpm"><title>Red Hat and SuSE RPMs</title> +<sect2 id="installation-pack-rpm"><title>Red Hat and SuSE RPMs</title> <para> RPMs can be installed with <literal>rpm -Uvh privoxy-&p-version;-1.rpm</literal>, @@ -195,9 +188,11 @@ </para> <para> - Note that on Red Hat, <application>Privoxy</application> will not be - automatically started on system boot. You will need to enable that using - <command>chkconfig</command>, <command>ntsysv</command>, or similar method. + Note that on Red Hat, <application>Privoxy</application> will + <emphasis>not</emphasis> be automatically started on system boot. You will + need to enable that using <command>chkconfig</command>, + <command>ntsysv</command>, or similar methods. Note that SuSE will +automatically start Privoxy in the boot process. </para> <para> @@ -212,36 +207,38 @@ Otherwise, RPM will try to remove <application>Junkbuster</application> automatically, before installing <application>Privoxy</application>. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-deb"><title>Debian</title> +<sect2 id="installation-deb"><title>Debian</title> <para> FIXME. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-pack-win"><title>Windows</title> +<sect2 id="installation-pack-win"><title>Windows</title> <para> Just double-click the installer, which will guide you through - the installation process. + the installation process. You will find the configuration files + in the same directory as you installed Privoxy in. We do not + use the registry of Windows. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, FreeBSD, HP-UX</title> +<sect2 id="installation-pack-bintgz"><title>Solaris, NetBSD, FreeBSD, HP-UX</title> <para> Create a new directory, <literal>cd</literal> to it, then unzip and untar the archive. For the most part, you'll have to figure out where things go. FIXME. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-os2"><title>OS/2</title> +<sect2 id="installation-os2"><title>OS/2</title> <para> First, make sure that no previous installations of @@ -261,10 +258,10 @@ The directory you choose to install <application>Privoxy</application> into will contain all of the configuration files. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-mac"><title>Max OSX</title> +<sect2 id="installation-mac"><title>Max OSX</title> <para> Unzip the downloaded package (you can either double-click on the file in the finder, or on the desktop if you downloaded it there). Then, @@ -276,10 +273,10 @@ automatically on system bring-up via <literal>/System/Library/StartupItems/Privoxy</literal>. </para> -</sect3> +</sect2> <!-- ~~~~~ New section ~~~~~ --> -<sect3 id="installation-amiga"><title>AmigaOS</title> +<sect2 id="installation-amiga"><title>AmigaOS</title> <para> Copy and then unpack the <filename>lha</filename> archive to a suitable location. All necessary files will be installed into <application>Privoxy</application> @@ -295,29 +292,13 @@ TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that <application>Privoxy</application> is still running). </para> -</sect3> </sect2> - -<!-- ~~~~~ New section ~~~~~ --> -<sect2 id="installation-source"><title>Building from Source</title> - -<!-- include buildsource.sgml boilerplate: --> - &buildsource; -<!-- end boilerplate --> -</sect2> - </sect1> <!-- ~ End section ~ --> - <!-- ~~~~~ New section ~~~~~ --> - -<sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title> - - -<!-- ~~~~~ New section ~~~~~ --> -<sect2 id="upgradersnote"> +<sect1 id="upgradersnote"> <title>Note to Upgraders</title> <para> There are very significant changes from older versions of @@ -395,11 +376,49 @@ </itemizedlist> </para> +</sect1> -</sect2> +<!-- ~~~~~ New section ~~~~~ --> +<sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title> +<para> + <itemizedlist> + + <listitem> + <para> + Install <application>Privoxy</application>. See the section <link linkend="installation">Installing</link>. + </para> + </listitem> + + <listitem> + <para> + Start <application>Privoxy</application>. See the section <link linkend="startup">Starting <application>Privoxy</application></link>. + </para> + </listitem> + + <listitem> + <para> + Change your browser's configuration to use the proxy <literal>localhost</literal> on port + <literal>8118</literal>. See the section <link linkend="startup">Starting <application>Privoxy</application></link>. + </para> + </listitem> + + <listitem> + <para> + Enjoy surfing with enhanced comfort and privacy. Please see the section + <link linkend="contact">Contacting the Developers</link> on how to report + bugs or problems with websites or to get help. You may want to change the + file <filename>user.action</filename> to further tweak your new browsing + experience. + </para> + </listitem> + + </itemizedlist> +</para> + +</sect1> <!-- ~~~~~ New section ~~~~~ --> -<sect2 id="startup"> +<sect1 id="startup"> <title>Starting <application>Privoxy</application></title> <para> Before launching <application>Privoxy</application> for the first time, you @@ -437,8 +456,7 @@ <screen> # /usr/sbin/privoxy /etc/privoxy/config - - </screen> +</screen> </para> <para> @@ -554,9 +572,6 @@ Developers</quote></ulink> below. </para> -</sect2> - - <!-- ~~~~~ New section ~~~~~ --> <sect2 id="cmdoptions"> <title>Command Line Options</title> @@ -786,7 +801,7 @@ <para> All files use the <quote><literal>#</literal></quote> character to denote a - comment (the rest of the line will be ignored) and understand line continuation + comment (the rest of the line will be ignored) angd understand line continuation through placing a backslash ("<literal>\</literal>") as the very last character in a line. If the <literal>#</literal> is preceded by a backslash, it looses its special function. Placing a <literal>#</literal> in front of an otherwise @@ -1018,7 +1033,7 @@ actionsfile The default values include standard.action, which is used for internal purposes and should be loaded, default.action, which is the <quote>main</quote> actions file maintained by the developers, and - user.action, where you can make your personal additions. + <filename>user.action</filename>, where you can make your personal additions. </para> <para> There is no point in using <application>Privoxy</application> without an actions file. @@ -1462,7 +1477,7 @@ actionsfile debug 1024 # debug kill pop-ups debug 4096 # Startup banner and warnings. debug 8192 # Non-fatal errors - </programlisting> +</programlisting> </para> <para> To select multiple debug levels, you can either add them or use @@ -1610,7 +1625,7 @@ actionsfile <para> <programlisting> listen-address 192.168.0.1:8118 - </programlisting> +</programlisting> </para> </listitem> </varlistentry> @@ -1876,7 +1891,7 @@ ACLs: permit-access and deny-access</title> <para> <screen> permit-access localhost - </screen> +</screen> </para> <para> Allow any host on the same class C subnet as www.privoxy.org access to @@ -1885,7 +1900,7 @@ ACLs: permit-access and deny-access</title> <para> <screen> permit-access www.privoxy.org/24 www.example.com/32 - </screen> +</screen> </para> <para> Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere, @@ -1895,7 +1910,7 @@ ACLs: permit-access and deny-access</title> <screen> permit-access 192.168.45.64/26 deny-access 192.168.45.73 www.dirty-stuff.example.com - </screen> +</screen> </para> </listitem> </varlistentry> @@ -2048,7 +2063,7 @@ ACLs: permit-access and deny-access</title> <screen> forward .* anon-proxy.example.org:8080 forward :443 . - </screen> +</screen> </para> <para> Everything goes to our example ISP's caching proxy, except for requests @@ -2058,7 +2073,7 @@ ACLs: permit-access and deny-access</title> <screen> forward .*. caching-proxy.example-isp.net:8000 forward .example-isp.net . - </screen> +</screen> </para> </listitem> </varlistentry> @@ -2142,7 +2157,7 @@ forward-socks4 and forward-socks4a</title> <screen> forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 forward .example.com . - </screen> +</screen> </para> <para> A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this: @@ -2150,7 +2165,7 @@ forward-socks4 and forward-socks4a</title> <para> <screen> forward-socks4 .*. socks-gw.example.com:1080 . - </screen> +</screen> </para> </listitem> </varlistentry> @@ -2180,7 +2195,7 @@ forward-socks4 and forward-socks4a</title> <screen> forward .*. . forward .isp-b.net host-b:8118 - </screen> +</screen> </para> <para> @@ -2191,7 +2206,7 @@ forward-socks4 and forward-socks4a</title> <screen> forward .*. . forward .isp-a.net host-a:8118 - </screen> +</screen> </para> <para> @@ -2223,8 +2238,7 @@ forward-socks4 and forward-socks4a</title> always_direct allow ftp # Forward all the rest to Privoxy - never_direct allow all - </screen> + never_direct allow all</screen> </para> <para> @@ -2426,8 +2440,7 @@ forward-socks4 and forward-socks4a</title> <!-- ~~~~~ New section ~~~~~ --> -<sect2 id="actions-file"> -<title>Actions Files</title> +<sect2 id="actions-file"><title>Actions Files</title> <para> The actions files are used to define what actions @@ -4541,35 +4554,6 @@ Requests</title> &contacting; <!-- end boilerplate --> - -<!-- ~~~~~ New section ~~~~~ --> -<sect2 id="submitactions"> -<title>Submitting Ads and <quote>Action</quote> Problems</title> -<para> - Ads and banners that are not stopped by <application>Privoxy</application> - can be submitted to the developers by accessing a special page and filling - out the brief, required form. Conversely, you can also report pages, images, - etc. that <application>Privoxy</application> is blocking, but should not. - The form itself does require Internet access. -</para> -<para> - To do this, point your browser to <application>Privoxy</application> - at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink> - (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>), and then select - <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink>, - near the bottom of the page. Paste in the URL that is the cause of the - unwanted behavior, and follow the prompts. The developers will - try to incorporate a fix for the problem you reported into future versions. -</para> - -<para> - New, improved <filename>default.action</filename> files will occasionally be made - available based on your feedback. These will be announced on the <ulink - url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink> - list. -</para> -</sect2> - </sect1> @@ -4992,31 +4976,35 @@ Requests</title> <listitem> <para> - <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Enable Privoxy</ulink> + <ulink + url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Enable</ulink> </para> </listitem> <listitem> <para> - <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Disable Privoxy</ulink> + <ulink + url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Disable</ulink> </para> </listitem> <listitem> <para> - <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Toggle Privoxy</ulink> (Toggles between enabled and disabled) + <ulink + url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Toggle Privoxy</ulink> (Toggles between enabled and disabled) </para> </listitem> <listitem> <para> - <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">View Privoxy Status</ulink> + <ulink + url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy- View Status</ulink> </para> </listitem> <listitem> <para> - <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Actions file feedback system</ulink> + <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Submit Filter Feedback</ulink> </para> </listitem> @@ -5241,7 +5229,6 @@ Requests</title> --- File user --- (no matches in this file) - </screen> </para> @@ -5301,9 +5288,8 @@ Requests</title> +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect +prevent-compression -session-cookies-only -prevent-reading-cookies - -prevent-setting-cookies -kill-popups -send-vanilla-wafer -send-wafer - - </screen> + -prevent-setting-cookies -kill-popups -send-vanilla-wafer -send-wafer +</screen> </para> <para> @@ -5326,8 +5312,7 @@ Requests</title> { +block +handle-as-image } .doubleclick.net - - </screen> +</screen> </para> <para> @@ -5376,8 +5361,7 @@ Requests</title> { +block +handle-as-image } /ads - - </screen> +</screen> </para> <para> @@ -5393,8 +5377,7 @@ Requests</title> { -block } /adsl - - </screen> +</screen> </para> <para> @@ -5412,8 +5395,7 @@ Requests</title> { +block +handle-as-image } /ads - - </screen> +</screen> </para> <para> @@ -5434,8 +5416,7 @@ Requests</title> .jungle.com .scan.co.uk .forbes.com - - </screen> +</screen> </para> <para> @@ -5450,8 +5431,7 @@ Requests</title> {-filter} .forbes.com - - </screen> +</screen> </para> <para> @@ -5491,6 +5471,10 @@ Requests</title> Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.94 2002/04/26 05:24:36 hal9 + -Add most of Andreas suggestions to Chain of Events section. + -A few other minor corrections and touch up. + Revision 1.92 2002/04/25 18:55:13 hal9 More catchups on new actions files, and new actions names. Other assorted cleanups, and minor modifications. diff --git a/doc/source/webserver/index.sgml b/doc/source/webserver/index.sgml index 8c82f28e..c055a890 100644 --- a/doc/source/webserver/index.sgml +++ b/doc/source/webserver/index.sgml @@ -19,7 +19,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: index.sgml,v 1.7 2002/04/12 10:11:53 swa Exp $ + $Id: index.sgml,v 1.9 2002/04/14 01:00:07 hal9 Exp $ Written by and Copyright (C) 2001, 2002 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -84,7 +84,7 @@ page</ulink> on Sourceforge </listitem> <listitem> <literallayout> - A list of <ulink url="user-manual/introduction.html#AEN37">new features</ulink> + A list of <ulink url="user-manual/introduction.html#AEN37">features</ulink> </literallayout> </listitem> <listitem> @@ -156,6 +156,7 @@ page</ulink> on Sourceforge <listitem> <literallayout> <ulink url="developer-manual/index.html">Developer Manual</ulink> +<!-- ,alternatively as a pdf file: <ulink url="">developer-manual.pdf</ulink>. --> </literallayout> </listitem> </itemizedlist> @@ -237,6 +238,9 @@ page</ulink> on Sourceforge Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: index.sgml,v $ + Revision 1.9 2002/04/14 01:00:07 hal9 + Fix the logo properly with docbook. + Revision 1.7 2002/04/12 10:11:53 swa changed bookmarklet text so that users can easily find the bookmark