<!--
- File : $Source: /cvsroot/ijbswa//current/doc/source/contacting.sgml,v $
+ File : $Source: /cvsroot/ijbswa/current/doc/source/contacting.sgml,v $
Purpose : Entity included in other project documents.
- $Id: contacting.sgml,v 1.14 2002/05/17 13:32:12 oes Exp $
+ $Id: contacting.sgml,v 1.15 2002/05/17 14:05:59 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
README
user-manual
webserver/index.sgml
+ announce.sgml
-->
<para>
Before doing so, please make sure that the bug has not already been submitted
- and observe the aditional hints at the top of the <ulink
+ and observe the ad
ditional hints at the top of the <ulink
url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=111118">submit
form</ulink>.
</para>
<para>
For any other issues, feel free to use the mailing lists. Technically interested users
and people who wish to contribute to the project are also welcome on the developers list!
-You can find an overview of all <application>Prixoxy</application>-related mailing lists,
+You can find an overview of all <application>Privoxy</application>-related mailing lists,
including list archives, at:
<ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
</para>
<!entity contacting SYSTEM "contacting.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
+<!entity p-version "3.1.1">
+<!entity p-status "alpha">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $
+ $Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
</pubdate>
- <pubdate>$Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $</pubdate>
<!--
</para></listitem>
<listitem><para>
If your changes span multiple files, and the code won't recompile unless
- all changes are commited (e.g. when changing the signature of a function),
- then commit all files one after another, without long delays in beween.
+ all changes are committed (e.g. when changing the signature of a function),
+ then commit all files one after another, without long delays in between.
If necessary, prepare the commit messages in advance.
</para></listitem>
<listitem><para>
We don't have a too formal policy on this, just use common sense. Hints: If it is..
<orderedlist numeration="arabic">
<listitem><para>
- ..a bugfix / clean-up / cosmetic thing: shoot
+ ..a bug-fix / clean-up / cosmetic thing: shoot
</para></listitem>
<listitem><para>
..a new feature that can be turned off: shoot
responsible for ensuring that deletion is timely (i.e. not too
soon, not too late). This is known as "low-coupling" and is a
"good thing (tm)". You may need to offer a
- free/unload/destuctor type function to accommodate this.</para>
+ free/unload/destructor type function to accommodate this.</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
intelligent (keep it short and precise).</para>
</listitem>
</itemizedlist>
- Do not mail to the mailinglist (we cannot keep track on issues there).
+ Do not mail to the mailing list (we cannot keep track on issues there).
</para>
</sect2>
Y, the version minor, represents the branch within the major version.
At any point in time, there are two branches being maintained:
The stable branch, with an even minor, say, 2N, in which no functionality is
- being added and only bugfixes are made, and 2N+1, the development branch, in
+ being added and only bug-fixes are made, and 2N+1, the development branch, in
which the further development of <application>Privoxy</application> takes
place.
This enables us to turn the code upside down and inside out, while at the same time
providing and maintaining a stable version.
- The minor is reset to zero (and one) when the major is inrcemented. When a development
+ The minor is reset to zero (and one) when the major is incremented. When a development
branch has matured to the point where it can be turned into stable, the old stable branch
2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
new stable branch 2N+2, and a new development branch 2N+3 is opened.
</para>
<simplelist>
<member>
- <filename>LICENSE</filename> (toplevel directory)
+ <filename>LICENSE</filename> (top-level directory)
</member>
</simplelist>
<simplelist>
<member>
- <filename>README</filename> (toplevel directory)
+ <filename>README</filename> (top-level directory)
</member>
</simplelist>
<simplelist>
<member>
- <filename>AUTHORS</filename> (toplevel directory)
+ <filename>AUTHORS</filename> (top-level directory)
</member>
</simplelist>
<simplelist>
<member>
- <filename>man page</filename> (toplevel directory, Unix-like
+ <filename>man page</filename> (top-level directory, Unix-like
platforms only)
</member>
</simplelist>
</simplelist>
<para>
Also suggested: <filename>Developer Manual</filename>
- (doc/webserver/devel-manual) and <filename>ChangeLog</filename>
- (toplevel directory). <filename>FAQ</filename> and the manuals are
+ (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
+ (top-level directory). <filename>FAQ</filename> and the manuals are
HTML docs. There are also text versions in
<filename>doc/text/</filename> which could conceivably also be
included.
<sect3 id="newrelease-debian"><title>Debian</title>
<para>
- First, <emphasis>make sure that you have freshly exported the
+ First, <emphasis>make sure that you have freshly exported the
right version into an empty directory</emphasis>. (See
"Building and releasing packages" above). Then add a log
entry to <filename>debian/changelog</filename>, if it is not
already there, for example by running:
- </para>
- <para>
- <programlisting>
- debchange -v &p-version;-&p-status;-1 "New upstream version"
- </programlisting>
- </para>
- <para>
- After this simply run
- </para>
- <para>
- <programlisting>
- dpkg-buildpackage -rfakeroot -us -uc -b
- </programlisting>
- </para>
- <para>
- This will create
- <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
- which can be uploaded.
- </para>
+ </para>
+ <para>
+ <programlisting>
+ debchange -v &p-version;-&p-status;-1 "New upstream version"
+ </programlisting>
+ </para>
+ <para>
+ After this simply run
+ </para>
+ <para>
+ <programlisting>
+ dpkg-buildpackage -rfakeroot -us -uc -b
+ </programlisting>
+ </para>
+ <para>
+ This will create
+ <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
+ which can be uploaded.
+ </para>
+ <para>
+ Then, run:
+ </para>
+ <para>
+ <programlisting>
+ make debian-dist
+</programlisting>
+ </para>
+ <para>
+ To upload the package to Sourceforge, simply issue
+ </para>
+ <para>
+ <programlisting>
+ make debian-upload
+</programlisting>
+ </para>
</sect3>
<sect3 id="newrelease-macosx"><title>Mac OSX</title>
<sect3 id="newrelease-freebsd"><title>FreeBSD</title>
<para>
- Login to Sourceforge's compilefarm via ssh:
+ Login to Sourceforge's compile-farm via ssh:
</para>
<para>
<programlisting>
<sect1 id="webserver-update"><title>Update the Webserver</title>
<para>
When updating the webserver, please follow these steps to make
- sure that no broken links, incosistent contents or permission
+ sure that no broken links, inconsistent contents or permission
problems will occur:
</para>
<para>
</para>
<para>
<programlisting>
- make dok # (or make redkat-dok if make dok doesn't work for you)
+ make dok # (or make redhat-dok if make dok doesn't work for you)
</programlisting>
</para>
<para>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ Revision 1.48 2002/05/26 12:48:31 roro
+ Add releasing information about Debian.
+
+ Revision 1.47 2002/05/26 04:55:11 mal0rd
+ Added debian-dist and debian-upload targets. Also documented usage.
+
Revision 1.46 2002/05/22 17:15:00 oes
Updated intro
Purpose : Entity included in other project documents.
- $Id: p-authors.sgml,v 1.7 2002/05/24 03:06:48 hal9 Exp $
+ $Id: p-authors.sgml,v 1.8 2002/05/25 15:40:20 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
Gábor Lipták
Guy
Haroon Rafique
+ Roland Rosenfeld
David Schmidt (OS/2, Mac OSX ports)
Joerg Strohmayer
Sarantis Paskalis
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 1.12 2002/05/10 01:48:20 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 1.13 2002/05/25 22:32:54 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
</para>
<para>
The name and number of configuration files has changed from previous
- versions, and is subject to change as development progresses. In fact, the
- configuration itself is changed and much more sophisticated. See the
- <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
- complete explanation of all configuration options and general usage.
+ versions<![%p-not-stable;[, and is subject to change as development
+ progresses]]>. In fact, the configuration itself is changed and much more
+ sophisticated. See the <ulink
+ url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a complete
+ explanation of all configuration options and general usage, and notes for
+ upgrading from <command>Junkbuster</command> and earlier <command>Privoxy</command>
+ versions.
</para>
<para>
The actions list (ad blocks, etc) can also be configured with your
web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>.
<command>Privoxy's</command> configuration parameters can also be viewed at
the same page. In addition, <command>Privoxy</command> can be toggled on/off.
- This is an internal page.
+ This is an internal page, and does not require Internet access.
</para>
</refsect1>
all features are well tested.
</para>]]>
<para>
- Please see the <citetitle>user-manual</citetitle> on how to contact the
+ Please see the <citetitle>User Manual</citetitle> on how to contact the
developers for feature requests, reporting problems, and other questions.
</para>
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $
+ $Id: readme.sgml,v 1.15 2002/05/10 01:48:20 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
USER[.GROUP]] [config_file]
</para>
<para>
- See the man page or user-manual for a brief explanation of each option.
+ See the man page or User Manual for an explanation of each option, and
+ other configuration and usage issues.
</para>
<para>
If no config_file is specified on the command line, Privoxy will look for a
for 'config.txt'). If no config_file is found, Privoxy will fail to start.
</para>
<para>
- Or for Red Hat: /etc/rc.d/init.d/privoxy start
+ Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
</para>
<para>
Or for SuSE: /etc/rc.d/privoxy start
</para>
+<para>
+ Or Debian: /etc/init.d/privoxy start
+</para>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="configuration"><title>CONFIGURATION</title>
<para>
See: 'config', 'default.action', 'user.action', and 'default.filter'.
- 'user.action' is for personal configuration. These are all well commented.
- Most of the magic is in '*.action' files. 'user.action' should be
- used for any actions customizations. On Unix-like systems, these files
- are installed in /etc/privoxy. On Windows, then wherever the executable
- itself is installed. There are many significant changes and advances since
- Junkbuster v2.0.x. The user-manual has a run down of configuration options,
- and examples: http://www.privoxy.org/user-manual/.
+ 'user.action' is for personal and local configuration preferences. These are
+ all well commented. Most of the magic is in '*.action' files. 'user.action'
+ should be used for any actions customizations. On Unix-like systems, these
+ files are installed in /etc/privoxy. On Windows, then wherever the
+ executable itself is installed. There are many significant changes and
+ advances since Junkbuster v2.0.x. The User Manual has an explanation of
+ all configuration options, and examples: http://www.privoxy.org/user-manual/.
</para>
<para>
Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
<sect1 id="documentation"><title>DOCUMENTATION</title>
<para>
There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- is not completed at this point]]>. In particular, see the user-manual there,
- the faq, and those interested in Privoxy development, should look at
+ is not completed at this point]]>. In particular, see the User Manual there,
+ the FAQ, and those interested in Privoxy development, should look at
developer-manual.
</para>
<para>
<!-- </LiteralLayout> -->
<!-- </para> -->
<!-- <para> -->
-<!-- $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $ -->
+<!-- $Id: readme.sgml,v 1.16 2002/05/10 01:48:20 hal9 Exp $ -->
<!-- </para> -->
</article>
Purpose : Entity included in other project documents.
- $Id: supported.sgml,v 1.9 2002/05/10 01:48:20 hal9 Exp $
+ $Id: supported.sgml,v 1.10 2002/05/22 17:16:05 oes Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
-->
<para>
At present, <application>Privoxy</application> is known to run on
- Windows(95, 98, ME, 2000, XP), Linux (RedHat, Suse, Debian, Conectiva),
+ Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva),
Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and many more
flavors of Unix.
</para>
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.122 2002/05/24 13:24:08 oes Exp $
+ $Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 1.122 2002/05/24 13:24:08 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $</pubdate>
<!--
When you connect to a website, the full URL will either match one or more
of the sections as defined in <application>Privoxy's</application> configuration,
or not. If so, then <application>Privoxy</application> will perform the
- respective actions. If not, then nothing special happens. Futhermore, web
+ respective actions. If not, then nothing special happens. Furthermore, web
pages may contain embedded, secondary URLs that your web browser will
use to load additional components of the page, as it parses the
original page's HTML content. An ad image for instance, is just an URL
for all common image types (e.g. GIF), but there are many situations where this
is not so easy to determine. So we'll force it in these cases. This is particularly
important for ad blocking, since only if we know that it's an image of
- some kind, can we replace it with an image of our chosing, instead of the
+ some kind, can we replace it with an image of our choosing, instead of the
<application>Privoxy</application> BLOCKED page (which would only result in
a <quote>broken image</quote> icon). There are some limitations to this
- though. For instance, you can't just brute-force an image substituion for
+ though. For instance, you can't just brute-force an image substitution for
an entire HTML page in most situations.
</para>
</listitem>
</para>
<simplelist>
<member>
- <emphasis>pattern</emphasis> - a checkboard pattern, so that an ad
+ <emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
replacement is obvious. This is the default.
</member>
</simplelist>
<para>
For advanced users who want to hand edit their config files, you might want
to now go to the <link linkend="act-examples">Actions Files Tutorial</link>.
- The ideas explained thererin also apply to the web-based editor.
+ The ideas explained therein also apply to the web-based editor.
</para>
</sect2>
<term>Effect if unset:</term>
<listitem>
<para>
- No log file is used, all log messages go to the console (<literal>stderr</literal>).
+ No log file is used, all log messages go to the console (<literal>STDERR</literal>).
</para>
</listitem>
</varlistentry>
reflect the file type, like in the second example section.
</para>
<para>
- Note that you cannot treat HTML pages as images in most cases. For instance, (inline) ad
+ Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad
frames require an HTML page to be sent, or they won't display properly.
Forcing <literal>handle-as-image</literal> in this situation will not replace the
ad frame with an image, but lead to error messages.
<para>
These templates are stored in a subdirectory of the <link linkend="confdir">configuration
- directory</link> called <filename>templates</filename>. On unixish platforms,
+ directory</link> called <filename>templates</filename>. On Unixish platforms,
this is typically
<ulink url="file:///etc/privoxy/templates/"><filename>/etc/privoxy/templates/</filename></ulink>.
</para>
</para>
<para>
- For information on regular expression based substititions and their applications
+ For information on regular expression based substitutions and their applications
in filters, please see the <link linkend="filter-file">filter file tutorial</link>
in this manual.
</para>
</blockquote>
<para>
There is a shortcut: <ulink url="http://p.p/">http://p.p/</ulink> (But it
- doesn't provide a fallback to a real page, in case the request is not
+ doesn't provide a fall-back to a real page, in case the request is not
sent through <application>Privoxy</application>)
</para>
</listitem>
<para>
First, the server headers are read and processed to determine, among other
things, the MIME type (document type) and encoding. The headers are then
- filtered as deterimed by the
+ filtered as deterimined by the
<link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
<link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.123 2002/05/24 23:19:23 hal9
+ Include new image (Proxy setup). More fun with guibutton.
+ Minor corrections/clarifications here and there.
+
Revision 1.122 2002/05/24 13:24:08 oes
Added Bookmarklet for one-click pre-filled access to show-url-info
projects / privoxy.git / commitdiff