$Id: developer-manual.sgml,v 2.39 2012/03/18
+ 01:16:35 diem Exp $
@@ -49,7 +46,7 @@ body {
entirely correct. As always, patches are welcome.
Please note that this document is constantly evolving. This copy
- represents the state at the release of version 3.0.19. You can find
+ represents the state at the release of version 3.0.20. You can find
the latest version of the this manual at http://www.privoxy.org/developer-manual/. Please see
@@ -368,9 +365,9 @@ body {
diff --git a/doc/webserver/developer-manual/introduction.html b/doc/webserver/developer-manual/introduction.html
index 468f2fa6..1dd4bda1 100644
--- a/doc/webserver/developer-manual/introduction.html
+++ b/doc/webserver/developer-manual/introduction.html
@@ -3,9 +3,6 @@
-
-
Introduction
diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html
index e4655fea..ea1df347 100644
--- a/doc/webserver/developer-manual/newrelease.html
+++ b/doc/webserver/developer-manual/newrelease.html
@@ -3,9 +3,6 @@
-
-
Releasing a New Version
@@ -749,7 +746,7 @@ body {
- debchange -v 3.0.19-stable-1 "New upstream version"
+ debchange -v 3.0.20-UNRELEASED-1 "New upstream version"
@@ -768,7 +765,7 @@ body {
This will create ../privoxy_3.0.19-stable-1_i386.deb which can be
+ "FILENAME">../privoxy_3.0.20-UNRELEASED-1_i386.deb which can be
uploaded. To upload the package to Sourceforge, simply issue
@@ -788,59 +785,133 @@ body {
First, make sure that you have
freshly exported the right version into an empty directory.
- (See "Building and releasing packages" above). Then get the Mac OS X
- setup module:
+ (See "Building and releasing packages" above).
-
-
-
-
+
There are three modules available in the CVS repository for use on
+ Mac OS X, though technically only two of them generate a release (the
+ other can be used to install from source).
The OSXPackageBuilder module generates OS X installer packages
+ supporting all Macs running OS X 10.4 and above. Obtain it from CVS
+ as follows into a folder parallel to the exported privoxy
+ source:
+
+
+
+
+
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
+
+
+
+
+
+
The module contains complete instructions on its usage in the
+ file OS X Package Builder HOWTO.txt.
+
+
Once the package(s) have been generated, you can then upload
+ them directly to the Files section of the Sourceforge project in
+ the Macintosh (OS X) folder. Each new version release of Privoxy
+ should have a new subfolder created in which to store its files.
+ Please ensure that the folder contains a readme file that makes it
+ clear which package is for whichversion of OS X.
This module is deprecated
+ since the installer it generates places all Privoxy files in one
+ folder in a non-standard location, and supports only Intel Macs
+ running OS X 10.6 or higher.
+
+
Check out the module from CVS as follows into a folder parallel
+ to the exported privoxy source:
+
+
+
+
+
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
-
-
-
+
+
+
-
Then run:
+
Then run:
-
-
-
-
+
+
+
+
cd osxsetup
build
-
-
-
+
+
+
-
This will run autoheader, autoconf and configure as
- well as make. Finally, it will copy over
- the necessary files to the ./osxsetup/files directory for further
- processing by PackageMaker.
+
This will run autoheader, autoconf and configure as
+ well as make. Finally, it will copy over
+ the necessary files to the ./osxsetup/files directory for further
+ processing by PackageMaker.
-
Bring up PackageMaker with the PrivoxyPackage.pmsp definition
- file, modify the package name to match the release, and hit the
- "Create package" button. If you specify ./Privoxy.pkg as the output
- package name, you can then create the distributable zip file with the
- command:
+
Bring up PackageMaker with the PrivoxyPackage.pmsp definition
+ file, modify the package name to match the release, and hit the
+ "Create package" button. If you specify ./Privoxy.pkg as the output
+ package name, you can then create the distributable zip file with
+ the command:
-
-
-
-
+
+
+
+
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-
-
-
+
+
+
+
+
You can then upload this file directly to the Files section of
+ the Sourceforge project in the Macintosh (OS X) folder. Each new
+ version release of Privoxy should have a new subfolder created in
+ which to store its files. Please ensure that the folder contains a
+ readme file that makes it clear which version(s) of OS X the
+ package supports.
The macsetup module is ideal if you wish to build and install
+ Privoxy from source on a single machine.
+
+
Check out the module from CVS as follows into a folder parallel
+ to the exported privoxy source:
+
+
+
+
+
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
+
+
+
+
-
You can then upload privoxyosx_setup_x.y.z.zip anonymously to uploads.sourceforge.net/incoming, create a release
- for it, and you're done. Use the release notes and Change Log from
- the source tarball package.
+
The module contains complete instructions on its usage in its
+ README file. The end result will be the
+ the exported version of Privoxy installed on the build machine.
+
@@ -1024,7 +1095,7 @@ body {
column, and click Add Release. You will then
need to create a new release for your package, using the format of
$VERSION ($CODE_STATUS), e.g. 3.0.19 (beta).
+ "emphasis EMPHASIS c2">3.0.20 (beta).
Now just follow the prompts. Be sure to add any appropriate Release
notes. You should see your freshly uploaded packages in
-
-
See also
diff --git a/doc/webserver/developer-manual/testing.html b/doc/webserver/developer-manual/testing.html
index 9f8abf6c..20ebe03a 100644
--- a/doc/webserver/developer-manual/testing.html
+++ b/doc/webserver/developer-manual/testing.html
@@ -3,9 +3,6 @@
-
-
Testing Guidelines
diff --git a/doc/webserver/developer-manual/webserver-update.html b/doc/webserver/developer-manual/webserver-update.html
index 76b66908..4f97360d 100644
--- a/doc/webserver/developer-manual/webserver-update.html
+++ b/doc/webserver/developer-manual/webserver-update.html
@@ -3,9 +3,6 @@
-
-
Update the Webserver
diff --git a/doc/webserver/faq/configuration.html b/doc/webserver/faq/configuration.html
index 892e46b1..90dfaa9d 100644
--- a/doc/webserver/faq/configuration.html
+++ b/doc/webserver/faq/configuration.html
@@ -3,9 +3,6 @@
-
-
Configuration
diff --git a/doc/webserver/faq/contact.html b/doc/webserver/faq/contact.html
index 8f97f567..d3543bba 100644
--- a/doc/webserver/faq/contact.html
+++ b/doc/webserver/faq/contact.html
@@ -3,9 +3,6 @@
-
-
Contacting the developers, Bug Reporting and Feature
Requests
-
-
Privoxy Copyright, License and History
diff --git a/doc/webserver/faq/general.html b/doc/webserver/faq/general.html
index 3fb3b53a..3f8647fc 100644
--- a/doc/webserver/faq/general.html
+++ b/doc/webserver/faq/general.html
@@ -3,9 +3,6 @@
-
-
General Information
diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html
index 38813775..185c235b 100644
--- a/doc/webserver/faq/index.html
+++ b/doc/webserver/faq/index.html
@@ -3,9 +3,6 @@
-
-
Privoxy Frequently Asked Questions
@@ -37,7 +34,7 @@ body {
2001-2011 by Privoxy
Developers
Note that many of these actions have the potential to cause a page
@@ -4384,7 +4381,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
together:
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 1091844d..dfbf7014 100644
--- a/doc/webserver/user-manual/appendix.html
+++ b/doc/webserver/user-manual/appendix.html
@@ -3,13 +3,10 @@
For Unix, *BSD and Linux, all configuration files are located in
/etc/privoxy/ by default. For MS Windows,
OS/2, and AmigaOS these are all in the same directory as the
- Privoxy executable.
+ Privoxy executable. The name and
+ number of configuration files has changed from previous versions, and
+ is subject to change as development progresses.
The installed defaults provide a reasonable starting point, though
some settings may be aggressive by some standards. For the time being,
@@ -249,6 +248,12 @@ body {
address of Privoxy, these "wake up" requests must obviously be sent to the
old listening address.
+
+
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.
diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html
index 9b3bc0cf..aade7483 100644
--- a/doc/webserver/user-manual/contact.html
+++ b/doc/webserver/user-manual/contact.html
@@ -3,14 +3,11 @@
-
-
Contacting the Developers, Bug Reporting and Feature
Requests
-
+
-
Privoxy 3.0.19 User Manual
+
Privoxy 3.0.20 User Manual
diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html
index 59c76919..c3cb9e4a 100644
--- a/doc/webserver/user-manual/copyright.html
+++ b/doc/webserver/user-manual/copyright.html
@@ -3,13 +3,10 @@
-
-
Privoxy Copyright, License and History
-
+
@@ -35,7 +32,7 @@ body {
-
Privoxy 3.0.19 User Manual
+
Privoxy 3.0.20 User Manual
@@ -64,7 +61,7 @@ body {
"CITETITLE">GNU General Public License.
Privoxy is free software; you can
redistribute it and/or modify it under the terms of the
David Schmidt, developer
Hal Burgiss
+ Ian Silvester
Lee Rian
- Roland Rosenfeld
+ Roland Rosenfeld
+ Ian Silvester
Former Privoxy Team Members:
@@ -193,6 +192,7 @@ body {
Markus Elfring
Dean Gaudet
Stephen Gildea
+ Lizik Grelier
Daniel Griscom
Felix Gröbert
Jeff H.
@@ -204,7 +204,10 @@ body {
Stefan Huehner
Peter Hyman
Derek Jennings
+ Andrew Jones
+ Julien Joubert
Petr Kadlec
+ Steven Kolins
David Laight
Bert van Leeuwen
Don Libes
@@ -224,6 +227,7 @@ body {
Roberto Ragusa
Félix Rauch
Maynard Riley
+ Andreas Rutkauskas
Chung-chieh Shan
Spinor S.
Bart Schelstraete
diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html
index 2a3daff0..289d606c 100644
--- a/doc/webserver/user-manual/filter-file.html
+++ b/doc/webserver/user-manual/filter-file.html
@@ -3,13 +3,10 @@
-
-
Filter Files
-
+
@@ -35,7 +32,7 @@ body {
-
Privoxy 3.0.19 User Manual
+
Privoxy 3.0.20 User Manual
@@ -165,7 +162,7 @@ FILTER: foo Replace all "foo" with "bar"
started.
@@ -80,7 +77,7 @@ body {
"INSTALLATION-PACK-RPM">2.1.1. Red Hat and Fedora RPMs
RPMs can be installed with rpm -Uvh
- privoxy-3.0.19-1.rpm, and will use , and will use /etc/privoxy for the location of configuration
files.
@@ -92,7 +89,7 @@ body {
If you have problems with failed dependencies, try rebuilding the
SRC RPM: rpm --rebuild
- privoxy-3.0.19-1.src.rpm. This will use your locally installed
+ privoxy-3.0.20-1.src.rpm. This will use your locally installed
libraries and RPM version.
Unzip the downloaded file (you can either double-click on the zip
- file icon from the Finder, or from the desktop if you downloaded it
- there). Then, double-click on the package installer icon and follow
- the installation process.
+
Installation instructions for the OS X platform depend upon
+ whether you downloaded a ready-built installation package (.pkg or
+ .mpkg) or have downloaded the source code.
The downloaded file will either be a .pkg (for OS X 10.5 upwards)
+ or a bzipped .mpkg file (for OS X 10.4). The former can be
+ double-clicked as is and the installation will start; double-clicking
+ the latter will unzip the .mpkg file which can then be double-clicked
+ to commence the installation.
The privoxy service will automatically start after a successful
- installation (in addition to every time your computer starts up). To
- prevent the privoxy service from automatically starting when your
- computer starts up, remove or rename the folder named /Library/StartupItems/Privoxy.
+ installation (and thereafter every time your computer starts up)
+ however you will need to configure your web browser(s) to use it. To
+ do so, configure them to use a proxy for HTTP and HTTPS at the
+ address 127.0.0.1:8118.
+
+
To prevent the privoxy service from automatically starting when
+ your computer starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist (on OS
+ X 10.5 and higher) or the folder named /Library/StartupItems/Privoxy (on OS X 10.4
+ 'Tiger').
+
+
To manually start or stop the privoxy service, use the scripts
+ startPrivoxy.sh and stopPrivoxy.sh supplied in /Applications/Privoxy.
+ They must be run from an administrator account, using sudo.
+
+
To uninstall, run /Applications/Privoxy/uninstall.command as sudo
+ from an administrator account.
To build and install the Privoxy source code on OS X you will need
+ to obtain the macsetup module from the Privoxy Sourceforge CVS
+ repository (refer to Sourceforge help for details of how to set up a
+ CVS client to have read-only access to the repository). This module
+ contains scripts that leverage the usual open-source tools (available
+ as part of Apple's free of charge Xcode distribution or via the usual
+ open-source software package managers for OS X (MacPorts, Homebrew,
+ Fink etc.) to build and then install the privoxy binary and
+ associated files. The macsetup module's README file contains complete
+ instructions for its use.
+
+
The privoxy service will automatically start after a successful
+ installation (and thereafter every time your computer starts up)
+ however you will need to configure your web browser(s) to use it. To
+ do so, configure them to use a proxy for HTTP and HTTPS at the
+ address 127.0.0.1:8118.
+
+
To prevent the privoxy service from automatically starting when
+ your computer starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist (on OS
+ X 10.5 and higher) or the folder named /Library/StartupItems/Privoxy (on OS X 10.4
+ 'Tiger').
To manually start or stop the privoxy service, use the Privoxy
- Utility for Mac OS X. This application controls the privoxy service
- (e.g. starting and stopping the service as well as uninstalling the
- software).
+ Utility for Mac OS X (also part of the macsetup module). This
+ application can start and stop the privoxy service and display its
+ log and configuration files.
+
+
To uninstall, run the macsetup module's uninstall.sh as sudo from
+ an administrator account.
Gentoo source packages (Ebuilds) for Privoxy are contained in the Gentoo Portage Tree
@@ -254,7 +308,7 @@ body {
Configuration files are in /etc/privoxy,
the documentation is in /usr/share/doc/privoxy-3.0.19 and the Log directory
+ "FILENAME">/usr/share/doc/privoxy-3.0.20 and the Log directory
is in /var/log/privoxy.
@@ -289,8 +343,8 @@ body {
- tar xzvf privoxy-3.0.19-stable-src.tar.gz
- cd privoxy-3.0.19-stable
+ tar xzvf privoxy-3.0.20-beta-src.tar.gz
+ cd privoxy-3.0.20-beta
This documentation is included with the current stable version of
- Privoxy, v.3.0.19.
+
This documentation is included with the current UNRELEASED version of
+ Privoxy, v.3.0.20, and is mostly
+ complete at this point. The most up to date reference for the time being
+ is still the comments in the source files and in the individual
+ configuration files. Development of a new version is currently nearing
+ completion, and includes significant changes and enhancements over
+ earlier versions.
+
+
Since this is a UNRELEASED version, not all new features are well
+ tested. This documentation may be slightly out of sync as a result
+ (especially with CVS sources). And there may be bugs, though hopefully not many!