*** Version 2.9.13 Beta ***
- *NEWS*: The project has been renamed to Privoxy! The new name is
- reflected throughout (file locations, etc).
+reflected throughout (file locations, etc).
- ijb.action is now default.action. re_filterfile is now
- default.filter.
+default.filter.
- http://i.j.b/ is now http://p.p/
- The 'logo' option for replacing ad iamges is removed now. 'Pattern'
- (checkerboard) is now the default.
+(checkerboard) is now the default.
- RPM spec file make over.
*** Version 2.9.12 Beta ***
- **READ**: The default listening PORT is NOW 8118!!! Changed from
- 8000 due to conflict with NAS (Network Audio Server, whatever that
- is.)
+8000 due to conflict with NAS (Network Audio Server, whatever that
+is.)
- More CGI actions editor fixes and improvements.
- Win32 command line fix ups.
- re_filterfile now has modular sections that can be activated on a
- per site basis. Some new goodies there too.
+per site basis. Some new goodies there too.
- +filter now takes arguments to match FILTER sections in re_filterfile
- for even more flexibility.
+for even more flexibility.
- Added a new image blocker option: +image-blocker{pattern}, which
- displays a checkerboard patthern and scales better than the logo.
+displays a checkerboard patthern and scales better than the logo.
- PNG images will be used in place of GIF for JB built-in images
- if configured with --enable-no-gif.
+if configured with --enable-no-gif.
- Clean up compiler warnings (mostly).
- Improved handling of failed DNS lookups & diagnostics for failed bind
- to listen socket
+to listen socket
- Made --no-daemon mode log to tty instead of logfile.
- Various spec file and init script cleanups and improvements (Redhat and
- SuSE).
+SuSE).
- CGI Editor works on OS/2 now.
- Fix restart failure where sockets were in TIME_WAIT.
- Fixes for actions cgi editor, make sure we have right file.
- A --pidfile command line option now, in addition to --help,
- --version, --no-daemon, --user and configfile. --no-daemon replaces
- the former -d option and _DEBUG define. --user will drop privileges
- to the specified user.
+--version, --no-daemon, --user and configfile. --no-daemon replaces
+the former -d option and _DEBUG define. --user will drop privileges
+to the specified user.
- Signal handling cleanups (*nix).
- CGI actions editor improvements and fixes.
- Error handling improvements, especially out of memory.
- Default re_filterfile fix that caused spurious IJB logos
- (instead of 'blank').
+(instead of 'blank').
- configure.in threading fixes for Solaris.
- Various other minor fixes.
# Note: Makefile is built automatically from Makefile.in
#
-# $Id: GNUmakefile.in,v 1.85 2002/04/14 01:05:34 hal9 Exp $
+# $Id: GNUmakefile.in,v 1.78 2002/04/09 13:37:11 sarantis Exp $
#
# Written by and Copyright (C) 2001 the SourceForge
# Privoxy team. http://www.privoxy.org/
WDUMP = @WDUMP@ -dump
JADECAT = @JADECAT@
JADEBIN = @JADEBIN@
-DB = $(JADEBIN) $(JADECAT) -ihtml -t sgml -D.. -d ldpOK.dsl\#html
+DB = $(JADEBIN) $(JADECAT) -t sgml -ihtml -D.. -d ldpOK.dsl\#html
DB2HTML = @DB2HTML@
DKPREFIX = @DKPREFIX@
MAN2HTML = @MAN2HTML@
$(ECHO) "*** ***"; \
$(ECHO) "***************************************************"; \
$(ECHO) "Type \"yes i am sure\" if you are sure that you"; \
- $(ECHO) -n "really want to proceed: "; \
+ $(ECHO) -n "want to continue: "; \
read answer; \
if [ "$$answer" != "yes i am sure" ]; then exit 1; fi \
fi;
#############################################################################
-# Tarball distribution: No CVS dirs, dotfiles, debian build dir,
-# (FIXME:) only parts of the static / generated docs mix in doc/webserver
+# Tarball distribution. Only source files. No binaries.
#############################################################################
-tarball-dist: dist-check clean clobber
- $(LN) -s current ../privoxy-$(VERSION)-$(CODE_STATUS)
-
- for i in `find . -type f -a -not \( -path "*/CVS*" -o -name ".*" \
- -o -path "*/debian/*" -o -path "*/actions/*" -o -name "*.php" \)`; do \
- files="$$files privoxy-$(VERSION)-$(CODE_STATUS)/$$i"; \
- done && \
- cd .. && $(TAR) cvhf privoxy-$(VERSION)-$(CODE_STATUS)-src.tar $$files ; \
+MISC_FILES = install-sh config.sub configure.in GNUmakefile.in config.h.in config.guess privoxy*
+tarball-dist: dist-check
+ $(LN) -s current ../privoxy-$(VERSION)-$(CODE_STATUS)
+# add source files
+ for foo in `find . -name "*.c"`; do \
+ (cd .. && $(TAR) -uvhf privoxy-$(VERSION)-$(CODE_STATUS)-src.tar privoxy-$(VERSION)-$(CODE_STATUS)/$$foo;) \
+ done;
+# add header files
+ for foo in `find . -name "*.h"`; do \
+ (cd .. && $(TAR) -uvhf privoxy-$(VERSION)-$(CODE_STATUS)-src.tar privoxy-$(VERSION)-$(CODE_STATUS)/$$foo;) \
+ done;
+# add config files
+ for foo in $(CONFIG_FILES); do \
+ (cd .. && $(TAR) -uvhf privoxy-$(TARGET_OS)-$(VERSION)-$(CODE_STATUS)-src.tar privoxy-$(VERSION)-$(CODE_STATUS)/$$foo;) \
+ done;
+# add misc files
+ for foo in $(MISC_FILES); do \
+ (cd .. && $(TAR) -uvhf privoxy-$(VERSION)-$(CODE_STATUS)-src.tar privoxy-$(VERSION)-$(CODE_STATUS)/$$foo;) \
+ done;
+# add documentation
+ for foo in $(DOC_FILES); do \
+ (cd .. && $(TAR) -uvhf privoxy-$(VERSION)-$(CODE_STATUS)-src.tar privoxy-$(VERSION)-$(CODE_STATUS)/$$foo;) \
+ done;
# and zip the archive
- $(RM) ../privoxy-$(VERSION)-$(CODE_STATUS)
+ $(RM) ../privoxy-$(VERSION)-$(CODE_STATUS)
$(GZIP_PROG) ../privoxy-$(VERSION)-$(CODE_STATUS)-src.tar
@$(ECHO) Tarball distribution created.
# anonymously ncftps the tarball to sourceforge
tarball-upload:
- ncftpput -u anonymous -p ijbswa-developers@lists.sourceforge.net upload.sourceforge.net /incoming ../privoxy-$(VERSION)-$(CODE_STATUS)-src.tar.gz
+ ncftpput -u anonymous -p ijbswa-developers@lists.sourceforge.net upload.sourceforge.net /incoming privoxy-$(VERSION)-$(CODE_STATUS)-src.tar.gz
@$(ECHO) -------------------------------------------------------
@$(ECHO) Now goto
@$(ECHO) http://sourceforge.net/project/admin/editpackages.php?group_id=11118
@$(ECHO) ... and release the files.
@$(ECHO) -------------------------------------------------------
+# handle with care
tarball-clean:
- $(RM) ../privoxy-$(VERSION)-$(CODE_STATUS)-src.tar.gz
+ $(RM) privoxy-$(VERSION)-$(CODE_STATUS)-src.tar.gz
#############################################################################
#
# webserver files
dok-webserver: doc/source/ldpOK.dsl
cd doc/source/webserver && $(DB) -V nochunks index.sgml > ../../webserver/index.html
- $(PERL) -pi.bak -e 's/..\/p_doc.css/p_web.css/;\
+ $(PERL) -pi -e 's/..\/p_doc.css/p_web.css/;\
s/<\/HEAD/\n<meta name=\"description\" content=\"Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.\"><\/HEAD/;\
s/<\/HEAD/\n<meta name="MSSmartTagsPreventParsing" content="TRUE"><\/HEAD/'\
- doc/webserver/index.html && rm -f doc/source/webserver/*.bak
+ doc/webserver/index.html
-# Main documentation target.
+# Removed dok-man 04/08/02, hal. Added authors and dok-release. And
+# dok-webserver!
dok: dok-release dok-devel dok-user dok-faq dok-readme dok-webserver authors
# kludge to force recreation on next run. Rodgrigo?
@rm -f doc/source/ldpOK.dsl
mkdir -p doc/webserver/man-page
ifneq ($(MAN2HTML),false)
$(MAN2HTML) privoxy.1 |grep -v "^Content-type" > tmp.html
- $(PERL) -pi
.bak -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' tmp.html
- $(PERL) -pi.bak -e 's/(<\/HEAD>)/<LINK REL=\"STYLESHEET\" TYPE=\"text\/css\" HREF=\"..\/p_doc.css\"><\/HEAD>/' tmp.html
-# Get rid of spurious \a from conversion. (How to do this with perl?)
- $(SED) -e 's/\a//g' tmp.html > doc/webserver/man-page/privoxy-man-page.html && rm -f tmp.*
+ $(PERL) -pi -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' tmp.html
+ $(PERL) -pi -e 's/(<\/HEAD>)/<LINK REL=\"STYLESHEET\" TYPE=\"text\/css\" HREF=\"..\/p_doc.css\"><\/HEAD>/' tmp.html
+# Get rid of spurious \a from converion. (How to do this with perl?)
+ $(SED) -e 's/\a//g' tmp.html > doc/webserver/man-page/privoxy-man-page.html && rm -f tmp.html
else
$(MAKE) groff2html
endif
@rm -f doc/source/ldpOK.dsl
# make a man page, and then (lousy) HTML version.
-# Requires docbook2man (short perl script), see comments
-# in privoxy-man-page.sgml. This target is not invoked from other dok targets.
-# It is built separately due to dependencies on perl scripts.
+# Requires docbook2man (short perl script), see CVS
+# http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
+# perl module. This target is not invoked from other dok targets. It is
+# built separately due to dependencies on perl scripts.
man: doc/source/ldpOK.dsl
mkdir -p doc/source/man
cd doc/source/man && docbook2man ../privoxy-man-page.sgml &&\
- perl -pi.bak -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
+ perl -pi -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
cd doc/source/man && $(DB) ../privoxy-man-page.sgml &&\
mv -f index.html privoxy-man-page.html
# This html is not used. See make man2html.
# Set doc entities for VERSION and CODE_STATUS in sgml docs. Toggle content
# exceptions accordingly. This needs to go before any doc building (doh).
-dok-release:
+make dok-release:
@$(ECHO) Setting doc version and status to $(VERSION), $(CODE_STATUS)
- @$(PERL) -pi.bak -e 's/<!entity +p-version.*>/<!entity p-version "$(VERSION)">/;\
+ @$(PERL) -pi -e 's/<!entity +p-version.*>/<!entity p-version "$(VERSION)">/;\
s/<!entity +p-status.*>/<!entity p-status "$(CODE_STATUS)">/' \
doc/source/*sgml doc/source/*/*sgml
- rm -fr doc/source/*bak doc/source/*/*bak
ifeq ($(CODE_STATUS),stable)
@$(ECHO) Setting docs to stable $(VERSION)
- @$(PERL) -pi.bak -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "INCLUDE">/;\
+ @$(PERL) -pi -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "INCLUDE">/;\
s/<!entity +% +p-not-stable.*>/<!entity % p-not-stable "IGNORE">/' \
doc/source/*sgml doc/source/*/*sgml
- rm -fr doc/source/*bak doc/source/*/*bak
else
@$(ECHO) Setting docs to not stable $(VERSION)
- @$(PERL) -pi.bak -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "IGNORE">/;\
+ @$(PERL) -pi -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "IGNORE">/;\
s/<!entity +% +p-not-stable.*>/<!entity % p-not-stable "INCLUDE">/' \
doc/source/*sgml doc/source/*/*sgml
- rm -fr doc/source/*bak doc/source/*/*bak
endif
#############################################################################
## end:
# $Log: GNUmakefile.in,v $
-# Revision 1.85 2002/04/14 01:05:34 hal9
-# Revert dok-webserver change for SF logo.
-#
-# Revision 1.84 2002/04/13 22:43:25 hal9
-# -Fix dok-webserver for SF logo (more perl).
-# -Change all perl -pi to perl -pi.bak for Cygwin problem.
-#
-# Revision 1.83 2002/04/12 09:39:25 oes
-# Excluding yet more files from tarball; making dist warning yet more scary
-#
-# Revision 1.82 2002/04/11 21:07:11 oes
-# Excluding more files from tarball build
-#
-# Revision 1.81 2002/04/11 14:40:27 oes
-# Fixed typo -- Thanks, Moritz!
-#
-# Revision 1.80 2002/04/11 12:50:00 oes
-# Fixed tarball-dist target
-#
-# Revision 1.79 2002/04/11 06:49:28 oes
-# webserver target: silenced timestamp warnings resulting from uploading westwards, made permissions fixing independant of screwed local dir permissions, suppress (false alarm) make error if not owner of feedback log
-#
# Revision 1.78 2002/04/09 13:37:11 sarantis
# fix tar options typo
#
-# $Id: Makefile,v 1.4 2002/04/09 16:38:10 oes Exp $
+# $Id: Makefile,v 1.3 2002/03/26 22:29:54 swa Exp $
#
# Written by and Copyright (C) 2001 the SourceForge
# Privoxy team. http://www.privoxy.org/
# Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# $Log: Makefile,v $
-# Revision 1.4 2002/04/09 16:38:10 oes
-# Added option to run the whole build process
-#
# Revision 1.3 2002/03/26 22:29:54 swa
# we have a new homepage!
#
echo "***"; \
echo -n "*** Shall I do this for you now? (y/n) "; \
read answer; \
- if [ $$answer = "y" ]; then \
+ if [ $$answer == "y" ]; then \
autoheader && autoconf && ./configure && make;\
fi; \
fi
*********************************************************************/
-This README is included with the development version of Privoxy 2.9.14, which
+This README is included with the development version of Privoxy 2.9.13, which
will eventually become Privoxy v3.0 (and soon we hope!). See http://
www.privoxy.org/ for more information. The current code level is beta, and
seems stable to us :).
To build Privoxy from source, autoconf and GNU make (gmake) are required.
Source is available as gzipped tar archives. For this, first unpack the source:
- tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.14-beta
+ tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.13-beta
For retrieving the current CVS sources, you'll need the CVS package installed
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge Support Forum to get help:
+ * Use the Sourceforge Support Forum to get help:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only through our Sourceforge Bug Forum:
+ * Submit bugs only through our Sourceforge Bug Forum:
http://sourceforge.net/tracker/?group_id=11118&atid=111118.
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only through our Sourceforge feature request forum:
+ * Submit feature requests only through our Sourceforge feature request forum:
http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
- * You can also send feedback on websites that Privoxy has problems with. Please bookmark
- the following link: "Privoxy - Submit Filter Feedback"
- . 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.
+ * Submit missed ads and banners, and incorrectly blocked images, popups, etc:
+
+ http://p.p/, and select "actions file feedback system"
- * For any other issues, feel free to use the mailing lists:
+ This page can also be reached from many of the internal CGI pages.
+
+ * For any other issues, feel free to use the mailing lists:
http://sourceforge.net/mail/?group_id=11118.
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
-------------------------------------------------------------------------
ijbswa-developers@lists.sourceforge.net
-$Id: readme.sgml,v 1.8 2002/04/12 10:09:50 swa Exp $
+$Id: readme.sgml,v 1.6 2002/04/08 22:59:26 hal9 Exp $
*
* Revisions :
* $Log: acconfig.h,v $
- * Revision 1.25 2002/04/06 20:38:01 jongfoster
- * Renaming VC++ versions of config.h
- *
* Revision 1.24 2002/04/04 00:36:36 gliptak
* always use pcre for matching
*
#undef HAVE_GMTIME_R
#undef HAVE_LOCALTIME_R
-/* Define to 'int' if <sys/socket.h> doesn't have it.
- */
-#undef socklen_t
-
-
@BOTTOM@
/*
-const char cgi_rcs[] = "$Id: cgi.c,v 1.62 2002/04/10 19:59:46 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.61 2002/04/10 13:37:48 oes Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
*
* Revisions :
* $Log: cgi.c,v $
- * Revision 1.62 2002/04/10 19:59:46 jongfoster
- * Fixes to #include in templates:
- * - Didn't close main file if loading an included template fails.
- * - I'm paranoid and want to disallow "#include /etc/passwd".
- *
* Revision 1.61 2002/04/10 13:37:48 oes
* Made templates modular: template_load now recursive with max depth 1
*
* Function : dispatch_cgi
*
* Description : Checks if a request URL has either the magical
- * hostname CGI_SITE_1_HOST (usually http://p.p/) or
+ * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
* matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
* http://ijbswa.sourceforge.net/config). If so, it passes
* the (rest of the) path onto dispatch_known_cgi, which
# Sample Configuration file for Privoxy
#
-# $Id: config,v 1.32 2002/04/02 20:11:35 oes Exp $
+# $Id: config,v 1.31 2002/03/24 12:58:57 swa Exp $
#
# Table of Contents
# require up to buffer-limit Kbytes *each*, unless you have set
# single-threaded below.
#
-# Default: 4096, i.e. 4 MB
+# Default: 4069, i.e. 4 MB
#
-buffer-limit 4096
+buffer-limit 4069
#
dnl Process this file with autoconf to produce a configure script.
dnl
-dnl $Id: configure.in,v 1.62 2002/04/11 10:09:20 oes Exp $
+dnl $Id: configure.in,v 1.61 2002/04/10 18:14:45 morcego Exp $
dnl
dnl Written by and Copyright (C) 2001, 2002 the SourceForge
dnl Privoxy team. http://www.privoxy.org/
dnl Temple Place - Suite 330, Boston, MA 02111-1307, USA.
dnl
dnl $Log: configure.in,v $
-dnl Revision 1.62 2002/04/11 10:09:20 oes
-dnl Version 2.9.14
-dnl
dnl Revision 1.61 2002/04/10 18:14:45 morcego
dnl - (privoxy-rh.spec only) Relisting template files on the %%files section
dnl - (configure.in, privoxy-rh.spec) Bumped package release to 5
dnl AutoConf Initialization
dnl =================================================================
-AC_REVISION($Revision: 1.62 $)
+AC_REVISION($Revision: 1.61 $)
AC_INIT(jcc.c)
if test ! -f config.h.in; then
dnl =================================================================
dnl Solaris specific
dnl FIXME: Not tested on Solaris yet...
-dnl ISFIXED: Have tested it on Solaris, but there are other ways to
-dnl make these checks generic, e.g.:
-dnl AC_CHECK_FUNC(getsockopt, , AC_CHECK_LIB(socket, getsockopt))
-dnl (Moritz Barsnick <moritz@barsnick.net>)
dnl =================================================================
AC_SUBST(SOCKET_LIB)
-dnl =================================================================
-dnl Solaris problem, and others perhaps (socklen_t is undefined)
-dnl =================================================================
-
-AC_MSG_CHECKING([for socklen_t])
-AC_EGREP_HEADER(socklen_t, sys/socket.h, AC_MSG_RESULT([yes]),
- AC_MSG_RESULT([no])
- AC_DEFINE(socklen_t,int,
- [ Define to 'int' if <sys/socket.h> doesn't have it. ]))
-
-
dnl =================================================================
dnl OS/2 specific
dnl =================================================================
# For information, see http://www.oesterhelt.org/testdrive
#
#############################################################################
-
-######################################################################
-#
-# File : $Source: /cvsroot/ijbswa/current/default.action,v $
-#
-# $Id: default.action,v 1.14 2002/04/08 20:47:24 swa Exp $
-#
-# Purpose : Default actions file, see
-# http://www.privoxy.org/faq/questions.html#CONFIGFILES
-#
-# Copyright : Written by and Copyright
-# Privoxy team. http://www.privoxy.org/
-#
-# Based on the Internet Junkbuster originally written
-# by and Copyright (C) 1997 Anonymous Coders and
-# Junkbusters Corporation. http://www.junkbusters.com
-#
-# We value your feedback. However, to provide you with the best support,
-# please note:
-#
-# * Use the support forum to get help:
-# http://sourceforge.net/tracker/?group_id=11118&atid=211118
-# * Submit feedback for this actions file only through our
-# actions file feedback script: http://www.privoxy.org/actions
-# * Submit bugs only through our bug forum:
-# http://sourceforge.net/tracker/?group_id=11118&atid=111118
-# Make sure that the bug has not already been submitted. Please try
-# to verify that it is a Privoxy bug, and not a browser or site
-# bug first. If you are using your own custom configuration, please
-# try the stock configs to see if the problem is a configuration
-# related bug. And if not using the latest development snapshot,
-# please try the latest one. Or even better, CVS sources.
-# * Submit feature requests only through our feature request forum:
-# http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
-#
-# For any other issues, feel free to use the mailing lists:
-# http://sourceforge.net/mail/?group_id=11118
-#
-# Anyone interested in actively participating in development and related
-# discussions can join the appropriate mailing list here:
-# http://sourceforge.net/mail/?group_id=11118. Archives are available
-# here too.
-#
-#############################################################################
-# Syntax
-#############################################################################
-#
-# To determine which actions apply to a request, the URL of the request is
-# compared to all patterns in this file. Every time it matches, the list of
-# applicable actions for this URL is incrementally updated. You can trace
-# this process by visiting http://i.j.b/show-url-info
-#
-# There are 4 types of lines in this file: comments (like this line),
-# actions, aliases and patterns, all of which are explained below.
-#
-#############################################################################
-# Pattern Syntax
-#############################################################################
-#
-# 1. On Domains and Paths
-# -----------------------
-#
-# Generally, a pattern has the form <domain>/<path>, where both the <domain>
-# and <path> part are optional. If you only specify a domain part, the "/"
-# can be left out:
-#
-# www.example.com
-# is a domain-only pattern and will match any request to www.yahoo.com
-#
-# www.example.com/
-# means exactly the same (but is slightly less efficient)
-#
-# www.example.com/index.html
-# matches only the document /index.html on www.example.com
-#
-# /index.html
-# matches the document /index.html, regardless of the domain
-#
-# index.html
-# matches nothing, since it would be interpreted as a domain name and
-# there is no top-level domain called ".html".
-#
-# 2. Domain Syntax
-# ----------------
-#
-# The matching of the domain part offers some flexible options: If the
-# domain starts or ends with a dot, it becomes unanchored at that end:
-#
-# www.example.com
-# matches only www.example.com
-#
-# .example.com
-# matches any domain that ENDS in .example.com
-#
-# www.
-# matches any domain that STARTS with www.
-#
-# Additionally, there are wildcards that you can use in the domain names
-# themselves. They work pretty similar to shell wildcards: "*" stands for
-# zero or more arbitrary characters, "?" stands for one, and you can define
-# charachter classes in square brackets and they can be freely mixed:
-#
-# ad*.example.com
-# matches adserver.example.com, ads.example.com, etc but not sfads.example.com
-#
-# *ad*.example.com
-# matches all of the above
-#
-# .?pix.com
-# matches www.ipix.com, pictures.epix.com, a.b.c.d.e.upix.com etc
-#
-# www[1-9a-ez].example.com
-# matches www1.example.com, www4.example.com, wwwd.example.com,
-# wwwz.example.com etc, but not wwww.example.com
-#
-# You get the idea?
-#
-# 2. Path Syntax
-# --------------
-#
-# Paths are specified as regular expressions. A comprehensive discussion of
-# regular expressions wouldn't fit here, but (FIXME) someone should paste
-# a concise intro to the regex language here.
-#
-# If Privoxy was compiled with pcre support (default), Perl compatible
-# regular expressions are used. See the pcre/docs/ direcory or man perlre
-# (also available on http://www.perldoc.com/perl5.6/pod/perlre.html) for
-# details.
-#
-# Please note that matching in the path is CASE INSENSITIVE by default, but
-# you can switch to case sensitive by starting the pattern with the "(?-i)"
-# switch:
-#
-# www.example.com/(?-i)PaTtErN.*
-# will match only documents whose path starts with PaTtErN in exactly this
-# capitalization.
-#
-# Partially case-sensetive and partially case-insensitive patterns are
-# possible, but the rules about splitting them up are extremely complex
-# - see the PCRE documentation for more information.
-#
-#############################################################################
-# Action Syntax
-#############################################################################
-#
-# There are 3 kinds of action:
-#
-# Boolean (e.g. "block"):
-# +name # enable
-# -name # disable
-#
-# Parameterized (e.g. "hide-user-agent"):
-# +name{param} # enable and set parameter to "param"
-# -name # disable
-#
-# Multi-value (e.g. "add-header", "wafer"):
-# +name{param} # enable and add parameter "param"
-# -name{param} # remove the parameter "param"
-# -name # disable totally
-#
-# The default (if you don't specify anything in this file) is not to take
-# any actions - i.e completely disabled, so Privoxy will just be a
-# normal, non-blocking, non-anonymizing proxy. You must specifically
-# enable the privacy and blocking features you need (although the
-# provided default actions file will do that for you).
-#
-# Later actions always override earlier ones. For multi-valued actions,
-# the actions are applied in the order they are specified.
-#
-#############################################################################
-# Valid actions are:
-#############################################################################
-#
-# +add-header{Name: value}
-# Adds the specified HTTP header, which is not checked for validity.
-# You may specify this many times to specify many headers.
-#
-# +block
-# Block this URL
-#
-# +deanimate-gifs{last}
-# +deanimate-gifs{first}
-# Deanimate all animated GIF images, i.e. reduce them to their last
-# frame. This will also shrink the images considerably. (In bytes,
-# not pixels!)
-# If the option "first" is given, the first frame of the animation
-# is used as the replacement. If "last" is given, the last frame of
-# the animation is used instead, which propably makes more sense for
-# most banner animations, but also has the risk of not showing the
-# entire last frame (if it is only a delta to an earlier frame).
-#
-# +downgrade
-# Downgrade HTTP/1.1 client requests to HTTP/1.0 and downgrade the
-# responses as well. Use this action for servers that use HTTP/1.1
-# protocol features that Privoxy currently can't handle yet.
-#
-# +fast-redirects
-# Many sites, like yahoo.com, don't just link to other sites.
-# Instead, they will link to some script on their own server,
-# giving the destination as a parameter, which will then redirect
-# you to the final target.
-#
-# URLs resulting from this scheme typically look like:
-# http://some.place/some_script?http://some.where-else
-#
-# Sometimes, there are even multiple consecutive redirects encoded
-# in the URL. These redirections via scripts make your web browing
-# more traceable, since the server from which you follow such a link
-# can see where you go to. Apart from that, valuable bandwidth and
-# time is wasted, while your browser aks the server for one redirect
-# after the other. Plus, it feeds the advertisers.
-#
-# The +fast-redirects option enables interception of these requests
-# by Privoxy, who will cut off all but the last valid URL in the
-# request and send a local redirect back to your browser without
-# contacting the intermediate sites.
-#
-# +filter{name}
-# Filter the website through one or more regular expression filters.
-# Repeat for multiple filters.
-#
-# Filters predefined in the supplied re_filterfile include:
-#
-# html-annoyances: Get rid of particularly annoying HTML abuse
-# js-annoyances: Get rid of particularly annoying JavaScript abuse
-# no-poups: Kill all popups in JS and HTML
-# frameset-borders: Give frames a border
-# webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
-# no-refresh: Automatic refresh sucks on auto-dialup lines
-# fun: Text replacements for subversive browsing fun!
-# nimda: Remove (virus) Nimda code.
-# banners-by-size: Kill banners by size
-# crude-parental: Kill all web pages that contain the words "sex" or "warez"
-#
-#
-# +hide-forwarded
-# Block any existing X-Forwarded-for header, and do not add a new one.
-#
-# +hide-from{block}
-# +hide-from{spam@sittingduck.xqq}
-# If the browser sends a "From:" header containing your e-mail address,
-# either completely removes the header ("block"), or change it to the
-# specified e-mail address.
-#
-# +hide-referer{block}
-# +hide-referer{forge}
-# +hide-referer{http://nowhere.com}
-# Don't send the "Referer:" (sic) header to the web site. You can
-# block it, forge a URL to the same server as the request (which is
-# preferred because some sites will not send images otherwise) or
-# set it to a constant string.
-#
-# +hide-referrer{...}
-# Alternative spelling of +hide-referer. Has the same parameters,
-# and can be freely mixed with, "+hide-referer". ("referrer" is the
-# correct English spelling, however the HTTP specification has a
-# bug - it requires it to be spelt "referer").
-#
-# +hide-user-agent{browser-type}
-# Change the "User-Agent:" header so web servers can't tell your
-# browser type. (Breaks many web sites). Specify the user-agent
-# value you want - e.g., to pretend to be using Netscape on Linux:
-# +hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}
-# Or to identify yourself explicitly as a Privoxy user:
-# +hide-user-agent{Privoxy/1.0}
-# (Don't change the version number from 1.0 - after all, why tell them?)
-#
-# +image
-# Treat this URL as an image. This only matters if it's also "+block"ed,
-# in which case a "blocked" image can be sent rather than a HTML page.
-# See +image-blocker{} for the control over what is actually sent.
-#
-# +image-blocker{blank}
-# +image-blocker{pattern}
-# +image-blocker{<URL>} with <url> being any valid image URL
-# Decides what to do with URLs that end up tagged with {+block +image}.
-# There are 4 options:
-# * "-image-blocker" will send a HTML "blocked" page, usually
-# resulting in a "broken image" icon.
-# * "+image-blocker{blank}" will send a 1x1 transparent image
-# * "+image-blocker{pattern}" will send a 4x4 grey/white pattern
-# which is less intrusive than the logo but easier to recognize
-# than the transparent one.
-# * "+image-blocker{<URL>}" will send a HTTP temporary redirect
-# to the specified image URL.
-#
-#
-# +limit-connect{portlist}
-# The CONNECT methods exists in HTTP to allow access to secure websites
-# (https:// URLs) through proxies. It works very simply: The proxy
-# connects to the server on the specified port, and then short-circuits
-# its connections to the cliant and to the remote proxy.
-# This can be a big security hole, since CONNECT-enabled proxies can
-# be abused as TCP relays very easily.
-# By default, i.e. in the absence of a +limit-connect action, Privoxy
-# will only allow CONNECT requests to port 443, which is the standard port
-# for https.
-# If you want to allow CONNECT for more ports than that, or want to forbid
-# CONNECT altogether, you can specify a comma separated list of ports and port
-# ranges (the latter using dashes, with the minimum defaulting to 0 and max to 65K):
-#
-# +limit-connect{443} # This is the default and need no be specified.
-# +limit-connect{80,443} # Ports 80 and 443 are OK.
-# +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100, and above 500 are OK.
-#
-# +no-compression
-# Prevent the website from compressing the data. Some websites do
-# that, which is a problem for Privoxy, since +filter, +no-popup
-# and +gif-deanimate will not work on compressed data. Will slow down
-# connections to those websites, though.
-#
-# +no-cookies-keep
-# If the website sets cookies, make sure they are erased when you exit
-# and restart your web browser. This makes profiling cookies useless,
-# but won't break sites which require cookies so that you can log in
-# or for transactions.
-#
-# +no-cookies-read
-# Prevent the website from reading cookies
-#
-# +no-cookies-set
-# Prevent the website from setting cookies
-#
-# +no-popup
-# +no-popups
-# Filter the website through a built-in filter to disable
-# 1;''.concat() etc. The two alternative spellings are
-# equivalent.
-#
-# +vanilla-wafer
-# This action only applies if you are using a jarfile. It sends a
-# cookie to every site stating that you do not accept any copyright
-# on cookies sent to you, and asking them not to track you. Of
-# course, this is a (relatively) unique header they could use to
-# track you.
-#
-# +wafer{name=value}
-# This allows you to add an arbitrary cookie. Specify it multiple
-# times in order to add several cookies.
-#
-#############################################################################
-
-
-#############################################################################
-# Aliases
-#############################################################################
{{alias}}
-#############################################################################
-#
-# You can define a short form for a list of permissions - e.g., instead
-# of "-no-cookies-set -no-cookies-read -filter -fast-redirects", you can
-# just write "shop". This is called an alias.
-#
-# Currently, an alias can contain any character except space, tab, '=', '{'
-# or '}'.
-# But please use only 'a'-'z', '0'-'9', '+', and '-'.
-#
-# Alias names are not case sensitive.
-#
-# Aliases beginning with '+' or '-' may be used for system permission names
-# in future releases - so try to avoid alias names like this. (e.g.
-# "+no-cookies" below is not a good name)
-#
-# Aliases must be defined before they are used.
-#
-
# Useful aliases
-+no-cookies = +no-cookies-set +no-cookies-read
--no-cookies = -no-cookies-set -no-cookies-read
+imageblock = +block +image
# Fragile sites should have the minimum changes
-fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer -no-cookies -no-popups
+fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer -no-cookies-keep -no-popups
# Shops should be allowed to set persistent cookies
-shop = -filter -no-cookies -no-cookies-keep
-
-# Your favourite blend of filters:
-#
-myfilters = +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
- +filter{webbugs} +filter{nimda} +filter{banners-by-size} #+filter{fun}
-
-#... etc. Customize to your heart's content.
+shop = -filter -no-cookies-keep
#############################################################################
# Defaults
+filter{webbugs} \
+filter{nimda} \
+filter{banners-by-size} \
++no-compression \
+hide-forwarded \
+hide-from{block} \
+hide-referer{forge} \
-hide-user-agent \
-image \
+image-blocker{pattern} \
-+no-compression \
+no-cookies-keep \
-no-cookies-read \
-no-cookies-set \
}
/ # Match all URLs
+{+filter{noflash}}
+.moorhuhn.de
+[+filter{reorder}}
+.oesterhelt.org
#############################################################################
# Needed for automatic feedback evaluation; Please don't delete!
#BLOCK-REFERRER: http://www.altavista.com/
.ad.doubleclick.net
-.a.yimg.com/(?:(?!/i/).)*$
-.a[0-9].yimg.com/(?:(?!/i/).)*$
-
-
-
#BLOCK-REFERRER:
bs*.gsanet.com
bs*.einets.com
Purpose : Entity included in other project documents.
- $Id: buildsource.sgml,v 1.2 2002/04/06 05:07:28 hal9 Exp $
+ $Id: buildsource.sgml,v 1.1 2002/04/04 06:48:37 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
-->
<para>
- To build <application>Privoxy</application> from source,
- autoheader, autoconf,GNU make (gmake), and, of course, a C
- compiler are required.
+ There are several ways to install <application>Privoxy</application>.
</para>
<para>
- When building from a source tarball (either release version or
- nightly CVS tarball), first unpack the source:
+ To build <application>Privoxy</application> from source,
+ autoconf and GNU make (gmake) are required. Source is available as gzipped
+ tar archives. For this, first unpack the source:
</para>
<para>
</screen>
</para>
+
<para>
- For retrieving the current CVS sources, you'll need CVS installed.
- Note that sources from CVS are development quality, and may not be
- stable, or well tested. To download CVS source:
+ For retrieving the current CVS sources, you'll need the CVS
+ package installed first. Note CVS source is development quality,
+ and may not be stable, or well tested. To download CVS source:
</para>
<para>
<screen>
autoheader
autoconf
- ./configure # (--help to see options)
- make # (the make from gnu, gmake for *BSD)
+ ./configure (--help to see options)
+ make (the make from gnu, gmake for *BSD)
su
- make -n install # (to see where all the files will go)
- make install # (to really install)
- </screen>
-</para>
-
-<para>
- If you have gnu make, you can have the first four steps
- automatically done for you by just typing
-</para>
-
-<para>
- <screen>
- make
+ make -n install (to see where all the files will go)
+ make install (to really install)
</screen>
</para>
-<para>
- in the freshly downloaded or unpacked source directory.
-</para>
-
<para>
Redhat and SuSE src and binary RPMs can be built with
<quote><command>make redhat-dist</command></quote> or
Purpose : Entity included in other project documents.
- $Id: contacting.sgml,v 1.7 2002/04/10 04:06:57 hal9 Exp $
+ $Id: contacting.sgml,v 1.5 2002/04/09 23:29:41 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<listitem>
<literallayout>
-Use the Sourceforge Support Forum to get help:
+ Use the Sourceforge Support Forum to get help:
<ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">http://sourceforge.net/tracker/?group_id=11118&atid=211118</ulink>
</literallayout>
<listitem>
<literallayout>
-Submit bugs only through our Sourceforge Bug Forum:
+ Submit bugs only through our 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>
<listitem>
<literallayout>
-Submit feature requests only through our Sourceforge feature request forum:
+ Submit feature requests only through our Sourceforge feature request forum:
<ulink url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"></ulink>.
</literallayout>
<listitem>
+<!-- FIXME -->
+<!--
+We will soon have an automated way to submit advertisements, incorrectly
+blocked images, popups and the like. Check back.
+-->
+<!-- <ulink url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"></ulink>. -->
<literallayout>
-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.
+ Submit missed ads and banners, and incorrectly blocked images, popups, etc:
+
+ <ulink url="http://p.p/">http://p.p/</ulink>, and 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());"><quote>actions file feedback system</quote></ulink>
</literallayout>
+ <para>
+ This page can also be reached from many of the internal CGI pages.
+ </para>
</listitem>
<listitem>
<literallayout>
-For any other issues, feel free to use the mailing lists:
+ 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>
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
</para>
</listitem>
<!entity seealso SYSTEM "seealso.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity copyright SYSTEM "copyright.sgml">
-<!entity p-version "2.9.14">
+<!entity p-version "2.9.13">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $
+ $Id: developer-manual.sgml,v 1.30 2002/04/11 09:24:53 oes Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<artheader>
<title>Privoxy Developer Manual</title>
- <pubdate>$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.30 2002/04/11 09:24:53 oes Exp $</pubdate>
<authorgroup>
<author>
<!-- Include privoxy.sgml boilerplate text: -->
-<!-- &p-intro; Someone interested enough in the project to contribute
- will already know at this point what Privoxy is. -->
+ &p-intro;
<!-- end boilerplate -->
<para>
You can find the latest version of the this manual at <ulink
url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
- Please see <ulink url="contact.html">the Contact section</ulink>
- on how to contact the developers.
+ Please see the Contact section on how to contact the developers.
</para>
<!-- <para> -->
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
<para>
- You'll need an account on <ulink
- url="http://sourceforge.net/">Sourceforge</ulink> to support our
- development. Mail your ID to <ulink
- url="mailto:developers@privoxy.org">the list</ulink> and wait until a
- project manager has added you.
- </para>
- <para>
- For the time being (read, this section is under construction), please
- refer to the extensive comments in the source code.
- </para>
- </sect1>
-
- <!-- ~~~~~ New section ~~~~~ -->
- <sect1 id="cvs"><title>The CVS Repository</title>
- <para>
- If you intend to help us with programming, documentation or packaging
- you will need write access to our holy grail, the CVS repository.
- Please read this chapter completely before accessing via CVS.
- </para>
-
- <sect2 id="cvsaccess"><title>Access to CVS</title>
- <para>
- The project's CVS repository is hosted on
- <ulink url="http://sourceforge.net/">SourceForge.</ulink>
- Please refer to the chapters 6 and 7 in
- <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
- documentation</ulink> for the technical access details for your
- operating system. For historical reasons, the CVS server is
- called <literal>cvs.ijbswa.sourceforge.net</literal>, the repository is
- called <literal>ijbswa</literal>, and the source tree module is called
- <literal>current</literal>.
- </para>
- </sect2>
-
- <sect2 id="cvscommit"><title>CVS Commit Guideline</title>
- <para>
- The source tree is the heart of every software project. Every effort must
- be made to ensure that it is readable, compilable and consistent at all
- times. We therefore ask anyone with CVS access to strictly adhere to the
- following guidelines:
- <itemizedlist>
- <listitem><para>
- Never (read: <emphasis>never, ever</emphasis>) be tempted to commit
- that small change without testing it thoroughly first. When we're
- close to a public release, ask a fellow developer to review your
- changes.
- </para></listitem>
- <listitem><para>
- Your commit message should give a concise overview of <emphasis>what you
- changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
- Just check previous messages for good examples.
- </para></listitem>
- <listitem><para>
- Don't use the same message on multiple files, unless it equally applies to
- all those files.
- </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.
- If necessary, prepare the commit messages in advance.
- </para></listitem>
- <listitem><para>
- Before changing things on CVS, make sure that your changes are in line
- with the team's general consensus on what should be done (see below).
- </para></listitem>
- </itemizedlist>
- </para>
- </sect2>
+You'll need an account on <ulink
+url="http://sourceforge.net">Sourceforge</ulink> to support our development.
+Mail your ID to the list and wait until a project manager has added you.
+</para>
- <sect2 id="cvswhenask"><title>Discussing Changes First</title>
- <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
- </para></listitem>
- <listitem><para>
- ..a new feature that can be turned off: shoot
- </para></listitem>
- <listitem><para>
- ..a clear improvement w/o side effects on other parts of the code: shoot
- </para></listitem>
- <listitem><para>
- ..a matter of taste: <ulink url="mailto:developers@privoxy.org">ask the list</ulink>
- </para></listitem>
- <listitem><para>
- ..a major redesign of some part of the code: <ulink url="mailto:developers@privoxy.org">ask
- the list</ulink>
- </para></listitem>
- </orderedlist>
- </para>
- <para>
- Note that near a major public release, we get a bit more cautious - if
- unsure, it doesn't hurt to ask first. There is always the possibility
- to submit a patch to the <ulink
- url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patches
- tracker</ulink> instead.
- </para>
- </sect2>
- </sect1>
+<para>
+For the time being (read, this section is under construction), please note the
+following guidelines for changing stuff in the code. If it is
+ <orderedlist numeration="arabic">
+ <listitem><para>
+ A bugfix / clean-up / cosmetic thing: shoot
+ </para></listitem>
+ <listitem><para>
+ A new feature that can be turned off: shoot
+ </para></listitem>
+ <listitem><para>
+ A clear improvement w/o side effects on other parts of the code: shoot
+ </para></listitem>
+ <listitem><para>
+ A matter of taste: ask the list
+ </para></listitem>
+ <listitem><para>
+ A major redesign of some part of the code: ask the list
+ </para></listitem>
+ </orderedlist>
+ </para>
+</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="documentation"><title>Documentation Guidelines</title>
<para>
- All formal documents are maintained in Docbook SGML and located in the
+ All formal documents are maintained in docbook SGML and located in the
<computeroutput>doc/source/*</computeroutput> directory. You will need
<ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
DTD's and the Docbook modular stylesheets (or comparable alternatives),
<para>
Other, less formal documents (e.g. <filename>LICENSE</filename>,
<filename>INSTALL</filename>) are maintained as plain text files in the
- top-level source directory. At least for the time being.
+ toplevel source directory. At least for the time being.
</para>
<para>
Packagers are encouraged to include this documentation. For those without
</para>
<para>
Documentation writers should please make sure documents build
- successfully before committing to CVS, if possible.
+ successfully before committing to CVS.
</para>
<para>
How do you update the webserver (i.e. the pages on privoxy.org)?
</orderedlist>
</para>
- <para>
- Finished docs should be occasionally submitted to CVS
- (<filename>doc/webserver/*/*.html</filename>) so that those without
- the ability to build them locally, have access to them if needed.
- This is especially important just prior to a new release! Please
- do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
- other release specific data in <filename>configure.in</filename> has been
- updated (this is done just prior to a new release).
- </para>
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="sgml">
Some common elements that you likely will use:
</para>
-<para>
- <simplelist>
- <member>
- <emphasis><para></para></emphasis>, paragraph delimiter. Most
- text needs to be within paragraph elements (there are some exceptions).
- </member>
- <member>
- <emphasis><emphasis></emphasis></emphasis>, the stylesheets
- make this italics.
- </member>
- <member>
- <emphasis><filename></filename></emphasis>, files and directories.
- </member>
- <member>
- <emphasis><command></command></emphasis>, command examples.
- </member>
- <member>
- <emphasis><literallayout></literallayout></emphasis>, like
- <literal><pre></literal>, more or less.
- </member>
- <member>
- <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
- </member>
- <member>
- <emphasis><listitem></listitem></emphasis>, member of the above.
- </member>
- <member>
- <emphasis><screen></screen></emphasis>, screen output, implies
- <literal><literallayout></literal>.
- </member>
- <member>
- <emphasis><ulink url="example.com"></ulink></emphasis>, like
- HTML <literal><a></literal> tag.
- </member>
- <member>
- <emphasis><quote></quote></emphasis>, for, doh, quoting text.
- </member>
- </simplelist>
-</para>
+<simplelist>
+ <member>
+ <emphasis><para></para></emphasis>, paragraph delimiter. Most
+ text needs to be within paragraph elements (there are some exceptions).
+ </member>
+ <member>
+ <emphasis><emphasis></emphasis></emphasis>, the stylesheets make this
+ italics.
+ </member>
+ <member>
+ <emphasis><filename></filename></emphasis>, files and directories.
+ </member>
+ <member>
+ <emphasis><command></command></emphasis>, command examples.
+ </member>
+ <member>
+ <emphasis><literallayout></literllayout></emphasis>, like
+ <literal><pre></literal>, more or less.
+ </member>
+ <member>
+ <emphasis><itemizedlist></itemizdelist></emphasis>, list with bullets.
+ </member>
+ <member>
+ <emphasis><listitem></listitem></emphasis>, member of the above.
+ </member>
+ <member>
+ <emphasis><screen></screen></emphasis>, screen output, implies
+ <literal><literallayout></literal>.
+ </member>
+ <member>
+ <emphasis><ulink url="example.com"></ulink></emphasis>, like
+ HTML <literal><a></literal> tag.
+ </member>
+ <member>
+ <emphasis><quote></quote></emphasis>, for, doh, quoting text.
+ </member>
+</simplelist>
<para>
Look at any of the existing docs for examples of all these and more.
</sect2>
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="docstyle">
<title><application>Privoxy</application> Documentation Style</title>
<listitem>
<para>
We have an international audience. Refrain from slang, or English
- idiosyncrasies (too many to list :). Humor also does not translate
- well sometimes.
+ idiosyncrasies (too many to list :).
</para>
</listitem>
<listitem>
<para>
Try to keep overall line lengths in source files to 80 characters or less
- for obvious reasons. This is not always possible, with lengthy URLs for
+ for obvious reasons. This is not always possible, with lenghty URLs for
instance.
</para>
</listitem>
<itemizedlist>
<listitem>
<para>
- Re- <quote>boilerplate</quote> text entities are defined like:
+ Re-cyclable <quote>boilerplate</quote> text entities are defined like:
</para>
<para>
<literal><!entity supported SYSTEM "supported.sgml"></literal>
<simplelist>
<member>
<emphasis>p-version</emphasis>: the <application>Privoxy</application>
- version string, e.g. <quote>&p-version;</quote>.
+ version string, e.g. <quote>2.9.13</quote>.
</member>
<member>
<emphasis>p-status</emphasis>: the project status, either
- <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
+ <quote>ALPHA</quote>, <quote>BETA</quote>, or <quote>STABLE</quote>.
</member>
<member>
<emphasis>p-not-stable</emphasis>: use to conditionally include
- text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
+ text in <quote>not stable</quote> releases (e.g. <quote>BETA</quote>).
</member>
<member>
<emphasis>p-stable</emphasis>: just the opposite.
<para><emphasis>Exception:</emphasis></para>
<para>If you are trying to add a small logic comment and do not
- wish to "disrupt" the flow of the code, feel free to use a 1
+ wish to "disrubt" the flow of the code, feel free to use a 1
line comment which is NOT on the same line as the code.</para>
<para><emphasis>Explanation:</emphasis></para>
- <para>Use all lowercase, and separate words via an underscore
+ <para>Use all lowercase, and seperate words via an underscore
('_'). Do not start an identifier with an underscore. (ANSI C
reserves these for use by the compiler and system headers.) Do
not use identifiers which are reserved in ANSI C++. (E.g.
<para><emphasis>Explanation:</emphasis></para>
- <para>Use all lowercase, and separate words via an underscore
+ <para>Use all lowercase, and seperate words via an underscore
('_'). Do not start an identifier with an underscore. (ANSI C
reserves these for use by the compiler and system headers.) Do
not use identifiers which are reserved in ANSI C++. (E.g.
<para><emphasis>Note:</emphasis> In the special case that the if-statement is
inside a loop, and it is trivial, i.e. it tests for a
- condition that is obvious from the purpose of the block,
+ condidtion that is obvious from the purpose of the block,
one-liners as above may optically preserve the loop structure
and make it easier to read.</para>
- <para><emphasis>Status:</emphasis> developer-discretion.</para>
+ <para><emphasis>Status:</emphasis> developer-discrection.</para>
<para><emphasis>Example exception:</emphasis></para>
<programlisting>
<para>if ( condition ) { structure->flag = 1; } else {
structure->flag = 0; }</para>
- <para><emphasis>Note:</emphasis> The former is readable and concise. The later
+ <para><emphasis>Note:</emphasis> The former is readable and consice. The later
is wordy and inefficient. Please assume that any developer new
to the project has at least a "good" knowledge of C/C++. (Hope
I do not offend by that last comment ... 8-)</para>
function2( ... ) { }</para>
<para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
- lines afterward. This makes the end of function standout to
+ lines afterwards. This makes the end of function standout to
the most casual viewer. Although function comments help
- separate functions, this is still a good coding practice. In
+ seperate functions, this is still a good coding practice. In
fact, I follow these rules when using blocks in "for", "while",
"do" loops, and long if {} statements too. After all whitespace
is free!</para>
- <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
+ <para><emphasis>Status:</emphasis> developer-discrection on the number of blank
lines. Enforced is the end of function comments.</para>
and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
arrayPtr[0].</para>
- <para><emphasis>Status:</emphasis> developer-discretion if and only if the
+ <para><emphasis>Status:</emphasis> developer-discrection if and only if the
variable is assigned a value "shortly after" declaration.</para>
</sect3>
<para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
- "file.h" behavior.</para>
+ "file.h" behaviour.</para>
</sect3>
<para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
pointer), then including the proper header file is necessary.
If you only want to prototype a pointer, however, the header
- file is unnecessary.</para>
+ file is unneccessary.</para>
- <para><emphasis>Status:</emphasis> Use with discretion.</para>
+ <para><emphasis>Status:</emphasis> Use with discrection.</para>
</sect3>
default :
log_error( ... );
- ... anomaly code goes here ...
+ ... anomly code goes here ...
continue; / break; / exit( 1 ); / etc ...
} /* end switch( hash_string( cmd ) ) */</programlisting>
This API call *should* be included in a default statement.</para>
<para><emphasis>Another Note:</emphasis> This is not so much a readability issue
- as a robust programming issue. The "anomaly code goes here" may
+ as a robust programming issue. The "anomly code goes here" may
be no more than a print to the STDERR stream (as in
load_config). Or it may really be an ABEND condition.</para>
on 1 line. You should, although, provide a good comment on
their functions.</para>
- <para><emphasis>Status:</emphasis> developer-discretion.</para>
+ <para><emphasis>Status:</emphasis> developer-discrection.</para>
</sect3>
<para><emphasis>Explanation:</emphasis></para>
- <para>Create a local struct (on the stack) if the variable will
+ <para>Create a local stuct (on the stack) if the variable will
live and die within the context of one function call.</para>
<para>Only "malloc" a struct (on the heap) if the variable's life
<para><emphasis>Example:</emphasis></para>
<programlisting>
If a function creates a struct and stores a pointer to it in a
-list, then it should definitely be allocated via `malloc'.
+list, then it should definately be allocated via `malloc'.
</programlisting>
</sect3>
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/destuctor type function to accomodate this.</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
functions for C run-time library functions ... such as
`strdup'.</para>
- <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
+ <para><emphasis>Status:</emphasis> developer-discrection. The "main" use of this
standard is for allocating and freeing data structures (complex
or nested).</para>
<sect3 id="s45"><title>"Uncertain" new code and/or changes to
- existing code, use FIXME</title>
+ exitinst code, use FIXME</title>
<para><emphasis>Explanation:</emphasis></para>
<para>If you have enough confidence in new code or confidence in
- your changes, but are not *quite* sure of the repercussions,
+ your changes, but are not *quite* sure of the reprocussions,
add this:</para>
<para>/* FIXME: this code has a logic error on platform XYZ, *
- attempting to fix */ #ifdef PLATFORM ...changed code here...
+ attempthing to fix */ #ifdef PLATFORM ...changed code here...
#endif</para>
<para>or:</para>
<para><emphasis>Note:</emphasis> If you make it clear that this may or may not
be a "good thing (tm)", it will be easier to identify and
- include in the project (or conversely exclude from the
+ include in the project (or conversly exclude from the
project).</para>
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.30 2002/04/11 09:24:53 oes Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
<para><emphasis>Note:</emphasis> The formfeed character that is present right
after the comment flower box is handy for (X|GNU)Emacs users to
- skip the verbiage and get to the heart of the code (via
+ skip the verbige and get to the heart of the code (via
`forward-page' and `backward-page'). Please include it if you
can.</para>
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.30 2002/04/11 09:24:53 oes Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
</sect1>
+ <!-- ~~~~~ New section ~~~~~ -->
+ <sect1 id="cvs"><title>Version Control Guidelines</title>
+ <para>To be filled. note on cvs comments. Don't only comment what you did,
+ but also why you did it!
+</para>
+ </sect1>
+
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="testing"><title>Testing Guidelines</title>
<para>To be filled.
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
- <sect1 id="newrelease"><title>Releasing a New Version</title>
+ <sect1 id="newrelease"><title>Releasing a new version</title>
<para>
- When we release versions of <application>Privoxy</application>,
- our work leaves our cozy secret lab and has to work in the cold
- RealWorld[tm]. Once it is released, there is no way to call it
- back, so it is very important that great care is taken to ensure
- that everything runs fine, and not to introduce problems in the
- very last minute.
+ To minimize trouble with distribution contents, webpage
+ errors and the like, we strongly encourage you
+ to follow this section if you prepare a new release of
+ code or new pages on the webserver.
</para>
- <para>
- So when releasing a new version, please adhere exactly to the
- procedure outlined in this chapter.
- </para>
-
<para>
The following programs are required to follow this process:
- <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
- <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
+ <filename>ncftpput</filename> (ncftp), <filename>scp</filename> (ssh),
+<filename>gmake</filename> (GNU's version of make), autoconf, cvs, ???.
</para>
-
<para>
- In the following text, replace X, Y and Z with the actual version number
- (X = major, Y = minor, Z = point):
+ Replace X, Y and Z with the actual version number (X = major, Y = minor, Z = point):
</para>
<sect2 id="beforerelease">
</listitem>
<listitem>
<para>
- Increment the version number and increase or reset the RPM release number
- in <filename>configure.in</filename> as appropriate.
+ Increment the version number in <filename>configure.in</filename> in
+ CVS. Also, inrease or reset the RPM release number in
+ <filename>configure.in</filename> as appropriate. Do <emphasis>NOT</emphasis>
+ touch version information after export from CVS.
+ <emphasis>All packages</emphasis> will use the version and release data
+ from <filename>configure.in</filename>.
+ Local files should not be changed, except prior to a CVS commit!!!
+ This way we are all on the same page!
</para>
</listitem>
<listitem>
<para>
- If the default <filename>actionsfile</filename> has changed since last
- release, bump up its version info in this line:
+ If the default actionsfile has changed since last release,
+ bump up its version info in this line:
</para>
<para>
<programlisting>
Then change the version info in doc/webserver/actions/index.php,
line: '$required_actions_file_version = "A.B";'
</para>
- </listitem>
- <listitem>
- <para>
- If the HTML documentation is not in sync with the SGML sources
- you need to regenerate it. (If in doubt, just do it.) See the
- Section "Updating the webserver" in this manual for details.
- </para>
</listitem>
<listitem>
<para>
Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
</para>
</listitem>
+ <listitem>
+ <para>
+ The first package uploaded should be the official
+ <quote>tarball</quote> release. This is built with the
+ <quote><command>make tarball-dist</command></quote> Makefile
+ target, and then can be uploaded with
+ <quote><command>make tarball-upload</command></quote> (see below).
+ </para>
+ </listitem>
</itemizedlist>
</para>
</sect2>
- <sect2 id="therelease">
- <title>Building and Releasing the Packages</title>
- <para>
- Now the individual packages can be built and released. Note that for
- GPL reasons the first package to be released is always the source tarball.
- </para>
-
- <para>
- For <emphasis>all</emphasis> types of packages, including the source tarball,
- <emphasis>you must make sure that you build from clean sources by exporting
- the right version from CVS into an empty directory:</emphasis>.
- </para>
-
- <para>
- <programlisting>
- mkdir dist # delete or choose different name if it already exists
- 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>
- </para>
-
- <para>
- <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
- version information after export from CVS. This is to make sure that
- all release packages, and with them, all future bug reports, are based
- on exactly the same code.
- </para>
-
- <para>
- Please find additional instructions for the source tarball and the
- individual platform dependent binary packages below.
- </para>
-
- <sect3 id="newrelease-tarball"><title>Source Tarball</title>
- <para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
- </para>
- <para>
- <programlisting>
- cd current
- autoheader && autoconf && ./configure
- </programlisting>
- </para>
- <para>
- Then do:
+ <sect2 id="newrelease-web"><title>Update the webserver</title>
+ <para>
+ All files must be group-readable and group-writable (or no one else
+ will be able to change them). To update the webserver, create any
+ pages locally in the <filename>doc/webserver</filename> directory (or
+ create new directories under <filename>doc/webserver</filename>), then do
</para>
<para>
- <programlisting>
- make tarball-dist
+ <programlisting>
+ make webserver
</programlisting>
</para>
<para>
- To upload the package to Sourceforge, simply issue
+ Note that <quote><command>make dok</command></quote>
+ (or <quote><command>make redhat-dok</command></quote>) creates
+ <filename>doc/webserver/user-manual</filename>,
+ <filename>doc/webserver/developer-manual</filename>,
+ <filename>doc/webserver/faq</filename> and
+ <filename>doc/webserver/man-page</filename> automatically.
+ </para>
+ <para>
+ Please do NOT use any other means of transferring files to the
+ webserver. <quote><command>make webserver</command></quote> not only
+ uploads, but will make sure that the appropriate permissions are
+ preserved for shared group access.
+ </para>
+ </sect2>
+
+ <sect2 id="newrelease-rpm"><title>SuSE or Red Hat</title>
+ <para>
+ Ensure that you have the latest code version. Hence run:
</para>
<para>
<programlisting>
- make tarball-upload
+ 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
+ cd current
</programlisting>
</para>
<para>
- Go to the displayed URL and release the file publicly on Sourceforge.
- For the change log field, use the relevant section of the
- <filename>ChangeLog</filename> file.
- </para>
- </sect3>
-
- <sect3 id="newrelease-rpm"><title>SuSE or Red Hat</title>
- <para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
+ first.
</para>
<para>
<programlisting>
- cd current
autoheader && autoconf && ./configure
</programlisting>
</para>
</para>
<para>
<programlisting>
- make suse-dist (or make redhat-dist)
+ make suse-dist or make redhat-dist
</programlisting>
</para>
<para>
</para>
<para>
<programlisting>
- make suse-upload (or make redhat-upload)
+ make suse-upload or make redhat-upload
</programlisting>
</para>
<para>
Go to the displayed URL and release the file publicly on Sourceforge.
- Use the release notes and çhange log from the source tarball package.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-os2"><title>OS/2</title>
+ <sect2 id="newrelease-os2"><title>OS/2</title>
<para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then get the OS/2 Setup module:
+ Ensure that you have the latest code version. Hence run:
</para>
<para>
<programlisting>
+ 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
+ cd ..
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
</programlisting>
</para>
Change directory to the <filename>os2setup</filename> directory.
Edit the os2build.cmd file to set the final executable filename.
For example,
- </para>
- <para>
<programlisting>
installExeName='privoxyos2_setup_X.Y.Z.exe'
</programlisting>
- </para>
- <para>
Next, edit the <filename>IJB.wis</filename> file so the release number matches
in the <filename>PACKAGEID</filename> section:
- </para>
- <para>
- <programlisting>
+ <programlisting>
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
</programlisting>
- </para>
- <para>
You're now ready to build. Run:
- </para>
- <para>
<programlisting>
os2build
</programlisting>
+ And in the <filename>./files</filename> directory you will have the
+ WarpIN-installable executable.
+ Upload this anonymously to
+ <filename>uploads.sourceforge.net/incoming</filename>, create a release
+ for it, and you're done.
</para>
- <para>
- You will find the WarpIN-installable executable in the
- <filename>./files</filename> directory. Upload this anonymously to
- <filename>uploads.sourceforge.net/incoming</filename>, create a release
- for it, and you're done. Use the release notes and Change Log from the
- source tarball package.
- </para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-solaris"><title>Solaris</title>
+ <sect2 id="newrelease-solaris"><title>Solaris</title>
<para>
- Login to Sourceforge's compilefarm via ssh:
+ Login to Sourceforge's compilefarm via ssh
</para>
<para>
<programlisting>
</programlisting>
</para>
<para>
- Choose the right operating system (not the Debian one).
- When logged in, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
+ Choose the right operating system (not the Debian one). If you have
+ downloaded <application>Privoxy</application> before,
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ If not, please <ulink
+ url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
+ Privoxy via CVS first</ulink>. Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
+ the file publicly.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-windows"><title>Windows</title>
- <para>
- You should ensure you have the latest version of Cygwin (from
- <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
- Run the following commands from within a Cygwin bash shell.
- </para>
- <para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then get the Windows setup module:
- </para>
- <para>
- <programlisting>
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
- </programlisting>
- </para>
- <para>
- Then you can build the package. This is fully automated, and is
- controlled by <filename>winsetup/GNUmakefile</filename>.
- All you need to do is:
- </para>
- <para>
- <programlisting>
- cd winsetup
- make
- </programlisting>
- </para>
+ <sect2 id="newrelease-windows"><title>Windows</title>
<para>
- Now you can manually rename <filename>privoxy_setup.exe</filename> to
- <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
- SourceForge. When releasing the package on SourceForge, use the release notes
- and Change Log from the source tarball package.
- </para>
- </sect3>
+ Ensure that you have the latest code version. Hence run
+ </para>
+ <para>
+ <programlisting>
+ 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
+ cd current
+ </programlisting>
+ </para>
+ <para>
+ Run:
+ </para>
+ <para>
+ <programlisting>
+ autoheader && autoconf && ./configure
+ </programlisting>
+ </para>
+ <para>
+ Then do FIXME.
+ </para>
+ </sect2>
- <sect3 id="newrelease-debian"><title>Debian</title>
+ <sect2 id="newrelease-debian"><title>Debian</title>
<para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then, run:
+ Ensure that you have the latest code version. Hence run:
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ first. Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
<para>
Then do FIXME.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-macosx"><title>Mac OSX</title>
+ <sect2 id="newrelease-macosx"><title>Mac OSX</title>
<para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then get the Mac OSX setup module:
+ Ensure that you have the latest code version. Hence run:
</para>
<para>
<programlisting>
+ 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
+ cd ..
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
</programlisting>
</para>
<para>
- Then run:
- </para>
- <para>
+ From the osxsetup directory, run:
<programlisting>
- cd osxsetup
build
</programlisting>
</para>
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:
- </para>
- <para>
<programlisting>
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
</programlisting>
- </para>
- <para>
You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
<filename>uploads.sourceforge.net/incoming</filename>,
- create a release for it, and you're done. Use the release notes
- and Change Log from the source tarball package.
+ create a release for it, and you're done.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
+ <sect2 id="newrelease-freebsd"><title>FreeBSD</title>
+ <para>
+ Change the version number of <application>Privoxy</application> in the
+ configure.in file. Run:
+ <programlisting>
+ autoheader && autoconf && ./configure
+ </programlisting>
+ Then ...
+ </para>
<para>
Login to Sourceforge's compilefarm via ssh:
</para>
</para>
<para>
Choose the right operating system.
- When logged in, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
+ the file publicly.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
+ <sect2 id="newrelease-tarball"><title>Tarball</title>
<para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
+ Ensure that you have the right code version. Hence run:
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ first. Run:
+ </para>
+ <para>
+ <programlisting>
+ autoheader && autoconf && ./configure
+ </programlisting>
+ </para>
+ <para>
+ Then do:
+ </para>
+ <para>
+ <programlisting>
+ make tarball-dist
+ </programlisting>
+ </para>
+ <para>
+ To upload the package to Sourceforge, simply issue
+ </para>
+ <para>
+ <programlisting>
+ make tarball-upload
+ </programlisting>
+ </para>
+ <para>
+ Goto the displayed URL and release the file publicly on Sourceforge.
+ </para>
+ </sect2>
+
+ <sect2 id="newrelease-hpux"><title>HP-UX 11</title>
+ <para>
+ Ensure that you have the latest code version. Hence run:
+ </para>
+ <para>
+ <programlisting>
+ 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
+ cd current
+ </programlisting>
+ </para>
+ <para>
+ first. Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
<para>
Then do FIXME.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-amiga"><title>Amiga OS</title>
+ <sect2 id="newrelease-amiga"><title>Amiga OS</title>
<para>
- First, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
+ Ensure that you have the latest code version. Hence run:
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ first. Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
<para>
Then do FIXME.
</para>
- </sect3>
+ </sect2>
- <sect3 id="newrelease-aix"><title>AIX</title>
+ <sect2 id="newrelease-aix"><title>AIX</title>
<para>
Login to Sourceforge's compilefarm via ssh:
</para>
</programlisting>
</para>
<para>
- Choose the right operating system.
- When logged in, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
+ Choose the right operating system. If you have downloaded Privoxy
+ before:
</para>
<para>
<programlisting>
+ 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
cd current
+ </programlisting>
+ </para>
+ <para>
+ If not, please <ulink
+ url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
+ Privoxy via CVS first</ulink>. Run:
+ </para>
+ <para>
+ <programlisting>
autoheader && autoconf && ./configure
</programlisting>
</para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
+ the file publicly.
</para>
- </sect3>
- </sect2>
-
- <sect2 id="afterrelease">
- <title>After the Release</title>
- <para>
- When all (or: most of the) packages have been uploaded and made available,
- send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
- mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
- include the
- <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
- location</ulink>, the release notes and the change log.
- </para>
- </sect2>
+ </sect2>
</sect1>
- <!-- ~~~~~ New section ~~~~~ -->
- <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
- problems will occur:
- </para>
- <para>
- If you have changed anything in the documentation source SGML files,
- do:
- </para>
- <para>
- <programlisting>
- make dok # (or make redkat-dok if make dok doesn't work for you)
- </programlisting>
- </para>
- <para>
- That will generate <filename>doc/webserver/user-manual</filename>,
- <filename>doc/webserver/developer-manual</filename>,
- <filename>doc/webserver/faq</filename> and
- <filename>doc/webserver/index.html</filename> automatically.
- </para>
- <para>
- If you changed the manual page source, generate
- <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
- by running <quote><command>make man</command></quote>. (This is
- a separate target due to dependencies on some obscure perl scripts.
- See comments in <filename>GNUmakefile</filename>.)
- </para>
- <para>
- If you want to add new files to the webserver, create them locally in
- the <filename>doc/webserver/*</filename> directory (or
- create new directories under <filename>doc/webserver</filename>).
- </para>
- <para>
- Next, commit any changes from the above steps to CVS. All set? Then do
- </para>
- <para>
- <programlisting>
- make webserver
- </programlisting>
- </para>
- <para>
- This will do the upload to <ulink url="http://www.privoxy.org/">the
- webserver</ulink> (www.privoxy.org) and ensure all files and directories
- there are group writable.
- </para>
- <para>
- Please do <emphasis>NOT</emphasis> use any other means of transferring
- files to the webserver to avoid permission problems.
- </para>
- </sect1>
-
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
<!-- Include contacting.sgml -->
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
- Revision 1.33 2002/04/12 03:49:53 hal9
- Spell checked. Clarification on where docs are kept.
-
- Revision 1.32 2002/04/11 21:29:58 jongfoster
- Documenting Win32 release procedure
-
- Revision 1.31 2002/04/11 09:32:52 oes
- more nits
-
Revision 1.30 2002/04/11 09:24:53 oes
nits
<!entity contacting SYSTEM "contacting.sgml">
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
-<!entity p-version "2.9.14">
+<!entity p-version "2.9.13">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: faq.sgml,v 1.48 2002/04/10 18:45:15 swa Exp $
+ $Id: faq.sgml,v 1.47 2002/04/10 04:05:32 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<artheader>
<title>Privoxy Frequently Asked Questions</title>
-<pubdate>$Id: faq.sgml,v 1.48 2002/04/10 18:45:15 swa Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.47 2002/04/10 04:05:32 hal9 Exp $</pubdate>
<authorgroup>
<author>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: faq.sgml,v $
-Revision 1.48 2002/04/10 18:45:15 swa
-generated
-
Revision 1.47 2002/04/10 04:05:32 hal9
More on BML, etc.
Purpose : Entity included in other project documents.
- $Id: newfeatures.sgml,v 1.3 2002/04/06 05:07:29 hal9 Exp $
+ $Id: newfeatures.sgml,v 1.2 2002/04/02 00:55:46 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<para>
Integrated browser based configuration and control utility (<ulink
url="http://p.p">http://p.p</ulink>). Browser-based tracing of rule
- and filter effects. Remote toggling.
+ and filter effects.
</para>
</listitem>
<!--
<listitem>
<para>
- HTTP/1.1 compliant (but not all optional 1.1 features are supported).
+ HTTP/1.1 compliant (most, but not all 1.1 features are supported).
</para>
</listitem>
<listitem>
<para>
Web page content filtering (removes banners based on size,
- invisible <quote>web-bugs</quote>, JavaScript and HTML annoyances, pop-ups, etc.)
+ invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
+ etc.)
</para>
</listitem>
<listitem>
<para>
Bypass many click-tracking scripts (avoids script redirection).
+
</para>
</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 and AmigaOS.
+
</para>
</listitem>
<listitem>
<para>
- Every feature now controllable on a per-site or per-location basis, configuration
- more powerful and versatile over-all.
- </para>
-</listitem>
-
- <listitem>
- <para>
- Many smaller new features added, limitations and bugs removed, and security holes fixed.
+ In addition, the configuration is much more powerful and versatile over-all.
</para>
</listitem>
</itemizedlist>
</para>
+
+
Purpose : Entity included in other project documents.
- $Id: p-authors.sgml,v 1.4 2002/04/15 19:08:39 jongfoster Exp $
+ $Id: p-authors.sgml,v 1.2 2002/04/06 13:49:43 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
Junkbusters Corporation. http://www.junkbusters.com
-
======================================================================
This file used for inclusion with other documents only.
======================================================================
]]>
<literallayout>
- Jon Foster
- Andreas Oesterhelt
Stefan Waldherr
+ Andreas Oesterhelt
+ Jon Foster
<![%p-authors-formal;[
]]>
+ Markus Breitenbach
Thomas Steudten
- Rodney Stromlund
<![%p-authors-formal;[
</literallayout>
<literallayout>
]]>
- Rodrigo Barbosa (RPM specfiles)
+ David Schmidt (OS/2, Mac OSX ports)
+ Gabriel L. Somlo
Hal Burgiss (docs)
- Alexander Lazic
- Gábor Lipták
- Guy
Haroon Rafique
- David Schmidt (OS/2, Mac OSX ports)
+ John Venvertloh
Joerg Strohmayer
+ Rodney Stromlund
+ Rodrigo Barbosa (RPM specfiles)
Sarantis Paskalis
+ Shamim Mohamed
+ Gábor Lipták
+ Alexander Lazic
</literallayout>
<![%p-authors-formal;[
</para>
<literallayout>
- Ken Arromdee
- Reiner Buehl
+ Aaron Hamid
Andrew J. Caines
+ Bart Schelstraete
Clifford Caoile
- Peter E
- Aaron Hamid
+ Darren Wiebe
+ Guy
+ Ken Arromdee
Magnus Holmgren
Paul Lieverse
- Roberto Ragusa
- Bart Schelstraete
- Darren Wiebe
+ Peter E
+ Reiner Buehl
</literallayout>
]]>
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 1.6 2002/04/12 01:55:43 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 1.4 2002/04/10 18:45:15 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
- anything in this, or other Privoxy documentation.
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license
+ to live a peaceful existence!
========================================================================
- Doc NOTES: This is some tricky markup! There are some quirks
+ Doc NOTES: This is some tricky stuff! There are some quirks
to how this markup is handled. It is not always so co-operative.
- Please don't change the markup unless you can verify the changes
- will improve finished output!
+ Please don't change the markup, unless you are willing to
+ un-do your changes!
literallayout tags are particularly sensitive to where they are placed.
The 'replaceable' and 'command' tags are used here somewhat unconventionally,
since it seems to generate the proper formatting (at least for me :).
- Create man page: 'make man'
+ Create man page: 'docbook2man privoxy-man-page.sgml'
- Requires docbook2man (short perl script), see CVS
- http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
- perl module.
-
For man page references, see:
http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
http://docbook.org/tdg/en/html/ch02.html#making-refentry
<!entity seealso SYSTEM "seealso.sgml">
<!entity copyright SYSTEM "copyright.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.14">
+<!entity p-version "2.9.13">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
- is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
+ is non-fatal. If no <term>--pidfile</term> option is given, no PID file will be used.
</para>
</listitem>
</varlistentry>
Purpose : Entity included in other project documents.
- $Id: privoxy.sgml,v 1.5 2002/04/08 20:40:26 swa Exp $
+ $Id: privoxy.sgml,v 1.4 2002/04/07 08:10:12 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
</para>
<para>
- <application>Privoxy</application> is based on <application>Internet
- Junkbuster</application> (tm).
+ <application>Privoxy</application> is based on the code of the
+ <application>Internet Junkbuster</application> (tm).
+ <application>Junkbuster</application> was originally written by Junkbusters
+ Corporation, and was released as free open-source software under the GNU GPL.
+ Stefan Waldherr made many improvements, and started the SourceForge project
+ to continue development.
</para>
+
+<para>
+ <application>Privoxy</application> continues the
+ <application>Junkbuster</application> tradition, but adds many
+ refinements, enhancements and new features.
+</para>
+
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version "2.9.14">
+<!entity p-version "2.9.13">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
Purpose : README for Privoxy
- $Id: readme.sgml,v 1.7 2002/04/10 18:45:15 swa Exp $
+ $Id: readme.sgml,v 1.6 2002/04/08 22:59:26 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
</LiteralLayout>
</para>
<para>
- $Id: readme.sgml,v 1.7 2002/04/10 18:45:15 swa Exp $
+ $Id: readme.sgml,v 1.6 2002/04/08 22:59:26 hal9 Exp $
</para>
</article>
Purpose : Entity included in other project documents.
- $Id: supported.sgml,v 1.5 2002/04/06 05:07:29 hal9 Exp $
+ $Id: supported.sgml,v 1.4 2002/04/04 14:59:13 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
-->
<para>
At present, <application>Privoxy</application> is known to run on Win32, Mac
- OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, BeOS, and many flavors
- of Unix.
+ OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, and many flavors
+ of Unix. There are source and binary releases for these available for
+ download at <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=11118">http://sourceforge.net/project/showfiles.php?group_id=11118</ulink>.
</para>
<![%p-supp-userman;[
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.76 2002/04/16 04:25:51 hal9 Exp $
+ $Id: user-manual.sgml,v 1.73 2002/04/10 18:45:15 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
- anything in this, or other Privoxy documentation.
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license
+ to live a peaceful existence!
========================================================================
-->
<artheader>
<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.76 2002/04/16 04:25:51 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.73 2002/04/10 18:45:15 swa Exp $</pubdate>
<authorgroup>
<author>
<para>
The user manual gives users information on how to install, configure and use
- <ulink
- url="http://www.privoxy.org/"><application>Privoxy</application></ulink>.
+ <application>Privoxy</application>.
</para>
-<!-- Include privoxy.sgml boilerplate: -->
+<!--
+ Include privoxy.sgml boilerplate:
+-->
&p-intro;
-<!-- end privoxy.sgml -->
<para>
You can find the latest version of the user manual at <ulink
]]>
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="newfeatures">
+<sect2>
<title>New Features</title>
<para>
In addition to <application>Internet Junkbuster's</application> traditional
feature of ad and banner blocking and cookie management,
<application>Privoxy</application> provides new features<![%p-not-stable;[,
some of them currently under development]]>:
-<anchor id="testing"/>
</para>
<!-- Include newfeatures.sgml boilerplate here: -->
&newfeatures;
<!-- end boilerplate -->
+
</sect2>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="installation"><title>Installation</title>
<para>
- <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>.
-</para>
-<para>
- If you like to live on the bleeding edge and are not afraid of using
- possibly unstable development versions, you can check out the up-to-the-minute
- 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>
+ <application>Privoxy</application> is available as raw source code (tarball
+ or via CVS), or pre-compiled binaries for various platforms. See the <ulink
+ url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
+ the most up to date release information.
+ <application>Privoxy</application> is also available via <ulink
+ url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
+ <![%p-not-stable;[This is the recommended approach at this time.]]> But
+ please be aware that CVS is constantly changing, and it may break in
+ mysterious ways.
</para>
<!-- Include supported.sgml boilerplate -->
-&supported;
+ &supported;
<!-- end boilerplate -->
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-packages"><title>Binary Packages</title>
-<para>
- The packages can be downloaded from our <ulink
- url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink>.
-</para>
+<sect2 id="installation-source"><title>Source</title>
+
+
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilerplate -->
<para>
- How to install them depends on your operating system:
+ For Redhat and SuSE Linux RPM packages, see below.
</para>
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-pack-rpm"><title>Redhat and SuSE RPMs</title>
+<sect3 id="installation-rh"><title>Red Hat</title>
+<para>
+ To build Redhat RPM packages from source, install source as above. Then:
+</para>
<para>
- RPMs can be installed with <literal>rpm -i <name-of-rpm.rpm></literal>,
- and will use <filename>/etc/privoxy</filename> for configuration files.
+ <screen>
+ autoheader
+ autoconf
+ ./configure
+ make redhat-dist
+ </screen>
</para>
<para>
- Note that if you have a Junkbuster RPM installed on your system, you
- need to remove it first, because the packages conflict.
+ This will create both binary and src RPMs in the usual places. Example:
</para>
-</sect3>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, HP-UX</title>
+<para>
+ /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
+</para>
+<para>
+ /usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
+</para>
<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.
+ To install, of course:
</para>
-</sect3>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-pack-win"><title>Windows</title>
+<para>
+ <screen>
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
+ </screen>
+</para>
<para>
- Just double-click the installer, which will guide you through
- the installation process.
+ This will place the <application>Privoxy</application> configuration
+ files in <filename>/etc/privoxy/</filename>, and log files in
+ <filename>/var/log/privoxy/</filename>. Run
+ <quote><command>chkconfig privoxy on</command></quote> to have
+ <application>Privoxy</application> start automatically during init.
+
</para>
+
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-os2"><title>OS/2</title>
-
+<sect3 id="installation-suse"><title>SuSE</title>
<para>
- Just double-click the WarpIN self-installing archive, which will guide
- you through the installation process. A shadow of the
- <application>Privoxy</application> executable will be placed in your
- startup folder so it will start automatically whenever OS/2 starts.
+ To build SuSE RPM packages, install source as above. Then:
</para>
<para>
- The directory you choose to install <application>Privoxy</application>
- into will contain all of the configuration files.
+ <screen>
+ autoheader
+ autoconf
+ ./configure
+ make suse-dist
+ </screen>
</para>
-</sect3>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-deb"><title>Debian</title>
<para>
- FIXME.
+ This will create both binary and src RPMs in the usual places. Example:
</para>
-</sect3>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-amiga"><title>AmigaOS</title>
<para>
- Unpack the <literal>.lha</literal> archive, then FIXME.
+ /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
+</para>
+<para>
+ /usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
</para>
-</sect3>
-</sect2>
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-source"><title>Building from Source</title>
-<!-- include buildsource.sgml boilerplate: -->
-&buildsource;
-<!-- end boilerplate -->
+<para>
+ To install, of course:
+</para>
<para>
- For more detailed instructions, on how to build Redhat and SuSE RPMs,
- Windows self-extracting installers etc, please consult the <ulink
- url="../developer-manual/newrelease.html">developer manual</ulink>.
+ <screen>
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
+ </screen>
</para>
-</sect2>
-</sect1>
+<para>
+ This will place the <application>Privoxy</application> configuration
+ files in <filename>/etc/privoxy/</filename>, and log files in
+ <filename>/var/log/privoxy/</filename>.
+</para>
-<!-- ~ End section ~ -->
+</sect3>
<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-os2"><title>OS/2</title>
-<sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
-
+<!--
+Thanx David Schmidt!
+-->
-<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="upgradersnote">
-<title>Note to Upgraders</title>
<para>
- There are very significant changes from older versions of
- <application>Junkbuster</application> to the current
- <application>Privoxy</application>. Configuration is substantially
- changed. <application>Junkbuster 2.0.x</application> and earlier
- configuration files will not migrate. The functionality of the old
- <filename>blockfile</filename>, <filename>cookiefile</filename> and
- <filename>imagelist</filename>, are now combined into the
- <quote>actions file</quote> (<filename>default.action</filename>
- for most installations).
+ <application>Privoxy</application> is packaged in a WarpIN self-
+ installing archive. The self-installing program will be named depending
+ on the release version, something like:
+ <filename>privoxyos2_setup_&p-version;.exe</filename>. In order to install it, simply
+ run this executable or double-click on its icon and follow the WarpIN
+ installation panels. A shadow of the <application>Privoxy</application>
+ executable will be placed in your startup folder so it will start
+ automatically whenever OS/2 starts.
</para>
+
<para>
- A <quote>filter file</quote> (typically <filename>default.filter</filename>)
- is new with <application>Privoxy 2.9.x</application>, and provides some
- of the new sophisticaton (explained below). <filename>config</filename> is
- much the same as before.
+ The directory you choose to install <application>Privoxy</application>
+ into will contain all of the configuration files.
</para>
+
<para>
- If upgrading from a 2.0.x version, you will have to use the new config
- files, and possibly adapt any personal rules from your older files.
- When porting personal rules over from the old <filename>blockfile</filename>
- to the new actions file, please note that even the pattern syntax has
- changed.
- If upgrading from 2.9.x development versions, it is still recommended
- to use the new configuration files.
+ If you would like to build binary images on OS/2 yourself, you will need
+ a few Unix-like tools: autoconf, autoheader and sh. These tools will be
+ used to create the required config.h file, which is not part of the
+ source distribution because it differs based on platform. You will also
+ need a compiler.
+ The distribution has been created using IBM VisualAge compilers, but you
+ can use any compiler you like. GCC/EMX has the disadvantage of needing
+ to be single-threaded due to a limitation of EMX's implementation of the
+ <function>select()</function> socket call.
</para>
+
<para>
- A quick list of things to be aware of before upgrading:
+ In addition to needing the source code distribution as outlined earlier,
+ you will want to extract the <filename>os2seutp</filename> directory from CVS:
+ <screen>
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
+ </screen>
+ This will create a directory named os2setup/, which will contain the
+ <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
+ which is used to completely create the binary distribution. The sequence
+ of events for building the executable for yourself goes something like this:
+ <screen>
+ cd current
+ autoheader
+ autoconf
+ sh configure
+ cd ..\os2setup
+ nmake -f Makefile.vac
+ </screen>
+ You will see this sequence laid out in <filename>os2build.cmd</filename>.
</para>
-<para>
- <itemizedlist>
+</sect3>
- <listitem>
- <para>
- The default listening port is now 8118 due to a conflict with another
- service (NAS).
- </para>
- </listitem>
- <listitem>
- <para>
- Some installers may remove earlier versions completely. Save any
- important configuration files!
- </para>
- </listitem>
- <listitem>
- <para>
- <application>Privoxy</application> is controllable with a web browser
- at the special URL: <ulink
- url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (Shortcut: <ulink url="http://p.p/">http://p.p/</ulink>). Many
- aspects of configuration can be done here, including temporarily disabling
- <application>Privoxy</application>.
- </para>
- </listitem>
- <listitem>
- <para>
- The primary configuration file for cookie management, ad and banner
- blocking, and many other aspects of <application>Privoxy</application>
- configuration is <filename>default.action</filename>. It is strongly
- recommended to make oneself familiar with the new actions concept below
- before modifying that file.
- </para>
- </listitem>
- <listitem>
- <para>
-<!-- I think it is best to keep this somewhat vague, in case -->
-<!-- the situation changes under our feet. -->
- Some installers may not automatically start
- <application>Privoxy</application> after installation.
- </para>
- </listitem>
- </itemizedlist>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-win"><title>Windows</title>
+<para>Click-click. (I need help on this. Not a clue here. Also for
+configuration section below. HB.)
+</para>
+</sect3>
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-other"><title>Other</title>
+<para>
+ Some quick notes on other Operating Systems.
+</para>
+
+<para>
+ For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
+ instead of the included <command>make</command>. <command>gmake</command> is
+ available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
+ The rest should be the same as above for Linux/Unix.
</para>
+</sect3>
</sect2>
+</sect1>
+
+<!-- ~ End section ~ -->
+
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="startup">
-<
title>Starting <application>Privoxy</application></title>
+
+<
sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
<para>
Before launching <application>Privoxy</application> for the first time, you
will want to configure your browser(s) to use <application>Privoxy</application>
as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
- and port 8118 (earlier versions used port 8000). This is the one required
+ and port 8118 (earlier versions used port 800). This is the one required
configuration that must be done!
</para>
</para>
<para>
- For for SuSE: <command>rcprivoxy start</command>
+ For for SuSE: <command>/etc/rc.d/privoxy start</command>
</para>
<para>
<para>
The included default configuration files should give a reasonable starting
- point. Most of the per site configuration is done in the
- <quote>actions</quote> files. These are where various cookie actions are
- defined, ad and banner blocking, and other aspects of
- <application>Privoxy</application> configuration. There are several such
- files included, with varying levels of aggressiveness.
+ point, though may be somewhat aggressive in blocking junk. Most of the
+ per site configuration is done in the <quote>actions</quote> files. These
+ are where various cookie actions are defined, ad and banner blocking,
+ and other aspects of <application>Privoxy</application> configuration. There
+ are several such files included, with varying levels of aggressiveness.
</para>
<para>
You will probably want to keep an eye out for sites that require persistent
cookies, and add these to <filename>default.action</filename> as needed. By
default, most of these will be accepted only during the current browser
- session (aka <quote>session cookies</quote>), until you add them to the
- configuration. If you want the browser to handle this instead, you will need
- to edit <filename>default.action</filename> and disable this feature. If you
- use more than one browser, it would make more sense to let
- <application>Privoxy</application> handle this. In which case, the
- browser(s) should be set to accept all cookies.
-</para>
-
-<para>
- Another feature where you will propably want to define exceptions for trusted
- sites is the popup-killing (through the <literal>+popup</literal> and
- <literal>+filter{popups}</literal> actions), because your favourite shopping,
- banking, or leisure site may need popups.
+ session, until you add them to the configuration. If you want the browser to
+ handle this instead, you will need to edit
+ <filename>default.action</filename> and disable this feature. If you use more
+ than one browser, it would make more sense to let
+ <application>Privoxy</application> handle this. In which case, the browser(s)
+ should be set to accept all cookies.
</para>
<para>
- <application>Privoxy</application> is HTTP/1.1 compliant, but not all of
- the optional 1.1 features are as yet supported. In the unlikely event that
- you experience inexplicable problems with browsers that use HTTP/1.1 per default
- (like <application>Mozilla</application> or recent versions of I.E.), you might
- try to force HTTP/1.0 compatibility. For Mozilla, look under <literal>Edit ->
- Preferences -> Debug -> Networking</literal>.
- Alternatively, set the <quote>+downgrade</quote> config option in
- <filename>default.action</filename> which will downgrade you brower's HTTP
- requests from HTTP/1.1 to HTTP/1.0 before processing them.
+ <application>Privoxy</application> is HTTP/1.1 compliant, but not all 1.1
+ features are as yet implemented. If browsers that support HTTP/1.1 (like
+ <application>Mozilla</application> or recent versions of I.E.) experience
+ problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
+ under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
+ Or set the <quote>+downgrade</quote> config option in
+ <filename>default.action</filename>.
</para>
<para>
preferences and requirements. There are many, many aspects that can
be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
can be adjusted by pointing your browser to
- <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
+ <ulink url="http://p.p/">http://p.p/</ulink>,
and then follow the link to <quote>edit the actions list</quote>.
(This is an internal page and does not require Internet access.)
</para>
the browser's request headers, and <quote>actions</quote> that apply
to a given URL. In addition to the <filename>default.action</filename> file
editor mentioned above, <application>Privoxy</application> can also
- be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
-</para>
-
-<para>
- If you encounter problems, try loading the page without
- <application>Privoxy</application>. If that helps, enter the URL where
- you have the problems into <ulink url="http://p.p/show-url-info">the browser
- based rule tracing utility</ulink>. Watch out which rules apply and why, and
- then try turning them off for that site one after the other, until the problem
- is gone. When you have found the culprit, you might want to turn the rest on
- again.
+ be turned <quote>on</quote> and <quote>off</quote> from this page.
</para>
<para>
- If the above paragraph sounds gibberish to you, you might want to <ulink
- url="configuration.html#ACTIONSFILE">read more about the actions concept</ulink>
- or even dive deep into the <ulink url="appendix.html#ACTIONSANAT">Appendix
- on actions</ulink>.
+ If you encounter problems, please verify it is a
+ <application>Privoxy</application> bug, by disabling
+ <application>Privoxy</application>, 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
+ <literal>{fragile}</literal> section of <filename>default.action</filename>.
+ This will turn off most actions for this site. For more on troubleshooting
+ problem sites, see the <ulink
+ url="appendix.html#ACTIONSANAT">Appendix</ulink>. If a bug, please report it
+ to the developers (see below).
</para>
-<para>
- If you can't get rid of the problem at all, think you've found a bug in
- Privoxy, want to propose a new feature or smarter rules, please see the
- chapter "Contacting the Developers, .." below.
-</para>
-
-</sect2>
-
<!-- ~~~~~ New section ~~~~~ -->
+
<sect2>
<title>Command Line Options</title>
<para>
<sect2>
<title>Controlling <application>Privoxy</application> with Your Web Browser</title>
<para>
- <application>Privoxy</application>'s user interface can be reached through the special
- URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
- which is a built-in page and works without internet access.
- You will see the following section:
+ <application>Privoxy</application> can be reached by the special
+ URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
+ <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>),
+ which is an internal page. You will see the following section:
</para>
Please choose from the following options:
- * Privoxy main page
* Show information about the current configuration
* Show the source code version numbers
- * Show the request headers.
+ * Show the client's request headers.
* Show which actions apply to a URL and why
* Toggle Privoxy on or off
* Edit the actions list
<application>Privoxy</application>. This is an easy way to adjust various
aspects of <application>Privoxy</application> configuration. The actions
file, and other configuration files, are explained in detail below.
+ <application>Privoxy</application> will automatically detect any changes
+ to these files.
</para>
<para>
<quote>Toggle Privoxy On or Off</quote> is handy for sites that might
- have problems with your current actions and filters. You can in fact use
-
it as a test to see whether it is <application>Privoxy</application>
+ have problems with your current actions and filters, or just to test if
+
a site misbehaves, whether it is <application>Privoxy</application>
causing the problem or not. <application>Privoxy</application> continues
- to run as a proxy in this case, but all filtering is disabled. There
- is even a toggle Bookmarklet offered, so that you can toggle
- <application>Privoxy</application> with one click from your browser.
+ to run as a proxy in this case, but all filtering is disabled.
</para>
<listitem>
<para>
- <filename>default.action</filename> (the actions file) is used to define
- which of a set of various <quote>actions</quote> relating to images, banners,
- pop-ups, access restrictions, banners and cookies are to be applied where.
- There is a web based editor for this file that can be accessed at <ulink
- url="http://config.privoxy.org/edit-actions/">http://config.privoxy.org/edit-actions/</ulink>
- (Shortcut: <ulink url="http://p.p/edit-actions/">http://p.p/edit-actions/</ulink>).
- (Other actions files are included as well with differing levels of filtering
+ The <filename>default.action</filename> file is used to define various
+ <quote>actions</quote> 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 <ulink
+ url="http://p.p">http://p.p</ulink>. (Other actions
+ files are included as well with differing levels of filtering
and blocking, e.g. <filename>basic.action</filename>.)
</para>
</listitem>
<listitem>
<para>
- <filename>default.filter</filename> (the filter file) can be used to re-write the raw
+ The <filename>default.filter</filename> file can be used to re-write the raw
page content, including viewable text as well as embedded HTML and JavaScript,
- and whatever else lurks on any given web page. The filtering jobs are only
- pre-defined here; whether to apply them or not is up to the actions file.
+ and whatever else lurks on any given web page.
</para>
</listitem>
</itemizedlist>
</para>
-<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
- 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
- valid configuration line to prevent it from being interpreted is called "commenting
- out" that line.
-</para>
-
<para>
<filename>default.action</filename> and <filename>default.filter</filename>
- can use Perl style regular expressions for maximum flexibility.
-</para>
-
-<para>
- After making any changes, there is no need to restart
+ can use Perl style regular expressions for maximum flexibility. All files use
+ the <quote><literal>#</literal></quote> character to denote a comment. Such
+ lines are not processed by <application>Privoxy</application>. After
+ making any changes, there is no need to restart
<application>Privoxy</application> in order for the changes to take
- effect. <application>Privoxy</application> detects such changes
- automatically. Note, however, that it may take one or two additional
- requests for the change to take effect. When changing the listening address
- of <application>Privoxy</application>, these <quote>wake up</quote> requests
- must obviously be sent to the <emphasis>old</emphasis> listening address.
+ effect. <application>Privoxy</application> should detect such changes
+ automatically.
</para>
<![%p-not-stable;[
<literal>
<msgtext>
<literallayout>
- <emphasis>confdir /etc/privoxy</emphasis>
+ <emphasis>blockfile blocklist.ini</emphasis>
</literallayout>
- </msgtext>
- </literal>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Indicates that the blockfile is named <quote>blocklist.ini</quote>. (A
+ default installation does not use this.)
+</para>
+
+<para>
+ A <quote><literal>#</literal></quote> indicates a comment. Any part of a
+ line following a <quote><literal>#</literal></quote> is ignored, except if
+ the <quote><literal>#</literal></quote> is preceded by a
+ <quote><literal>\</literal></quote>.
</para>
<para>
- Assigns the value <literal>/etc/privoxy</literal> to the option
- <literal>confdir</literal> and thus indicates that the configuration
- directory is named <quote>/etc/privoxy/</quote>.
+ Thus, by placing a <quote><literal>#</literal></quote> at the start of an
+ existing configuration line, you can make it a comment and it will be treated
+ as if it weren't there. This is called <quote>commenting out</quote> an
+ option and can be useful to turn off features: If you comment out the
+ <quote>logfile</quote> line, <application>Privoxy</application> will not
+ log to a file at all. Watch for the <quote>default:</quote> section in each
+ explanation to see what happens if the option is left unset (or commented
+ out).
</para>
<para>
- All options in the config file except for <literal>confdir</literal> and
- <literal>logdir</literal> are optional. Watch out in the below description
- for what happens if you leave them unset.
+ Long lines can be continued on the next line by using a
+ <quote><literal>\</literal></quote> as the very last character.
</para>
<para>
- The main config file controls all aspects of <application>Privoxy</application>'s
- operation that are not location dependent (i.e. that apply invariantly no matter
- where in the web you are surfing).
+ There are various aspects of <application>Privoxy</application> behavior
+ that can be tuned.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<sect3>
-<title>Configuration and Log File Locations</title>
+<title>Defining Other Configuration Files</title>
<para>
- <application>Privoxy</application> can (and normally does) use a number of
- other files for addidtional configuration and logging.
-
This section of the configuration file tells <application>Privoxy</application>
- where to find those other files.
+ <application>Privoxy</application> can use a number of other files to tell it
+ what ads to block, what cookies to accept, and perform other functions. This
+ section of the configuration file tells <application>Privoxy</application>
+ where to find all those other files.
</para>
+<para>
+ On <application>Windows</application> and <application>AmigaOS</application>,
+ <application>Privoxy</application> looks for these files in the same
+ directory as the executable. On Unix and OS/2,
+ <application>Privoxy</application> looks for these files in the current
+ working directory. In either case, an absolute path name can be used to
+ avoid problems.
+</para>
-<sect4><title>confdir</title>
+<para>
+ When development goes modular and multi-user, the blocker, filter, and
+ per-user config will be stored in subdirectories of <quote>confdir</quote>.
+ For now, only <filename>confdir/templates</filename> is used for storing HTML
+ templates for CGI results.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>The directory where the other configuration files are located</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>Path name</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para><emphasis>Mandatory</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- No trailing <quote><literal>/</literal></quote>, please
- </para>
- <para>
- When development goes modular and multi-user, the blocker, filter, and
- per-user config will be stored in subdirectories of <quote>confdir</quote>.
- For now, the configuration dir structure is flat, except for
- <filename>confdir/templates</filename>, where the HTML templates for CGI
- output reside.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The location of the configuration files:
+</para>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>confdir /etc/privoxy</emphasis> # No trailing /, please.
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>logdir</title>
+<para>
+ The directory where all logging (i.e. <filename>logfile</filename> and
+ <filename>jarfile</filename>) takes place. No trailing
+ <quote><literal>/</literal></quote>, please:
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The directory where all logging takes place (i.e. where <filename>logfile</filename> and
- <filename>jarfile</filename> are located)
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>Path name</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para><emphasis>Mandatory</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- No trailing <quote><literal>/</literal></quote>, please
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>logdir /var/log/privoxy</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>actionsfile</title>
+<para>
+ Note that all file specifications below are relative to
+ the above two directories!
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The actions file to use
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>confdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>default.action (Unix) <emphasis>or</emphasis> default.action.txt (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No action is taken at all. Simple neutral proxying.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- There is no point in using <application>Privoxy</application> without
- an actions file.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The <quote>default.action</quote> file contains patterns to specify the
+ actions to apply to requests for each site. Default: Cookies to and from all
+ destinations are kept only during the current browser session (i.e. they are
+ not saved to disk). Pop-ups are disabled for all sites. All sites are
+ filtered through selected sections of <quote>default.filter</quote>. No sites
+ are blocked. <application>Privoxy</application> displays a checkboard type
+ pattern for filtered ads and other images. The syntax of this file is
+ explained in detail <link linkend="actionsfile">below</link>. Other
+ <quote>actions</quote> files are included, and you are free to use any of
+ them. They have varying degrees of aggressiveness.
+</para>
-<sect4><title>actionsfile</title>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>actionsfile default.action</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The actions file to use
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>confdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>default.action (Unix) <emphasis>or</emphasis> default.action.txt (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No action is taken at all. Simple neutral proxying.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- There is no point in using <application>Privoxy</application> without
- an actions file. There are three diffrent actions files included in the
- distribution, with varying degrees of aggressiveness:
- <filename>default.action</filename>, <filename>intermediate.action</filename> and
- <filename>advanced.action</filename>.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The <quote>default.filter</quote> file contains content modification rules
+ that use <quote>regular expressions</quote>. These rules permit powerful
+ changes on the content of Web pages, e.g., you could disable your favorite
+ JavaScript annoyances, re-write the actual displayed text, or just have some
+ fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
+ it appears on a Web page. Default: whatever the developers are playing with
+ :-/
+</para>
-<sect4><title>filterfile</title>
+<para>
+ Filtering requires buffering the page content, which may appear to slow down
+ page rendering since nothing is displayed until all content has passed
+ the filters. (It does not really take longer, but seems that way since
+ the page is not incrementally displayed.) This effect will be more noticeable
+ on slower connections.
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The filter file to use
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>confdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No textual content filtering takes place, i.e. all
- <literal>+filter{<replaceable class="parameter">name</replaceable>}</literal>
- actions in the actions file are turned off
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The <quote>default.filter</quote> file contains content modification rules
- that use <quote>regular expressions</quote>. These rules permit powerful
- changes on the content of Web pages, e.g., you could disable your favorite
- JavaScript annoyances, re-write the actual displayed text, or just have some
- fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
- it appears on a Web page.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+</para>
-<sect4><title>logfile</title>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>filterfile default.filter</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The log file to use
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>logdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No log file is used, all log messages go to the console (<literal>stderr</literal>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The windows version will additionally log to the console
- </para>
- <para>
- The logfile is where all logging and error messages are written. The level
- of detail and number of messages are set with the <literal>debug</literal>
- option (see below). The logfile can be useful for tracking down a problem with
- <application>Privoxy</application> (e.g., it's not blocking an ad you
- think it should block) but in most cases you probably will never look at it.
- </para>
- <para>
- Your logfile will grow indefinitely, and you will probably want to
- periodically remove it. On Unix systems, you can do this with a cron job
- (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
- script has been included.
- </para>
- <para>
- On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
- +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
- the effect that cron.daily will automatically archive, gzip, and empty the
- log, when it exceeds 1M size.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The logfile is where all logging and error messages are written. The logfile
+ can be useful for tracking down a problem with
+ <application>Privoxy</application> (e.g., it's not blocking an ad you
+ think it should block) but in most cases you probably will never look at it.
+</para>
-<sect4><title>jarfile</title>
+<para>
+ Your logfile will grow indefinitely, and you will probably want to
+ periodically remove it. On Unix systems, you can do this with a cron job
+ (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
+ script has been included.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The file to store intercepted cookies in
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>logdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Intercepted cookies are not stored at all.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The jarfile may grow to ridiculous sizes over time.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
+ +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
+ the effect that cron.daily will automatically archive, gzip, and empty the
+ log, when it exceeds 1M size.
+</para>
-<sect4><title>trustfile</title>
+<para>
+ Default: Log to the a file named <filename>logfile</filename>.
+ Comment out to disable logging.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The trust file to use
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>File name, relative to <literal>confdir</literal></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- The whole trust mechansim is turned off.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The trust mechansim is an experimental feature for building whitelists and should
- be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
- </para>
- <para>
- If you specify a trust file, <application>Privoxy</application> will only allow
- access to sites that are named in the trustfile.
- You can also mark sites as trusted referrers (with <literal>+</literal>), with
- the effect that access to untrusted sites will be granted, if a link from a
- trusted referrer was used.
- The link target will then be added to the <quote>trustfile</quote>.
- Possible applications include limiting internet access for children.
- </para>
- <para>
- If you use <literal>+</literal> operator in the trust file, it may grow considerably over time.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>logfile logfile</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ The <quote>jarfile</quote> defines where
+ <application>Privoxy</application> stores the cookies it intercepts. Note
+ that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
+ Don't store intercepted cookies.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>#jarfile jarfile</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ If you specify a <quote>trustfile</quote>,
+ <application>Privoxy</application> will only allow access to sites that
+ are named in the trustfile. You can also mark sites as trusted referrers,
+ with the effect that access to untrusted sites will be granted, if a link
+ from a trusted referrer was used. The link target will then be added to the
+ <quote>trustfile</quote>. This is a very restrictive feature that typical
+ users most probably want to leave disabled. Default: Disabled, don't use the
+ trust mechanism.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>#trustfile trust</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ If you use the trust mechanism, it is a good idea to write up some on-line
+ documentation about your blocking policy and to specify the URL(s) here. They
+ will appear on the page that your users receive when they try to access
+ untrusted content. Use multiple times for multiple URLs. Default: Don't
+ display links on the <quote>untrusted</quote> info page.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>trust-info-url http://www.example.com/why_we_block.html</emphasis>
+ <emphasis>trust-info-url http://www.example.com/what_we_allow.html</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
<sect3>
-<title>Local Setup Documentation</title>
+<title>Other Configuration Options</title>
- <para>
- If you intend to operate <application>Privoxy</application> for more users
- that just yourself, it might be a good idea to let them know how to reach
- you, what you block and why you do that, your policies etc.
- </para>
+<para>
+ This part of the configuration file contains options that control how
+ <application>Privoxy</application> operates.
+</para>
-<sect4><title>trust-info-url</title>
+<para>
+ <quote>Admin-address</quote> should be set to the email address of the proxy
+ administrator. It is used in many of the proxy-generated pages. Default:
+ fill@me.in.please.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>URL</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>Two example URL are provided</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No links are displayed on the "untrusted" error page.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The value of this option only matters if the experimental trust mechanism has been
- activated. (See <literal>trustfile</literal> above.)
- </para>
- <para>
- If you use the trust mechanism, it is a good idea to write up some online
- documentation about your trust policy and to specify the URL(s) here.
- Use multiple times for multiple URLs.
- </para>
- <para>
- The URL(s) should be added to the trustfile as well, so users don't end up
- locked out from the information on why they were locked out in the first place!
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>#admin-address fill@me.in.please</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>admin-address</title>
+<para>
+ <quote>Proxy-info-url</quote> can be set to a URL that contains more info
+ about this <application>Privoxy</application> installation, it's
+ configuration and policies. It is used in many of the proxy-generated pages
+ and its use is highly recommended in multi-user installations, since your
+ users will want to know why certain content is blocked or modified. Default:
+ Don't show a link to on-line documentation.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- An email address to reach the proxy administrator.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>Email address</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No email address is displayed on error pages and the CGI user interface.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
- are unset, the whole "Local Privoxy Support" box on all generated pages will
- not be shown.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
-
-<sect4><title>proxy-info-url</title>
-
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- A URL to documentation about the local <application>Privoxy</application> setup,
- configuration or policies.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>URL</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- No link to local documentation is displayed on error pages and the CGI user interface.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
- are unset, the whole "Local Privoxy Support" box on all generated pages will
- not be shown.
- </para>
- <para>
- This URL shouldn't be blocked ;-)
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>proxy-info-url http://www.example.com/proxy.html</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-</sect3>
-<!-- ~ End section ~ -->
+<para>
+ <quote>Listen-address</quote> specifies the address and port where
+ <application>Privoxy</application> will listen for connections from your
+ Web browser. The default is to listen on the localhost port 8118, and
+ this is suitable for most users. (In your web browser, under proxy
+ configuration, list the proxy server as <quote>localhost</quote> and the
+ port as <quote>8118</quote>).
+</para>
-<!-- ~~~~~ New section ~~~~~ -->
+<para>
+ If you already have another service running on port 8118, 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
+ <quote>listen-address [<ip-address>]:<port></quote>. If you leave
+ out the IP address, <application>Privoxy</application> 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
+ <quote>aclfile</quote> above), or a firewall.
+</para>
-<sect3>
-<title>Debugging</title>
+<para>
+ For example, suppose you are running <application>Privoxy</application> on
+ a machine which has the address 192.168.0.1 on your local private network
+ (192.168.0.0) and has another outside connection with a different address.
+ You want it to serve requests from inside only:
+</para>
- <para>
- These options are mainly useful when tracing a problem.
- Note that you might also want to invoke
- <application>Privoxy</application> with the <literal>--no-daemon</literal>
- command line option when debugging.
- </para>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>listen-address 192.168.0.1:8118</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>debug</title>
+<para>
+ If you want it to listen on all addresses (including the outside
+ connection):
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Keys that determine what information gets logged.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>Integer values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>12289 (i.e.: URLs plus informational and warning messages)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Nothing gets logged.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- The available debug levels are:
- </para>
- <para>
- <programlisting>
- debug 1 # show each GET/POST/CONNECT request
- debug 2 # show each connection status
- debug 4 # show I/O status
- debug 8 # show header parsing
- debug 16 # log all data into the logfile
- debug 32 # debug force feature
- debug 64 # debug regular expression filter
- debug 128 # debug fast redirects
- debug 256 # debug GIF de-animation
- debug 512 # Common Log Format
- debug 1024 # debug kill pop-ups
- debug 4096 # Startup banner and warnings.
- debug 8192 # Non-fatal errors
- </programlisting>
- </para>
- <para>
- To select multiple debug levels, you can either add them or use
- multiple <literal>debug</literal> lines.
- </para>
- <para>
- A debug level of 1 is informative because it will show you each request
- as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
- so that you will notice when things go wrong. The other levels are probably
- only of interest if you are hunting down a specific problem. They can produce
- a hell of output (especially 16).
- </para>
- <para>
- The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
- <application>Privoxy</application>) is always on and cannot be disabled.
- </para>
- <para>
- If you want to use CLF (Common Log Format), you should set <quote>debug
- 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>listen-address :8118</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>single-threaded</title>
+<para>
+ If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
+ you will need to point your browser(s) to the address and port that you have
+ configured here. Default: localhost:8118 (127.0.0.1:8118).
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Whether to run only one server thread
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para><emphasis>None</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
- serve multiple requests simultaneously.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- This option is only there for debug purposes and you should never
- need to use it. <emphasis>It will drastically reduce performance.</emphasis>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The debug option sets the level of debugging information to log in the
+ logfile (and to the console in the Windows version). A debug level of 1 is
+ informative because it will show you each request as it happens. Higher
+ levels of debug are probably only of interest to developers.
+</para>
-</sect3>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ debug 1 # GPC = show each GET/POST/CONNECT request
+ debug 2 # CONN = show each connection status
+ debug 4 # IO = show I/O status
+ debug 8 # HDR = show header parsing
+ debug 16 # LOG = log all data into the logfile
+ debug 32 # FRC = debug force feature
+ debug 64 # REF = debug regular expression filter
+ debug 128 # = debug fast redirects
+ debug 256 # = debug GIF de-animation
+ debug 512 # CLF = Common Log Format
+ debug 1024 # = debug kill pop-ups
+ debug 4096 # INFO = Startup banner and warnings.
+ debug 8192 # ERROR = Non-fatal errors
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<!-- ~~~~~ New section ~~~~~ -->
+<![%p-not-stable;[
+<para>
+ It is <emphasis>highly recommended</emphasis> that you enable ERROR
+ reporting (debug 8192), at least until v3.0 is released.
+</para>
+]]>
-<sect3>
-<title>Access Control and Security</title>
+<para>
+ The reporting of FATAL errors (i.e. ones which crash
+ <application>Privoxy</application>) is always on and cannot be disabled.
+</para>
- This section of the config file controls the security-relevant aspects
- of <application>Privoxy</application>'s configuration.
- </para>
+<para>
+ If you want to use CLF (Common Log Format), you should set <quote>debug
+ 512</quote> ONLY, do not enable anything else.
+</para>
-<sect4><title>listen-address</title>
+<para>
+ Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
+ together.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- The IP address and TCP port on which <application>Privoxy</application> will
- listen for client requests.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>[<replaceable class="parameter">IP-Adddress</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>localhost:8118</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Bind to localhost (127.0.0.1), port 8118. This is suitable and recommended for
- home users who run <application>Privoxy</application> on the same machine as
- their browser.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- You will need to configure your browser(s) to this proxy address and port.
- </para>
- <para>
- If you already have another service running on port 8118, 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.
- </para>
- <para>
- If you leave out the IP address, <application>Privoxy</application> 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 <quote>Acls</quote> below), or a firewall.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Example:</term>
- <listitem>
- <para>
- Suppose you are running <application>Privoxy</application> on
- a machine which has the address 192.168.0.1 on your local private network
- (192.168.0.0) and has another outside connection with a different address.
- You want it to serve requests from inside only:
- </para>
- <para>
- <programlisting>
- listen-address 192.168.0.1:8118
- </programlisting>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>toggle</title>
+<para>
+ Default:
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Initial state of "toggle" status
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>1 or 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Act as if toggled on
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- If set to 0, <application>Privoxy</application> will start in
- <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
- proxy. See <literal>enable-remote-toggle</literal>
- below. This is not really useful anymore, since toggling is much easier
- via <ulink url="http://config.privoxy.org/toggle">the web
- interface</ulink> then via editing the <filename>conf</filename> file.
- </para>
- <para>
- The windows version will only display the toggle icon in the system tray
- if this option is present.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>debug 1 # URLs</emphasis>
+ <emphasis>debug 4096 # Info</emphasis>
+ <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+<para>
+ <application>Privoxy</application> normally uses
+ <quote>multi-threading</quote>, a software technique that permits it to
+ handle many different requests simultaneously. In some cases you may wish to
+ disable this -- particularly if you're trying to debug a problem. The
+ <quote>single-threaded</quote> option forces
+ <application>Privoxy</application> to handle requests sequentially.
+ Default: Multi-threaded mode.
+</para>
-<sect4><title>enable-remote-toggle</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
- feature</ulink> may be used
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>0 or 1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- The web-based toggle feature is disabled.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- When toggled off, <application>Privoxy</application> acts like a normal,
- content-neutral proxy, i.e. it acts as if none of the actions applied to
- any URL.
- </para>
- <para>
- For the time being, access to the toggle feature can <emphasis>not</emphasis> be
- controlled separately by <quote>Acls</quote> or HTTP authentication,
- so that everybody who can access <application>Privoxy</application> (see
- <quote>Acls</quote> and <literal>listen-address</literal> above) can
- toggle it for all users. So this option is <emphasis>not recommended</emphasis>
- for multi-user environments with untrusted users.
- </para>
- <para>
- Note that you must have compiled <application>Privoxy</application> with
- support for this feature, otherwise this option has no effect.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>#single-threaded</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+<para>
+ <quote>toggle</quote> allows you to temporarily disable all
+ <application>Privoxy's</application> filtering. Just set <quote>toggle
+ 0</quote>.
+</para>
-<sect4><title>enable-edit-actions</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Whether or not the <ulink url="http://config.privoxy.org/edit-actions">web-based actions
- file editor</ulink> may be used
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>0 or 1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- The web-based actions file editor is disabled.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- For the time being, access to the editor can <emphasis>not</emphasis> be
- controlled separately by <quote>Acls</quote> or HTTP authentication,
- so that everybody who can access <application>Privoxy</application> (see
- <quote>Acls</quote> and <literal>listen-address</literal> above) can
- modify its configuration for all users. So this option is <emphasis>not
- recommended</emphasis> for multi-user environments with untrusted users.
- </para>
- <para>
- Note that you must have compiled <application>Privoxy</application> with
- support for this feature, otherwise this option has no effect.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
-
-<sect4><title>Acls: permit-access and deny-access</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Who can access what.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>
- <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
- [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
- </para>
- <para>
- Where <replaceable class="parameter">src_addr</replaceable> and
- <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
- DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
- <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
- values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
- destination part are optional.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Don't restrict access further than implied by <literal>listen-address</literal>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- Access controls are included at the request of ISPs and systems
- administrators, and <emphasis>are not usually needed by individual users</emphasis>.
- For a typical home user, it will normally suffice to ensure that
- <application>Privoxy</application> only listens on the localhost or internal (home)
- network address by means of the <literal>listen-address</literal> option.
- </para>
- <para>
- Please see the warnings in the FAQ that this proxy is not intended to be a substitute
- for a firewall or to encourage anyone to defer addressing basic security
- weaknesses.
- </para>
- <para>
- Multiple acl lines are OK.
- If any acls are specified, then the <application>Privoxy</application>
- talks only to IP addresses that match at least one <literal>permit-access</literal> line
- and don't match any subsequent <literal>deny-access</literal> line. In other words, the
- last match wins, with the default being <literal>deny-access</literal>.
- </para>
- <para>
- If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
- for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
- that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
- of the ultimate target. This is necessary because it may be impossible for the local
- <application>Privoxy</application> to determine the IP address of the
- ultimate target (that's often what gateways are used for).
- </para>
- <para>
- You should prefer using IP addresses over DNS names, because the address lookups take
- time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
- like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
- IP addresses, only the first one is used.
- </para>
- <para>
- Denying access to particular sites by acl may have undesired side effects
- if the site in question is hosted on a machine which also hosts other sites.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Examples:</term>
- <listitem>
- <para>
- Explicitly define the defauklt behaviour if no acl and
- <literal>listen-address</literal> are set: <quote>localhost</quote>
- is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
- <emphasis>all</emphasis> destination addresses are OK:
- </para>
- <para>
- <screen>
- permit-access localhost
- </screen>
- </para>
- <para>
- Allow any host on the same class C subnet as www.privoxy.org access to
- nothing but www.example.com:
- </para>
- <para>
- <screen>
- permit-access www.privoxy.org/24 www.example.com/32
- </screen>
- </para>
- <para>
- Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
- with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
- </para>
- <para>
- <screen>
- permit-access 192.168.45.64/26
- deny-access 192.168.45.73 www.dirty-stuff.example.com
- </screen>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The Windows version of <application>Privoxy</application> 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 <quote>Options</quote> menu), one
+ choice is <quote>Enable</quote>. Clicking on enable toggles
+ <application>Privoxy</application> on and off. This is useful if you want
+ to temporarily disable <application>Privoxy</application>, e.g., to access
+ a site that requires cookies which you would otherwise have blocked. This can also
+ be toggled via a web browser at the <application>Privoxy</application>
+ internal address of <ulink url="http://p.p">http://p.p</ulink> on
+ any platform.
+</para>
+
+<para>
+ <quote>toggle 1</quote> means <application>Privoxy</application> runs
+ normally, <quote>toggle 0</quote> means that
+ <application>Privoxy</application> becomes a non-anonymizing non-blocking
+ proxy. Default: 1 (on).
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>toggle 1</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ For content filtering, i.e. the <quote>+filter</quote> and
+ <quote>+deanimate-gif</quote> actions, it is necessary that
+ <application>Privoxy</application> 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. With nasty consequences.
+</para>
+
+<para>
+ The <application>buffer-limit</application> 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 the client unfiltered and no further attempt to
+ filter the rest of it is made. Remember that there may multiple threads
+ running, which might require increasing the <quote>buffer-limit</quote>
+ Kbytes <emphasis>each</emphasis>, unless you have enabled
+ <quote>single-threaded</quote> above.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>buffer-limit 4069</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ To enable the web-based <filename>default.action</filename> file editor set
+ <application>enable-edit-actions</application> to 1, or 0 to disable. Note
+ that you must have compiled <application>Privoxy</application> with
+ support for this feature, otherwise this option has no effect. This
+ internal page can be reached at <ulink
+ url="http://p.p">http://p.p</ulink>.
+ </para>
+
+<para>
+ 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 probably want to disable this. Default: enabled.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>enable-edit-actions 1</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Allow <application>Privoxy</application> to be toggled on and off
+ remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
+ 1 to enable, and 0 to disable. Note that you must have compiled
+ <application>Privoxy</application> with support for this feature,
+ otherwise this option has no effect.
+</para>
+
+<para>
+ Security note: If this is enabled, anyone who can use the proxy can toggle
+ it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
+ their changes will affect all users. For shared proxies, you probably want to
+ disable this. Default: enabled.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>enable-remote-toggle 1</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+</sect3>
+
+<!-- ~ End section ~ -->
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect3>
+<title>Access Control List (ACL)</title>
+<para>
+ Access controls are included at the request of some ISPs and systems
+ administrators, and are not usually needed by individual users. Please note
+ the warnings in the FAQ that this proxy is not intended to be a substitute
+ for a firewall or to encourage anyone to defer addressing basic security
+ weaknesses.
+</para>
+
+<para>
+ If no access settings are specified, the proxy talks to anyone that
+ connects. If any access settings file are specified, then the proxy
+ talks only to IP addresses permitted somewhere in this file and not
+ denied later in this file.
+</para>
+
+<para>
+ Summary -- if using an ACL:
+</para>
+
+ <simplelist>
+ <member>
+ Client must have permission to receive service.
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ LAST match in ACL wins.
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ Default behavior is to deny service.
+ </member>
+ </simplelist>
+
+<para>
+ The syntax for an entry in the Access Control List is:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Where the individual fields are:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
+
+ <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
+ <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
+
+ <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
+ <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+
+<para>
+ The field separator (FS) is whitespace (space or tab).
+</para>
+
+<para>
+ IMPORTANT NOTE: If <application>Privoxy</application> is using a
+ forwarder (see below) or a gateway for a particular destination URL, the
+ <literal>DST_ADDR</literal> that is examined is the address of the forwarder
+ or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
+ target. This is necessary because it may be impossible for the local
+ <application>Privoxy</application> to determine the address of the
+ ultimate target (that's often what gateways are used for).
+</para>
+
+<para>
+ Here are a few examples to show how the ACL features work:
+</para>
+
+<para>
+ <quote>localhost</quote> is OK -- no DST_ADDR implies that
+ <emphasis>ALL</emphasis> destination addresses are OK:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access localhost</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ A silly example to illustrate permitting any host on the class-C subnet with
+ <application>Privoxy</application> to go anywhere:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access www.privoxy.com/24</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Except deny one particular IP address from using it at all:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>deny-access ident.privoxy.com</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ You can also specify an explicit network address and subnet mask.
+ Explicit addresses do not have to be resolved to be used.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access 207.153.200.0/24</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ A subnet mask of 0 matches anything, so the next line permits everyone.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access 0.0.0.0/0</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Note, you <emphasis>cannot</emphasis> say:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access .org</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
-<sect4><title>buffer-limit</title>
+<para>
+ to allow all *.org domains. Every IP address listed must resolve fully.
+</para>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Maximum size of the buffer for content filtering.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>Size in Kbytes</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para>4096</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Use a 4MB (4096 KB) limit.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- For content filtering, i.e. the <literal>+filter</literal> and
- <literal>+deanimate-gif</literal> actions, it is necessary that
- <application>Privoxy</application> 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 -- with nasty consequences.
- Hence this option.
- </para>
- <para>
- When a document buffer size reaches the <literal>buffer-limit</literal>, it is
- flushed to the client unfiltered and no further attempt to
- filter the rest of the document is made. Remember that there may be multiple threads
- running, which might require up to <literal>buffer-limit</literal> Kbytes
- <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
- above.
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ An ISP may want to provide a <application>Privoxy</application> that is
+ accessible by <quote>the world</quote> and yet restrict use of some of their
+ private content to hosts on its internal network (i.e. its own subscribers).
+ Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
+ bit netmask). This is how they could do it:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
+ # with the following exceptions:
+
+ <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
+ # sites on the ISP's network
+
+ <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
+ # web site
+
+ <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
+ # anywhere
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Note that if some hostnames are listed with multiple IP addresses,
+ the primary value returned by DNS (via gethostbyname()) is used. Default:
+ Anyone can access the proxy.
+</para>
</sect3>
<title>Forwarding</title>
<para>
- This feature allows routing of HTTP requests through a chain of
- multiple proxies.
+ This feature allows chaining of HTTP requests via multiple proxies.
It can be used to better protect privacy and confidentiality when
accessing specific domains by routing requests to those domains
- through an anonymous public proxy (see e.g. <ulink
- url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
- Or to use a caching proxy to speed up browsing. Or chaining to a parent
- proxy may be necessary because the mackine that <application>Privoxy</application>
- runs on has no direct internet access.
+ to a special purpose filtering proxy such as lpwa.com. Or to use
+ a caching proxy to speed up browsing.
+</para>
+
+<para>
+ It can also be used in an environment with multiple networks to route
+ requests via multiple gateways allowing transparent access to multiple
+ networks without having to modify browser configurations.
</para>
<para>
Also specified here are SOCKS proxies. <application>Privoxy</application>
- supports the SOCKS 4 and SOCKS 4A protocols.
+ SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
+ hostname using DNS on the SOCKS server, not our local DNS client.
</para>
-<sect4><title>forward</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- To which parent HTTP proxy specific requests should be routed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>
- <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
- </para>
- <para>
- Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
- chapter on domain matching in the actions file),
- <replaceable class="parameter">http_parent</replaceable> is the address of the parent HTTP proxy
- as an IP addresses in dotted decimal notation or as a valid DNS name (or <quote>.</quote> to denote
- <quote>no forwarding</quote>, and the optional
- <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer
- values from 1 to 64535
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Don't use parent HTTP proxies.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
- forwarded to another HTTP proxy but are made directly to the web servers.
- </para>
- <para>
- Multiple lines are OK, they are checked in sequence, and the last match wins.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Examples:</term>
- <listitem>
- <para>
- Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
- </para>
- <para>
- <screen>
- forward .* anon-proxy.example.org:8080
- forward :443 .
- </screen>
- </para>
- <para>
- Everything goes to our example ISP's caching proxy, except for requests
- to that ISP's sites:
- </para>
- <para>
- <screen>
- forward .*. caching-proxy.example-isp.net:8000
- forward .example-isp.net .
- </screen>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
-
-<sect4><title>forward-socks4 and forward-socks4a</title>
-<variablelist>
- <varlistentry>
- <term>Specifies:</term>
- <listitem>
- <para>
- Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Type of value:</term>
- <listitem>
- <para>
- <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">socks_proxy</replaceable>[/<replaceable class="parameter">port</replaceable>]
- <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
- </para>
- <para>
- Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
- chapter on domain matching in the actions file),
- <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
- are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
- may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
- <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Default value:</term>
- <listitem>
- <para><emphasis>Unset</emphasis></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Effect if unset:</term>
- <listitem>
- <para>
- Don't use SOCKS proxies.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Notes:</term>
- <listitem>
- <para>
- Multiple lines are OK, they are checked in sequence, and the last match wins.
- </para>
- <para>
- The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
- is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
- server, while in SOCKS 4 it happens locally.
- </para>
- <para>
- If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
- forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
- a SOCKS proxy.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Examples:</term>
- <listitem>
- <para>
- From the company example.com, direct connections are made to all <quote>internal</quote>
- domains, but everything outbound goes through their ISP's proxy by way example.com's
- corporate SOCKS 4A gateway to the Internet.
- </para>
- <para>
- <screen>
- forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
- forward .example.com .
- </screen>
- </para>
- <para>
- A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
- </para>
- <para>
- <screen>
- forward-socks4 .*. socks-gw.example.com:1080 .
- </screen>
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect4>
+<para>
+ The syntax of each line is:
+</para>
-<sect4><title>Advanced Forwarding Examples</title>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
+ <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
+ <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
<para>
- If you have links to multiple ISPs that provide various special content
- only to their subscribers, you can configure multiple <application>Privoxies</application>
- which have connections to the respective ISPs to act as forwarders to each other, so that
- <emphasis>your</emphasis> users can see the internal content of all ISPs.
+ If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
+ HTTP proxy but are made directly to the web servers.
</para>
<para>
- Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
- isp-b.net. Both run <application>Privoxy</application>. Their forwarding
- configuration can look like this:
+ Lines are checked in sequence, and the last match wins.
</para>
<para>
- host-a:
+ There is an implicit line equivalent to the following, which specifies that
+ anything not finding a match on the list is to go out without forwarding
+ or gateway protocol, like so:
</para>
<para>
- <screen>
- forward .*. .
- forward .isp-b.net host-b:8118
- </screen>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* . </emphasis># implicit
+ </literallayout>
+ </msgtext>
+ </literal>
</para>
<para>
- host-b:
+ In the following common configuration, everything goes to Lucent's LPWA,
+ except SSL on port 443 (which it doesn't handle):
</para>
<para>
- <screen>
- forward .*. .
- forward .isp-a.net host-a:8118
- </screen>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* lpwa.com:8000</emphasis>
+ <emphasis>forward :443 .</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+<!--
+ See the FAQ for instructions on how to automate the login procedure for LPWA.
+-->
+ Some users have reported difficulties related to LPWA's use of
+ <quote>.</quote> as the last element of the domain, and have said that this
+ can be fixed with this:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward lpwa. lpwa.com:8000</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ (NOTE: the syntax for specifying target_domain has changed since the
+ previous paragraph was written -- it will not work now. More information
+ is welcome.)
+</para>
+
+<para>
+ In this fictitious example, everything goes via an ISP's caching proxy,
+ except requests to that ISP:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* caching.myisp.net:8000</emphasis>
+ <emphasis>forward myisp.net .</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ For the @home network, we're told the forwarding configuration is this:
+</para>
+
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* proxy:8080</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Also, we're told they insist on getting cookies and JavaScript, so you should
+ allow cookies from home.com. We consider JavaScript a potential security risk.
+ Java need not be enabled.
+</para>
+
+<para>
+ In this example direct connections are made to all <quote>internal</quote>
+ domains, but everything else goes through Lucent's LPWA by way of the
+ company's SOCKS gateway to the Internet.
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
+ <emphasis>forward my_company.com .</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ This is how you could set up a site that always uses SOCKS but no forwarders:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ An advanced example for network administrators:
+</para>
+
+<para>
+ If you have links to multiple ISPs that provide various special content to
+ their subscribers, you can configure forwarding to pass requests to the
+ specific host that's connected to that ISP so that everybody can see all
+ of the content on all of the ISPs.
+</para>
+
+<para>
+ This is a bit tricky, but here's an example:
+</para>
+
+
+<para>
+ host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
+ isp-b.com. host-a can run a <application>Privoxy</application> proxy with
+ forwarding like this:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* .</emphasis>
+ <emphasis>forward isp-b.com host-b:8118</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ host-b can run a <application>Privoxy</application> proxy with forwarding
+ like this:
+</para>
+
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward .* .</emphasis>
+ <emphasis>forward isp-a.com host-a:8118</emphasis>
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+<para>
+ Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
+ and host-b) can set their browser's proxy to <emphasis>either</emphasis>
+ host-a or host-b and be able to browse the content on isp-a or isp-b.
+</para>
+
+<para>
+ Here's another practical example, for University of Kent at
+ Canterbury students with a network connection in their room, who
+ need to use the University's Squid web cache.
</para>
<para>
- Now, you users can set their browser's proxy to use either
- host-a or host-b and be able to browse the internal content
- on both isp-a or isp-b.
+ <literal>
+ <msgtext>
+ <literallayout>
+ <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
+ <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
+ <emphasis>forward * . </emphasis> # Host with no domain specified
+ <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
+ <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
+ <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
+ <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
+ </literallayout>
+ </msgtext>
+ </literal>
</para>
<para>
</para>
<para>
- Assuming that <application>Privoxy</application> and <application>squid</application>
- run on the same box, your squid configuration could then look like this:
+Your squid configuration could then look like this (assuming that the IP
+address of the box is <literal>192.168.0.1</literal> ):
</para>
<para>
- <screen>
- # Define Privoxy as parent proxy (without ICP)
- cache_peer 127.0.0.1 parent 8118 7 no-query
+ <literal>
+ <msgtext>
+ <literallayout>
+ # Define Privoxy as parent cache
+ <!-- per feedback from user...
+ cache_peer 127.0.0.1 8118 parent 0 no-query
+ -->
+ cache_peer 192.168.0.1 parent 8118 0 no-query
+
+ # don't listen to the whole world
+ http_port 192.168.0.1:3128
+
+ # define the local lan
+ acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
+ # grant access for http to local lan
+ http_access allow mylocallan
+
# Define ACL for protocol FTP
- acl ftp proto FTP
+ acl FTP proto FTP
- # Do not forward FTP requests to Privoxy
- always_direct allow ftp
+ # Do not forward ACL FTP to privoxy
+ always_direct allow FTP
- # Forward all the rest to Privoxy
- never_direct allow all
- </screen>
-</para>
+ # Do not forward ACL CONNECT (https) to privoxy
+ always_direct allow CONNECT
-<para>
- You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
- Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
+ # Forward the rest to privoxy
+ never_direct allow all
+ </literallayout>
+ </msgtext>
+ </literal>
</para>
-</sect4>
-
</sect3>
<!-- ~ End section ~ -->
<para>
The easiest way to edit the <quote>actions</quote> file is with a browser by
- loading <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
- (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>), and then select
+ loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
<quote>Edit Actions List</quote>. A text editor can also be used.
</para>
</simplelist>
</blockquote>
- <para>
- Note: Filtering requires buffering the page content, which may appear to slow down
- page rendering since nothing is displayed until all content has passed
- the filters. (It does not really take longer, but seems that way since
- the page is not incrementally displayed.) This effect will be more noticeable
- on slower connections.
-</para>
-
</listitem>
<listitem>
</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
+ at <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.
+ try to incorporate your submission into future versions.
</para>
<para>
and then some examples:
</para>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
<quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
times. Either/or.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
times.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
times.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
the following character should be taken literally. This is used where one of the
special characters (e.g. <quote>.</quote>) needs to be taken literally and
not as a special meta-character.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>()</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>|</emphasis> - The <quote>bar</quote> character works like an
<quote>or</quote> conditional statement. A match is successful if the
sub-expression on either side of <quote>|</quote> matches.
</member>
-</simplelist></para>
+</simplelist>
-<para><simplelist>
+<simplelist>
<member>
<emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
<quote>string1</quote> is replaced by <quote>string2</quote> in this
example.
</member>
-</simplelist></para>
+</simplelist>
<para>
These are just some of the ones you are likely to use when matching URLs with
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
- Revision 1.76 2002/04/16 04:25:51 hal9
- -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section.
- -Note about proxy may need requests to re-read config files.
-
- Revision 1.75 2002/04/12 02:08:48 david__schmidt
- Remove OS/2 building info... it is already in the developer-manual
-
- Revision 1.74 2002/04/11 00:54:38 hal9
- Add small section on submitting actions.
-
Revision 1.73 2002/04/10 18:45:15 swa
generated
<!entity contacting SYSTEM "contacting.sgml">
<!entity history SYSTEM "history.sgml">
<!entity copyright SYSTEM "copyright.sgml">
-<!entity p-version "2.9.14">
+<!entity p-version "2.9.13">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
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.3 2002/04/07 20:27:18 hal9 Exp $
- Written by and Copyright (C) 2001, 2002 the SourceForge
+ Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
Based on the Internet Junkbuster originally written
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
- anything in this, or other Privoxy documentation.
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license
+ to live a peaceful existence!
========================================================================
- Note: This is the privoxy home page. The Makefile is adding additional
- meta data and content via perl.
+ Note: This is the privoxy home page.
-->
<!-- end boilerplate -->
</sect1>
-<sect1 id="moreinfo" label="">
-<title>More info</title>
+<sect1 id="moreinfos" label="">
+<title>More infos</title>
<para>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<literallayout>
- <ulink url="team/index.html">Pictures of the Privoxy Team</ulink>
- </literallayout>
- </listitem>
- <listitem>
- <literallayout>
<ulink url="developer-manual/index.html">Developer Manual</ulink>
</literallayout>
</listitem>
<!-- end -->
</sect1>
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect1 label="">
-<title></title>
-<!-- dummy section, for spacing -->
-<para>
-<!-- show the SF logo per AUP -->
-<informaltable frame=none label="" pgwide="1">
- <tgroup cols=1 align="center" colsep=1 rowsep=1>
- <colspec colname=c1 align="center">
- <tbody>
- <row>
- <entry align="center">
- <ulink url="http://sourceforge.net/">
- <inlinegraphic fileref="http://sourceforge.net/sflogo.php?group_id=11118&type=1&dummy=.gif"></inlinegraphic>
- </ulink>
- </entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
-</para>
-
-<!--
-<informalfigure pgwide="1">
- <ulink url="http://sourceforge.net/">
- <inlinegraphic align="center" fileref="http://sourceforge.net/sflogo.php?group_id=11118&type=1&dummy=.gif"></inlinegraphic>
- </ulink>
-</informalfigure>
--->
-
-</sect1>
-
<!--
This program is free software; you can redistribute it
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: index.sgml,v $
- Revision 1.7 2002/04/12 10:11:53 swa
- changed bookmarklet text so that users can easily find the bookmark
-
- Revision 1.6 2002/04/12 08:34:18 swa
- added link to new page
-
- Revision 1.5 2002/04/12 02:05:19 david__schmidt
- Tiny English fix: infos -> info
- Add copyright date 2002
-
- Revision 1.4 2002/04/08 20:42:07 swa
- fixed JB spelling
-
Revision 1.3 2002/04/07 20:27:18 hal9
Fix meta data.
By: Privoxy Developers
-$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $
+$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $
The developer manual gives the users information on how to help the developer
team. It provides guidance on coding, testing, documentation and other issues.
5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
'free'
5.7.9. Add loaders to the `file_list' structure and in order
- 5.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
+ 5.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
5.8. Addendum: Template for files and function comment blocks:
5. A major redesign of some part of the code: ask the list
-Note that near a major public release, we get a bit more cautious - if unsure,
-it doesn't hurt to ask first.
-
-------------------------------------------------------------------------------
4. Documentation Guidelines
-All formal documents are maintained in Docbook SGML and located in the doc/
+All formal documents are maintained in docbook SGML and located in the doc/
source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
modular stylesheets (or comparable alternatives), and either jade or openjade
(recommended) installed in order to build docs from source. Currently there is
involved in the documentation (at present Stefan and Hal).
Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
-text files in the top-level source directory. At least for the time being.
+text files in the toplevel source directory. At least for the time being.
Packagers are encouraged to include this documentation. For those without the
ability to build the docs locally, text versions of each are kept in CVS. HTML
doc/text/ and to update all HTML documents in doc/webserver/.
Documentation writers should please make sure documents build successfully
-before committing to CVS, if possible.
+before committing to CVS.
How do you update the webserver (i.e. the pages on privoxy.org)?
2. Run make webserver which copies all files from doc/webserver to the
sourceforge webserver via scp.
-Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
-so that those without the ability to build them locally, have access to them if
-needed. This is especially important just prior to a new release! Please do
-this after the $VERSION and other release specific data in configure.in has
-been updated (this is done just prior to a new release).
-
-------------------------------------------------------------------------------
4.1. Quickstart to Docbook and SGML
v4.x <comment> is replaced by <remark>.)
* We have an international audience. Refrain from slang, or English
- idiosyncrasies (too many to list :). Humor also does not translate well
- sometimes.
+ idiosyncrasies (too many to list :).
* Try to keep overall line lengths in source files to 80 characters or less
- for obvious reasons. This is not always possible, with lengthy URLs for
+ for obvious reasons. This is not always possible, with lenghty URLs for
instance.
* Our documents are available in differing formats. Right now, they are just
re-setting with each release (done by the Makefile). A sampling of custom
entities are listed below. See any of the main docs for examples.
- * Re- "boilerplate" text entities are defined like:
+ * Re-cyclable "boilerplate" text entities are defined like:
<!entity supported SYSTEM "supported.sgml">
* Commonly used "internal entities":
- p-version: the Privoxy version string, e.g. "2.9.14".
- p-status: the project status, either "alpha", "beta", or "stable".
+ p-version: the Privoxy version string, e.g. "2.9.13".
+ p-status: the project status, either "ALPHA", "BETA", or "STABLE".
p-not-stable: use to conditionally include text in "not stable" releases
- (e.g. "beta").
+ (e.g. "BETA").
p-stable: just the opposite.
p-text: this doc is only generated as text.
Exception:
-If you are trying to add a small logic comment and do not wish to "disrupt" the
+If you are trying to add a small logic comment and do not wish to "disrubt" the
flow of the code, feel free to use a 1 line comment which is NOT on the same
line as the code.
Explanation:
-Use all lowercase, and separate words via an underscore ('_'). Do not start an
+Use all lowercase, and seperate words via an underscore ('_'). Do not start an
identifier with an underscore. (ANSI C reserves these for use by the compiler
and system headers.) Do not use identifiers which are reserved in ANSI C++.
(E.g. template, class, true, false, ...). This is in case we ever decide to
Explanation:
-Use all lowercase, and separate words via an underscore ('_'). Do not start an
+Use all lowercase, and seperate words via an underscore ('_'). Do not start an
identifier with an underscore. (ANSI C reserves these for use by the compiler
and system headers.) Do not use identifiers which are reserved in ANSI C++.
(E.g. template, class, true, false, ...). This is in case we ever decide to
if ( this == that ) { ... }
Note: In the special case that the if-statement is inside a loop, and it is
-trivial, i.e. it tests for a condition that is obvious from the purpose of the
+trivial, i.e. it tests for a condidtion that is obvious from the purpose of the
block, one-liners as above may optically preserve the loop structure and make
it easier to read.
-Status: developer-discretion.
+Status: developer-discrection.
Example exception:
if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
-Note: The former is readable and concise. The later is wordy and inefficient.
+Note: The former is readable and consice. The later is wordy and inefficient.
Please assume that any developer new to the project has at least a "good"
knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
-Note: Use 1 blank line before the closing brace and 2 lines afterward. This
+Note: Use 1 blank line before the closing brace and 2 lines afterwards. This
makes the end of function standout to the most casual viewer. Although function
-comments help separate functions, this is still a good coding practice. In
+comments help seperate functions, this is still a good coding practice. In
fact, I follow these rules when using blocks in "for", "while", "do" loops, and
long if {} statements too. After all whitespace is free!
-Status: developer-discretion on the number of blank lines. Enforced is the end
+Status: developer-discrection on the number of blank lines. Enforced is the end
of function comments.
-------------------------------------------------------------------------------
to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
SIGSEV vs. arrayPtr[0].
-Status: developer-discretion if and only if the variable is assigned a value
+Status: developer-discrection if and only if the variable is assigned a value
"shortly after" declaration.
-------------------------------------------------------------------------------
#include
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
-This duplicates the #include "file.h" behavior.
+This duplicates the #include "file.h" behaviour.
-------------------------------------------------------------------------------
Note: If you declare "file_list xyz;" (without the pointer), then including the
proper header file is necessary. If you only want to prototype a pointer,
-however, the header file is unnecessary.
+however, the header file is unneccessary.
-Status: Use with discretion.
+Status: Use with discrection.
-------------------------------------------------------------------------------
default :
log_error( ... );
- ... anomaly code goes here ...
+ ... anomly code goes here ...
continue; / break; / exit( 1 ); / etc ...
} /* end switch( hash_string( cmd ) ) */
switch statement. This API call *should* be included in a default statement.
Another Note: This is not so much a readability issue as a robust programming
-issue. The "anomaly code goes here" may be no more than a print to the STDERR
+issue. The "anomly code goes here" may be no more than a print to the STDERR
stream (as in load_config). Or it may really be an ABEND condition.
Status: Programmer discretion is advised.
variables; feel free to declare them on 1 line. You should, although, provide a
good comment on their functions.
-Status: developer-discretion.
+Status: developer-discrection.
-------------------------------------------------------------------------------
Explanation:
-Create a local struct (on the stack) if the variable will live and die within
+Create a local stuct (on the stack) if the variable will live and die within
the context of one function call.
Only "malloc" a struct (on the heap) if the variable's life will extend beyond
Example:
If a function creates a struct and stores a pointer to it in a
-list, then it should definitely be allocated via `malloc'.
+list, then it should definately be allocated via `malloc'.
-------------------------------------------------------------------------------
programmer's code. You are also 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.
+function to accomodate this.
Example:
The developer cannot be expected to provide `free'ing functions for C run-time
library functions ... such as `strdup'.
-Status: developer-discretion. The "main" use of this standard is for allocating
-and freeing data structures (complex or nested).
+Status: developer-discrection. The "main" use of this standard is for
+allocating and freeing data structures (complex or nested).
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-5.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
+5.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
Explanation:
If you have enough confidence in new code or confidence in your changes, but
-are not *quite* sure of the repercussions, add this:
+are not *quite* sure of the reprocussions, add this:
-/* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
-ifdef PLATFORM ...changed code here... #endif
+/* FIXME: this code has a logic error on platform XYZ, * attempthing to fix */
+#ifdef PLATFORM ...changed code here... #endif
or:
/* FIXME: new code that *may* break something else... */ ...new code here...
Note: If you make it clear that this may or may not be a "good thing (tm)", it
-will be easier to identify and include in the project (or conversely exclude
+will be easier to identify and include in the project (or conversly exclude
from the project).
-------------------------------------------------------------------------------
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
change the "Copyright" section to represent the rights you wish to maintain.
Note: The formfeed character that is present right after the comment flower box
-is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
-the code (via `forward-page' and `backward-page'). Please include it if you
-can.
+is handy for (X|GNU)Emacs users to skip the verbige and get to the heart of the
+code (via `forward-page' and `backward-page'). Please include it if you can.
Example for file header comments:
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
8. Releasing a new version
-To minimize trouble with distribution contents, web-page errors and the like,
-we strongly encourage you to follow this section if you prepare a new release
-of code or new pages on the webserver.
+To minimize trouble with distribution contents, webpage errors and the like, we
+strongly encourage you to follow this section if you prepare a new release of
+code or new pages on the webserver.
The following programs are required to follow this process: ncftpput (ncftp),
scp (ssh), gmake (GNU's version of make), autoconf, cvs, ???.
-Replace X, Y and Z with the actual version number (X = major, Y = minor, Z =
-point):
-
-------------------------------------------------------------------------------
8.1. Before the Release
-The following must be done by one of the developers prior to each new release.
+The following must be done by one of the developers prior to each new release:
* Make sure that everybody who has worked on the code in the last couple of
days has had a chance to yell "no!" in case they have pending changes/fixes
in their pipelines.
- * Increment the version number in configure.in in CVS. Also, increase or
- reset the RPM release number in configure.in as appropriate. Do NOT touch
- version information after export from CVS. All packages will use the
- version and release data from configure.in. Local files should not be
- changed, except prior to a CVS commit!!! This way we are all on the same
- page!
+ * Increment the version number in configure.in in CVS. Also, the RPM release
+ number in configure.in. Do NOT touch version information after export from
+ CVS. All packages will use the version and release data from configure.in.
+ Local files should not be changed, except prior to a CVS commit!!! This way
+ we are all on the same page!
* If the default actionsfile has changed since last release, bump up its
version info in this line:
Then change the version info in doc/webserver/actions/index.php, line:
'$required_actions_file_version = "A.B";'
- * Commit all files that were changed in the above steps!
-
- * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
- use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
+ * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z" (where
+ X = major, Y = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z
+ (won't work) etc.
- * The first package uploaded should be the official "tarball" release, as
- required by the GPL. This is built with the "make tarball-dist" Makefile
- target, and then can be uploaded with "make tarball-upload" (see below).
+ * The first package uploaded should be the official "tarball" release. This
+ is built with the "make tarball-dist" Makefile target, and then can be
+ uploaded with "make tarball-upload" (see below).
-------------------------------------------------------------------------------
8.2. Update the webserver
All files must be group-readable and group-writable (or no one else will be
-able to change them)! To update the webserver, create any pages locally in the
-doc/webserver/* directory (or create new directories under doc/webserver), then
+able to change them). To update the webserver, create any pages locally in the
+doc/webserver directory (or create new directories under doc/webserver), then
do
make webserver
-This will do the upload to the webserver (www.privoxy.org).
-
Note that "make dok" (or "make redhat-dok") creates doc/webserver/user-manual,
-doc/webserver/developer-manual, doc/webserver/faq and doc/webserver/index.html
-automatically. (doc/webserver/man-page/privoxy-man-page.html is created by a
-separate Makefile target, "make man", due to dependencies on some obscure perl
-scripts. See comments in GNUmakefile.)
-
-Someone should also commit these to CVS so that packagers without the ability
-to build docs locally, have access to them. This is a separate step, and should
-also be done before each official release.
+doc/webserver/developer-manual, doc/webserver/faq and doc/webserver/man-page
+automatically.
Please do NOT use any other means of transferring files to the webserver. "make
webserver" not only uploads, but will make sure that the appropriate
Ensure that you have the latest code version. Hence run:
+ cd current
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
- cd current
first.
To upload the package to Sourceforge, simply issue
- make suse-upload (or make redhat-upload)
+ make suse-upload or make redhat-upload
Go to the displayed URL and release the file publicly on Sourceforge.
Ensure that you have the latest code version. Hence run:
+ cd current
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
cd ..
Choose the right operating system (not the Debian one). If you have downloaded
Privoxy before,
+ cd current
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
- cd current
If not, please checkout Privoxy via CVS first. Run:
8.6. Windows
-You should ensure you have the latest version of Cygwin (from http://
-www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
-
-First check out a clean copy of the correct code version, by running:
+Ensure that you have the latest code version. Hence run
- mkdir dist
- 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 .
+ cd current
+ 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
-(Note: It is important that this is a clean copy of the code, do not re-use a
-working directory after you have manually compiled there).
-
-Then you can build the package. This is fully automated, and is controlled by
-winsetup/GNUmakefile. All you need to do is:
+Run:
- cd winsetup
- make
+ autoheader && autoconf && ./configure
-Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
-upload it to SourceForge.
+Then do FIXME.
-------------------------------------------------------------------------------
Ensure that you have the latest code version. Hence run:
+ cd current
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
- cd current
first. Run:
Ensure that you have the latest code version. Hence run:
+ cd current
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
cd ..
ssh cf.sourceforge.net
-Choose the right operating system.
+Choose the right operating system. If you have downloaded Privoxy before,
+ cd current
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
- cd current
-Run:
+If not, please checkout Privoxy via CVS first. Run:
autoheader && autoconf && ./configure
8.10. Tarball
-Ensure that you have the right code version. Hence run:
+Ensure that you have the latest code version. Hence run:
+ cd current
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
- cd current
first. Run:
+ make clobber
autoheader && autoconf && ./configure
Ensure that you have the latest code version. Hence run:
+ cd current
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
- cd current
first. Run:
Ensure that you have the latest code version. Hence run:
+ cd current
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
- cd current
first. Run:
Choose the right operating system. If you have downloaded Privoxy before:
+ cd current
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
- cd current
If not, please checkout Privoxy via CVS first. Run:
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge Support Forum to get help:
+ * Use the Sourceforge Support Forum to get help:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only through our Sourceforge Bug Forum:
+ * Submit bugs only through our Sourceforge Bug Forum:
http://sourceforge.net/tracker/?group_id=11118&atid=111118.
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only through our Sourceforge feature request forum:
+ * Submit feature requests only through our Sourceforge feature request forum:
http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
- * You can also send feedback on websites that Privoxy has problems with. Please bookmark
- the following link: "Privoxy - Submit Filter Feedback"
- . 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.
+ * Submit missed ads and banners, and incorrectly blocked images, popups, etc:
+
+ http://p.p/, and select "actions file feedback system"
- * For any other issues, feel free to use the mailing lists:
+ This page can also be reached from many of the internal CGI pages.
+
+ * For any other issues, feel free to use the mailing lists:
http://sourceforge.net/mail/?group_id=11118.
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
-------------------------------------------------------------------------------
By: Privoxy Developers
-$Id: faq.sgml,v 1.49 2002/04/12 10:10:18 swa Exp $
+$Id: faq.sgml,v 1.47 2002/04/10 04:05:32 hal9 Exp $
This FAQ gives users and developers alike answers to frequently asked questions
about Privoxy .
If you have version 2.0.2, then the equivalent is http://example.com/
show-proxy-args (but you get far less information, and you should really
-consider upgrading to 2.9.14).
+consider upgrading to 2.9.13).
-------------------------------------------------------------------------------
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge Support Forum to get help:
+ * Use the Sourceforge Support Forum to get help:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only through our Sourceforge Bug Forum:
+ * Submit bugs only through our Sourceforge Bug Forum:
http://sourceforge.net/tracker/?group_id=11118&atid=111118.
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only through our Sourceforge feature request forum:
+ * Submit feature requests only through our Sourceforge feature request forum:
http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
- * You can also send feedback on websites that Privoxy has problems with. Please bookmark
- the following link: "Privoxy - Submit Filter Feedback"
- . 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.
+ * Submit missed ads and banners, and incorrectly blocked images, popups, etc:
+
+ http://p.p/, and select "actions file feedback system"
- * For any other issues, feel free to use the mailing lists:
+ This page can also be reached from many of the internal CGI pages.
+
+ * For any other issues, feel free to use the mailing lists:
http://sourceforge.net/mail/?group_id=11118.
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
-------------------------------------------------------------------------------
By: Privoxy Developers
-$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $
+$Id: user-manual.sgml,v 1.73 2002/04/10 18:45:15 swa Exp $
The user manual gives users information on how to install, configure and use
Privoxy.
The directory you choose to install Privoxy into will contain all of the
configuration files.
+If you would like to build binary images on OS/2 yourself, you will need a few
+Unix-like tools: autoconf, autoheader and sh. These tools will be used to
+create the required config.h file, which is not part of the source distribution
+because it differs based on platform. You will also need a compiler. The
+distribution has been created using IBM VisualAge compilers, but you can use
+any compiler you like. GCC/EMX has the disadvantage of needing to be
+single-threaded due to a limitation of EMX's implementation of the select()
+socket call.
+
+In addition to needing the source code distribution as outlined earlier, you
+will want to extract the os2seutp directory from CVS:
+
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
+
+
+This will create a directory named os2setup/, which will contain the
+Makefile.vac makefile and os2build.cmd which is used to completely create the
+binary distribution. The sequence of events for building the executable for
+yourself goes something like this:
+
+ cd current
+ autoheader
+ autoconf
+ sh configure
+ cd ..\os2setup
+ nmake -f Makefile.vac
+
+
+You will see this sequence laid out in os2build.cmd.
+
-------------------------------------------------------------------------------
3.1.4. Windows
config.privoxy.org/), which is an internal page. You will see the following
section:
- Please choose from the following options:
+Please choose from the following options:
* Show information about the current configuration
* Show the source code version numbers
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge Support Forum to get help:
+ * Use the Sourceforge Support Forum to get help:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only through our Sourceforge Bug Forum:
+ * Submit bugs only through our Sourceforge Bug Forum:
http://sourceforge.net/tracker/?group_id=11118&atid=111118.
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only through our Sourceforge feature request forum:
+ * Submit feature requests only through our Sourceforge feature request forum:
http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
- * You can also send feedback on websites that Privoxy has problems with. Please bookmark
- the following link: "Privoxy - Submit Filter Feedback"
- . 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.
+ * Submit missed ads and banners, and incorrectly blocked images, popups, etc:
+
+ http://p.p/, and select "actions file feedback system"
- * For any other issues, feel free to use the mailing lists:
+ This page can also be reached from many of the internal CGI pages.
+
+ * For any other issues, feel free to use the mailing lists:
http://sourceforge.net/mail/?group_id=11118.
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
-------------------------------------------------------------------------------
it does nothing. Every action is disabled. This is not particularly informative
for our purposes here. OK, next section:
- Matches for http://google.com:
+ Matches for http://google.com:
{ -add-header -block +deanimate-gifs -downgrade +fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
And now we pull it altogether in the bottom section and summarize how Privoxy
is appying all its "actions" to "google.com":
- Final results:
+ Final results:
-add-header -block -deanimate-gifs -downgrade -fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
Now another example, "ad.doubleclick.net":
- { +block +image }
+ { +block +image }
.ad.doubleclick.net
{ +block +image }
One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/". This one is
giving us problems. We are getting a blank page. Hmmm...
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+ Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
{ -add-header -block +deanimate-gifs -downgrade +fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
explictly does not block (-block) pages with "adsl". There are various ways to
handle such exceptions. Example:
- { -block }
+ { -block }
/adsl
But now what about a situation where we get no explicit matches like we did
with:
- { -block }
+ { -block }
/adsl
cause would be one of the "{+filter}" actions. Try adding the URL for the site
to one of aliases that turn off "+filter":
- {shop}
+ {shop}
.quietpc.com
.worldpay.com # for quietpc.com
.jungle.com
"{shop}" is an "alias" that expands to "{ -filter -no-cookies -no-cookies-keep
}". Or you could do your own exception to negate filtering:
- {-filter}
+ {-filter}
.forbes.com
This file belongs in
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: index.php,v 1.22 2002/04/11 10:11:04 oes Exp $
+ $Id: index.php,v 1.21 2002/04/10 13:51:19 oes Exp $
$Log: index.php,v $
- Revision 1.22 2002/04/11 10:11:04 oes
- Actionsfile Version 1.2
-
Revision 1.21 2002/04/10 13:51:19 oes
Updated to new Bookmarklet
*/
$headers = getallheaders();
-if (!isset($headers["X-Actions-File-Version"]) || $headers["X-Actions-File-Version"] != $required_actions_file_version)
+if (!isset($headers["X-Actions-File-Version"]) || $headers["X-Actions-File-Version"] < $required_actions_file_version)
{
error_abort("invalid", "<p>As much as we welcome your feedback, please note that
</p>
<ul>
<li><a href=\"http://www.privoxy.org/\" target=\"_blank\">Privoxy</a> version $required_privoxy_version or later</li>
- <li><a href=\"$actions_file_download\">Actionsfile</a> version version $required_actions_file_version</li>
+ <li><a href=\"$actions_file_download\">Actionsfile</a> version version $required_actions_file_version or later</li>
</ul>
<p>We hope you will understand that we feel unable to maintain concurrent versions of the file.</p>
<p><i>Hint: To upgrade your actions file, just right-click the above link, then save as default.action in
The Privoxy team relies on <b>your</b> feedback to maintain an efficient actions file!
<br>Please fill the below form and click to proceed to step 2.
</p>
-
- <p>
- Please keep in mind that this is <b>not</b> the place for
- <a href="http://sourceforge.net/tracker/?group_id=11118&atid=211118" target="_blank">support requests</a>,
- <br><a href="http://sourceforge.net/tracker/?group_id=11118&atid=111118" target="_blank">bug reports</a> or
- <a href="http://sourceforge.net/tracker/?atid=361118&group_id=11118" target="_blank">feature requests</a>.
- </p>
-
</div>
<div class="box">
This file belongs in
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: step2.php,v 1.13 2002/04/09 13:08:21 oes Exp $
+ $Id: step2.php,v 1.12 2002/04/08 17:04:05 oes Exp $
$Log: step2.php,v $
- Revision 1.13 2002/04/09 13:08:21 oes
- declare script type
-
Revision 1.12 2002/04/08 17:04:05 oes
Adapt to unified stylesheet
/*
* If the protocol is missing from $referrer_url, prepend "http://"
*/
-if (!preg_match('|^https?://|i', $referrer_url, $dummy))
+if (strncmp("http://", $referrer_url, 7))
{
$referrer_url = "http://" . $referrer_url;
}
This file belongs in
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: step3.php,v 1.15 2002/04/09 15:08:10 oes Exp $
+ $Id: step3.php,v 1.14 2002/04/08 17:04:05 oes Exp $
$Log: step3.php,v $
- Revision 1.15 2002/04/09 15:08:10 oes
- Restoring lost text change
-
Revision 1.14 2002/04/08 17:04:05 oes
Adapt to unified stylesheet
$name = "anonymous";
}
-/*
- * Assign unique ID:
- */
-$item_id = date("U");
-
/*
* Open the logfile or fail:
* Write Head (type, severity, user, client-ip)
* and remarks field:
*/
-fwrite($fp, "\n#FEEDBACK ID $item_id TYPE $problem SEVERITY $severity FROM $name ON $REMOTE_ADDR VERIFIED $url_confirmed TIME " . date("r") ."\n");
+fwrite($fp, "\n#FEEDBACK TYPE $problem SEVERITY $severity FROM $name ON $REMOTE_ADDR VERIFIED $url_confirmed TIME " . date("r") ."\n");
if (isset($remarks))
{
$lines = explode("\n", $remarks);
if (isset($block_image[$i]))
{
fwrite($fp, "#BLOCK-URL: $image_url[$i]\n");
- $trackertext .= "Block image: $image_url[$i]\n\n";
+ $trackertext .= "Block image: $image_url[$i]\n";
}
}
}
if (isset($manual_image_url) && ($manual_image_url != ""))
{
fwrite($fp, "#BLOCK-URL: $manual_image_url\n");
- $trackertext .= "Block image: $manual_image_url\n\n";
+ $trackertext .= "Block image: $manual_image_url\n";
}
break;
if (isset($image_url) && ($image_url != ""))
{
fwrite($fp, "#UNBLOCK-URL: $image_url\n");
- $trackertext .= "Unblock image: $image_url\n\n";
+ $trackertext .= "Unblock image: $image_url\n";
}
break;
default: $category_id="412814"; $summary = "IMPOSSIBLE ";break;
}
-$summary .= "on " . $referrer_url . " (" .$item_id . ")";
+$summary .= date("U"); /* Must be unique */
$priority = 3 * $severity;
-$details = urlencode("On " . date("r") . " new data was received from $name:\n\n"
- ."URL: $referrer_url\n\n$trackertext\nRemarks:\n$remarks");
+$details = urlencode("On " . date("r") . " new data was received from $name:\n"
+ ."URL: $referrer_url\n$trackertext\nRemarks:\n\n$remarks");
$postfields = ( "group_id=11118&atid=460288&func=postadd&category_id=$category_id&artifact_group_id=195890" .
"&priority=$priority&summary=$summary&details=$details" );
></P
><P
>If you are trying to add a small logic comment and do not
- wish to "disrupt" the flow of the code, feel free to use a 1
+ wish to "disrubt" the flow of the code, feel free to use a 1
line comment which is NOT on the same line as the code.</P
></DIV
><DIV
>Explanation:</I
></P
><P
->Use all lowercase, and separate words via an underscore
+>Use all lowercase, and seperate words via an underscore
('_'). Do not start an identifier with an underscore. (ANSI C
reserves these for use by the compiler and system headers.) Do
not use identifiers which are reserved in ANSI C++. (E.g.
>Explanation:</I
></P
><P
->Use all lowercase, and separate words via an underscore
+>Use all lowercase, and seperate words via an underscore
('_'). Do not start an identifier with an underscore. (ANSI C
reserves these for use by the compiler and system headers.) Do
not use identifiers which are reserved in ANSI C++. (E.g.
>Note:</I
> In the special case that the if-statement is
inside a loop, and it is trivial, i.e. it tests for a
- condition that is obvious from the purpose of the block,
+ condidtion that is obvious from the purpose of the block,
one-liners as above may optically preserve the loop structure
and make it easier to read.</P
><P
><I
CLASS="EMPHASIS"
>Status:</I
-> developer-discretion.</P
+> developer-discrection.</P
><P
><I
CLASS="EMPHASIS"
><I
CLASS="EMPHASIS"
>Note:</I
-> The former is readable and concise. The later
+> The former is readable and consice. The later
is wordy and inefficient. Please assume that any developer new
to the project has at least a "good" knowledge of C/C++. (Hope
I do not offend by that last comment ... 8-)</P
CLASS="EMPHASIS"
>Note:</I
> Use 1 blank line before the closing brace and 2
- lines afterward. This makes the end of function standout to
+ lines afterwards. This makes the end of function standout to
the most casual viewer. Although function comments help
- separate functions, this is still a good coding practice. In
+ seperate functions, this is still a good coding practice. In
fact, I follow these rules when using blocks in "for", "while",
"do" loops, and long if {} statements too. After all whitespace
is free!</P
><I
CLASS="EMPHASIS"
>Status:</I
-> developer-discretion on the number of blank
+> developer-discrection on the number of blank
lines. Enforced is the end of function comments.</P
></DIV
><DIV
><I
CLASS="EMPHASIS"
>Status:</I
-> developer-discretion if and only if the
+> developer-discrection if and only if the
variable is assigned a value "shortly after" declaration.</P
></DIV
></DIV
>Note:</I
> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
- "file.h" behavior.</P
+ "file.h" behaviour.</P
></DIV
><DIV
CLASS="SECT3"
> If you declare "file_list xyz;" (without the
pointer), then including the proper header file is necessary.
If you only want to prototype a pointer, however, the header
- file is unnecessary.</P
+ file is unneccessary.</P
><P
><I
CLASS="EMPHASIS"
>Status:</I
-> Use with discretion.</P
+> Use with discrection.</P
></DIV
></DIV
><DIV
default :
log_error( ... );
- ... anomaly code goes here ...
+ ... anomly code goes here ...
continue; / break; / exit( 1 ); / etc ...
} /* end switch( hash_string( cmd ) ) */</PRE
CLASS="EMPHASIS"
>Another Note:</I
> This is not so much a readability issue
- as a robust programming issue. The "anomaly code goes here" may
+ as a robust programming issue. The "anomly code goes here" may
be no more than a print to the STDERR stream (as in
load_config). Or it may really be an ABEND condition.</P
><P
><I
CLASS="EMPHASIS"
>Status:</I
-> developer-discretion.</P
+> developer-discrection.</P
></DIV
><DIV
CLASS="SECT3"
>Explanation:</I
></P
><P
->Create a local struct (on the stack) if the variable will
+>Create a local stuct (on the stack) if the variable will
live and die within the context of one function call.</P
><P
>Only "malloc" a struct (on the heap) if the variable's life
><PRE
CLASS="PROGRAMLISTING"
>If a function creates a struct and stores a pointer to it in a
-list, then it should definitely be allocated via `malloc'.</PRE
+list, then it should definately be allocated via `malloc'.</PRE
></TD
></TR
></TABLE
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.</P
+ free/unload/destuctor type function to accomodate this.</P
><P
><I
CLASS="EMPHASIS"
><I
CLASS="EMPHASIS"
>Status:</I
-> developer-discretion. The "main" use of this
+> developer-discrection. The "main" use of this
standard is for allocating and freeing data structures (complex
or nested).</P
></DIV
><A
NAME="S45"
>5.7.10. "Uncertain" new code and/or changes to
- existing code, use FIXME</A
+ exitinst code, use FIXME</A
></H3
><P
><I
></P
><P
>If you have enough confidence in new code or confidence in
- your changes, but are not *quite* sure of the repercussions,
+ your changes, but are not *quite* sure of the reprocussions,
add this:</P
><P
>/* FIXME: this code has a logic error on platform XYZ, *
- attempting to fix */ #ifdef PLATFORM ...changed code here...
+ attempthing to fix */ #ifdef PLATFORM ...changed code here...
#endif</P
><P
>or:</P
>Note:</I
> If you make it clear that this may or may not
be a "good thing (tm)", it will be easier to identify and
- include in the project (or conversely exclude from the
+ include in the project (or conversly exclude from the
project).</P
></DIV
></DIV
><TD
><PRE
CLASS="PROGRAMLISTING"
->const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $";
+>const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
>Note:</I
> The formfeed character that is present right
after the comment flower box is handy for (X|GNU)Emacs users to
- skip the verbiage and get to the heart of the code (via
+ skip the verbige and get to the heart of the code (via
`forward-page' and `backward-page'). Please include it if you
can.</P
><P
CLASS="PROGRAMLISTING"
>#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
><LI
><P
CLASS="LITERALLAYOUT"
->Use the Sourceforge Support Forum to get help:<br>
+> Use the Sourceforge Support Forum to get help:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=211118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit bugs only through our Sourceforge Bug Forum:<br>
+> Submit bugs only through our Sourceforge Bug Forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=111118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit feature requests only through our Sourceforge feature request forum:<br>
+> Submit feature requests only through our Sourceforge feature request forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"
><LI
><P
CLASS="LITERALLAYOUT"
->You can also send feedback on websites that Privoxy has problems with. Please bookmark<br>
-the following link: <A
+> Submit missed ads and banners, and incorrectly blocked images, popups, etc:<br>
+ <br>
+ <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>, and select <A
HREF="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());"
TARGET="_top"
><SPAN
CLASS="QUOTE"
->"Privoxy - Submit Filter Feedback"</SPAN
+>"actions file feedback system"</SPAN
></A
->. Once you surf to a page with problems, use the<br>
-bookmark to send us feedback. We will look into the issue as soon as possible.<br>
+><br>
</P
+><P
+> This page can also be reached from many of the internal CGI pages.
+ </P
></LI
><LI
><P
CLASS="LITERALLAYOUT"
->For any other issues, feel free to use the mailing lists:<br>
+> For any other issues, feel free to use the mailing lists:<br>
<br>
<A
HREF="http://sourceforge.net/mail/?group_id=11118"
><P
> Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
</P
></LI
></UL
><H2
CLASS="SECT2"
><A
-NAME="AEN962"
+NAME="AEN940"
>10.1. Copyright</A
></H2
><P
><H2
CLASS="SECT2"
><A
-NAME="AEN969"
+NAME="AEN947"
>10.2. History</A
></H2
><P
>4. Documentation Guidelines</A
></H1
><P
-> All formal documents are maintained in Docbook SGML and located in the
+> All formal documents are maintained in docbook SGML and located in the
<TT
CLASS="COMPUTEROUTPUT"
>doc/source/*</TT
CLASS="FILENAME"
>INSTALL</TT
>) are maintained as plain text files in the
- top-level source directory. At least for the time being.
+ toplevel source directory. At least for the time being.
</P
><P
> Packagers are encouraged to include this documentation. For those without
</P
><P
> Documentation writers should please make sure documents build
- successfully before committing to CVS, if possible.
+ successfully before committing to CVS.
</P
><P
> How do you update the webserver (i.e. the pages on privoxy.org)?
></OL
>
</P
-><P
-> Finished docs should be occasionally submitted to CVS
- (<TT
-CLASS="FILENAME"
->doc/webserver/*/*.html</TT
->) so that those without
- the ability to build them locally, have access to them if needed.
- This is especially important just prior to a new release! Please
- do this <I
-CLASS="EMPHASIS"
->after</I
-> the <TT
-CLASS="LITERAL"
->$VERSION</TT
-> and
- other release specific data in <TT
-CLASS="FILENAME"
->configure.in</TT
-> has been
- updated (this is done just prior to a new release).
- </P
><DIV
CLASS="SECT2"
><H2
><TD
> <I
CLASS="EMPHASIS"
-><literallayout></literallayout></I
+><literallayout></literllayout></I
>, like
<TT
CLASS="LITERAL"
><TD
> <I
CLASS="EMPHASIS"
-><itemizedlist></itemizedlist></I
+><itemizedlist></itemizdelist></I
>, list with bullets.
</TD
></TR
><LI
><P
> We have an international audience. Refrain from slang, or English
- idiosyncrasies (too many to list :). Humor also does not translate
- well sometimes.
+ idiosyncrasies (too many to list :).
</P
></LI
><LI
><P
> Try to keep overall line lengths in source files to 80 characters or less
- for obvious reasons. This is not always possible, with lengthy URLs for
+ for obvious reasons. This is not always possible, with lenghty URLs for
instance.
</P
></LI
><H2
CLASS="SECT2"
><A
-NAME="AEN186"
+NAME="AEN179"
>4.3. Privoxy Custom Entities</A
></H2
><P
><UL
><LI
><P
-> Re- <SPAN
+> Re-cyclable <SPAN
CLASS="QUOTE"
>"boilerplate"</SPAN
> text entities are defined like:
>
version string, e.g. <SPAN
CLASS="QUOTE"
->"2.9.14"</SPAN
+>"2.9.13"</SPAN
>.
</TD
></TR
>: the project status, either
<SPAN
CLASS="QUOTE"
->"alpha"</SPAN
+>"ALPHA"</SPAN
>, <SPAN
CLASS="QUOTE"
->"beta"</SPAN
+>"BETA"</SPAN
>, or <SPAN
CLASS="QUOTE"
->"stable"</SPAN
+>"STABLE"</SPAN
>.
</TD
></TR
>"not stable"</SPAN
> releases (e.g. <SPAN
CLASS="QUOTE"
->"beta"</SPAN
+>"BETA"</SPAN
>).
</TD
></TR
></DIV
><P
CLASS="PUBDATE"
->$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $<BR></P
+>$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
TARGET="_top"
>http://www.privoxy.org/developer-manual/</A
>.
- Please see <A
-HREF="contact.html"
-TARGET="_top"
->the Contact section</A
->
- on how to contact the developers.</P
+ Please see the Contact section on how to contact the developers.</P
><P
></P
></DIV
></DT
><DT
>4.3. <A
-HREF="documentation.html#AEN186"
+HREF="documentation.html#AEN179"
>Privoxy Custom Entities</A
></DT
></DL
>5.7.10. <A
HREF="coding.html#S45"
>"Uncertain" new code and/or changes to
- existing code, use FIXME</A
+ exitinst code, use FIXME</A
></DT
></DL
></DD
><DL
><DT
>10.1. <A
-HREF="copyright.html#AEN962"
+HREF="copyright.html#AEN940"
>Copyright</A
></DT
><DT
>10.2. <A
-HREF="copyright.html#AEN969"
+HREF="copyright.html#AEN947"
>History</A
></DT
></DL
>Releasing a new version</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
>8. Releasing a new version</A
></H1
><P
-> To minimize trouble with distribution contents, web-page
+> To minimize trouble with distribution contents, webpage
errors and the like, we strongly encourage you
to follow this section if you prepare a new release of
code or new pages on the webserver.
CLASS="FILENAME"
>configure.in</TT
> in
- CVS. Also, increase or reset the RPM release number in
+ CVS. Also, inrease or reset the RPM release number in
<TT
CLASS="FILENAME"
>configure.in</TT
></LI
><LI
><P
-> If the default <TT
-CLASS="FILENAME"
->actionsfile</TT
-> has changed since last
- release, bump up its version info in this line:
+> If the default actionsfile has changed since last release,
+ bump up its version info in this line:
</P
><P
>
<SPAN
CLASS="QUOTE"
>"tarball"</SPAN
-> release, as required by the GPL. This is built
- with the <SPAN
+> release. This is built with the
+ <SPAN
CLASS="QUOTE"
>"<B
CLASS="COMMAND"
>make tarball-dist</B
>"</SPAN
-> Makefile
+> Makefile
target, and then can be uploaded with
<SPAN
CLASS="QUOTE"
></H2
><P
> All files must be group-readable and group-writable (or no one else
- will be able to change them)! To update the webserver, create any
+ will be able to change them). To update the webserver, create any
pages locally in the <TT
CLASS="FILENAME"
->doc/webserver/*</TT
+>doc/webserver</TT
> directory (or
create new directories under <TT
CLASS="FILENAME"
>
</P
><P
-> This will do the upload to the webserver (www.privoxy.org).
- </P
-><P
> Note that <SPAN
CLASS="QUOTE"
>"<B
> and
<TT
CLASS="FILENAME"
->doc/webserver/index.html</TT
+>doc/webserver/man-page</TT
> automatically.
- (<TT
-CLASS="FILENAME"
->doc/webserver/man-page/privoxy-man-page.html</TT
->
- is created by a separate Makefile target, <SPAN
-CLASS="QUOTE"
->"<B
-CLASS="COMMAND"
->make
- man</B
->"</SPAN
->, due to dependencies on some obscure perl scripts.
- See comments in <TT
-CLASS="FILENAME"
->GNUmakefile</TT
->.)
</P
><P
->
- Someone should also commit these to CVS so that packagers without the
- ability to build docs locally, have access to them. This is a separate
- step, and should also be done before each official release.
- </P
-><P
> Please do NOT use any other means of transferring files to the
webserver. <SPAN
CLASS="QUOTE"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> make suse-upload (or make redhat-upload)
+> make suse-upload or make redhat-upload
</PRE
></TD
></TR
>8.6. Windows</A
></H2
><P
-> You should ensure you have the latest version of Cygwin (from
- <A
-HREF="http://www.cygwin.com/"
-TARGET="_top"
->http://www.cygwin.com/</A
->).
- Run the following commands from within a Cygwin bash shell.
- </P
-><P
-> First check out a clean copy of the correct code version, by running:
- </P
+> Ensure that you have the latest code version. Hence run
+ </P
><P
-> <TABLE
+> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> mkdir dist
- 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 .
- </PRE
+> 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
+ cd current
+ </PRE
></TD
></TR
></TABLE
>
- </P
-><P
-> (Note: It is important that this is a clean copy of the code,
- do not re-use a working directory after you have manually compiled
- there).
- </P
+ </P
><P
-> Then you can build the package. This is fully automated, and is
- controlled by <TT
-CLASS="FILENAME"
->winsetup/GNUmakefile</TT
->.
- All you need to do is:
- </P
+> Run:
+ </P
><P
-> <TABLE
+> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd winsetup
- make
- </PRE
+> autoheader && autoconf && ./configure
+ </PRE
></TD
></TR
></TABLE
>
- </P
+ </P
><P
-> Now you can manually rename <TT
-CLASS="FILENAME"
->privoxy_setup.exe</TT
-> to
- <TT
-CLASS="FILENAME"
->privoxy_setup_X_Y_Z.exe</TT
->, and upload it to
- SourceForge.
- </P
+> Then do FIXME.
+ </P
></DIV
><DIV
CLASS="SECT2"
>3. Quickstart to Privoxy Development</A
></H1
><P
->
You'll need an account on <A
+>You'll need an account on <A
HREF="http://sourceforge.net"
TARGET="_top"
>Sourceforge</A
-> to support our
- development. Mail your ID to the list and wait until a project
- manager has added you.
- </P
+> to support our development.
+Mail your ID to the list and wait until a project manager has added you.</P
><P
-> For the time being (read, this section is under construction), please
- note the following guidelines for changing stuff in the code. If it is
- <P
+>For the time being (read, this section is under construction), please note the
+following guidelines for changing stuff in the code. If it is
></P
><OL
TYPE="1"
><LI
><P
-> A bugfix / clean-up / cosmetic thing: shoot
- </P
+> A bugfix / clean-up / cosmetic thing: shoot
+ </P
></LI
><LI
><P
-> A new feature that can be turned off: shoot
- </P
+> A new feature that can be turned off: shoot
+ </P
></LI
><LI
><P
-> A clear improvement w/o side effects on other parts of the code: shoot
- </P
+> A clear improvement w/o side effects on other parts of the code: shoot
+ </P
></LI
><LI
><P
-> A matter of taste: ask the list
- </P
+> A matter of taste: ask the list
+ </P
></LI
><LI
><P
-> A major redesign of some part of the code: ask the list
- </P
+> A major redesign of some part of the code: ask the list
+ </P
></LI
></OL
->
- </P
-><P
-> Note that near a major public release, we get a bit more cautious - if
- unsure, it doesn't hurt to ask first.
- </P
+>
+ </P
></DIV
><DIV
CLASS="NAVFOOTER"
><LI
><P
CLASS="LITERALLAYOUT"
->Use the Sourceforge Support Forum to get help:<br>
+> Use the Sourceforge Support Forum to get help:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=211118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit bugs only through our Sourceforge Bug Forum:<br>
+> Submit bugs only through our Sourceforge Bug Forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=111118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit feature requests only through our Sourceforge feature request forum:<br>
+> Submit feature requests only through our Sourceforge feature request forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"
><LI
><P
CLASS="LITERALLAYOUT"
->You can also send feedback on websites that Privoxy has problems with. Please bookmark<br>
-the following link: <A
+> Submit missed ads and banners, and incorrectly blocked images, popups, etc:<br>
+ <br>
+ <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>, and select <A
HREF="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());"
TARGET="_top"
><SPAN
CLASS="QUOTE"
->"Privoxy - Submit Filter Feedback"</SPAN
+>"actions file feedback system"</SPAN
></A
->. Once you surf to a page with problems, use the<br>
-bookmark to send us feedback. We will look into the issue as soon as possible.<br>
+><br>
</P
+><P
+> This page can also be reached from many of the internal CGI pages.
+ </P
></LI
><LI
><P
CLASS="LITERALLAYOUT"
->For any other issues, feel free to use the mailing lists:<br>
+> For any other issues, feel free to use the mailing lists:<br>
<br>
<A
HREF="http://sourceforge.net/mail/?group_id=11118"
><P
> Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
</P
></LI
></UL
><H2
CLASS="SECT2"
><A
-NAME="AEN720"
+NAME="AEN722"
>8.1. Copyright</A
></H2
><P
><H2
CLASS="SECT2"
><A
-NAME="AEN727"
+NAME="AEN729"
>8.2. History</A
></H2
><P
></DIV
><P
CLASS="PUBDATE"
->$Id: faq.sgml,v 1.49 2002/04/12 10:10:18 swa Exp $<BR></P
+>$Id: faq.sgml,v 1.47 2002/04/10 04:05:32 hal9 Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><DL
><DT
>8.1. <A
-HREF="copyright.html#AEN720"
+HREF="copyright.html#AEN722"
>Copyright</A
></DT
><DT
>8.2. <A
-HREF="copyright.html#AEN727"
+HREF="copyright.html#AEN729"
>History</A
></DT
></DL
><P
> If you have version 2.0.2, then the equivalent is
http://example.com/show-proxy-args (but you get far less information, and
- you should really consider upgrading to 2.9.14).</P
+ you should really consider upgrading to 2.9.13).</P
></DIV
><DIV
CLASS="SECT2"
></DT
><DT
><A
-HREF="#MOREINFO"
->More info</A
+HREF="#MOREINFOS"
+>More infos</A
></DT
><DT
><A
></DT
><DT
><A
-HREF="#AEN95"
+HREF="#AEN94"
>Copyright</A
></DT
><DT
><A
-HREF="#AEN102"
+HREF="#AEN101"
>History</A
></DT
></DL
><HR><H1
CLASS="SECT1"
><A
-NAME="MOREINFO"
->More info</A
+NAME="MOREINFOS"
+>More infos</A
></H1
><P
><P
><P
CLASS="LITERALLAYOUT"
> <A
-HREF="team/index.html"
-TARGET="_top"
->Pictures of the Privoxy Team</A
-><br>
- </P
-></LI
-><LI
-><P
-CLASS="LITERALLAYOUT"
-> <A
HREF="developer-manual/index.html"
TARGET="_top"
>Developer Manual</A
><LI
><P
CLASS="LITERALLAYOUT"
->Use the Sourceforge Support Forum to get help:<br>
+> Use the Sourceforge Support Forum to get help:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=211118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit bugs only through our Sourceforge Bug Forum:<br>
+> Submit bugs only through our Sourceforge Bug Forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=111118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit feature requests only through our Sourceforge feature request forum:<br>
+> Submit feature requests only through our Sourceforge feature request forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"
><LI
><P
CLASS="LITERALLAYOUT"
->You can also send feedback on websites that Privoxy has problems with. Please bookmark<br>
-the following link: <A
+> Submit missed ads and banners, and incorrectly blocked images, popups, etc:<br>
+ <br>
+ <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>, and select <A
HREF="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());"
TARGET="_top"
><SPAN
CLASS="QUOTE"
->"Privoxy - Submit Filter Feedback"</SPAN
+>"actions file feedback system"</SPAN
></A
->. Once you surf to a page with problems, use the<br>
-bookmark to send us feedback. We will look into the issue as soon as possible.<br>
+><br>
</P
+><P
+> This page can also be reached from many of the internal CGI pages.
+ </P
></LI
><LI
><P
CLASS="LITERALLAYOUT"
->For any other issues, feel free to use the mailing lists:<br>
+> For any other issues, feel free to use the mailing lists:<br>
<br>
<A
HREF="http://sourceforge.net/mail/?group_id=11118"
><P
> Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
</P
></LI
></UL
><HR><H1
CLASS="SECT1"
><A
-NAME="AEN95"
+NAME="AEN94"
>Copyright</A
></H1
><P
><HR><H1
CLASS="SECT1"
><A
-NAME="AEN102"
+NAME="AEN101"
>History</A
></H1
><P
+++ /dev/null
-<html>\r
-<head>\r
-\r
-<meta http-equiv="Content-Type"content="text/html; charset=iso-8859-1">\r
-<meta name="GENERATOR" content="IrfanView">\r
-\r
-<title>Privoxy - Team page</title>\r
-<LINK\r
-REL="STYLESHEET"\r
-TYPE="text/css"\r
-HREF="../p_web.css">\r
-<meta name="description" content="Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.">\r
-<meta name="MSSmartTagsPreventParsing" content="TRUE">\r
-</HEAD>\r
-<center>\r
-<h1>Privoxy - Team page</h1>\r
-<hr>\r
-\r
-<TABLE>\r
-\r
-\r
-<TR>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="01stefanw.jpg" target="ImageWindow">\r
-<IMG SRC="01stefanw_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="01stefanw.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="02jon.jpg" target="ImageWindow">\r
-<IMG SRC="02jon_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="02jon.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="03andreas.jpg" target="ImageWindow">\r
-<IMG SRC="03andreas_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="03andreas.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="04rodney.jpg" target="ImageWindow">\r
-<IMG SRC="04rodney_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="04rodney.jpg"></A></FONT></TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="05david.jpg" target="ImageWindow">\r
-<IMG SRC="05david_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="05david.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="06member.jpg" target="ImageWindow">\r
-<IMG SRC="06member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="06member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="07member.jpg" target="ImageWindow">\r
-<IMG SRC="07member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="07member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="08member.jpg" target="ImageWindow">\r
-<IMG SRC="08member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="08member.jpg"></A></FONT></TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="09member.jpg" target="ImageWindow">\r
-<IMG SRC="09member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="09member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="10member.jpg" target="ImageWindow">\r
-<IMG SRC="10member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="10member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="11member.jpg" target="ImageWindow">\r
-<IMG SRC="11member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="11member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="12member.jpg" target="ImageWindow">\r
-<IMG SRC="12member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="12member.jpg"></A></FONT></TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="13member.jpg" target="ImageWindow">\r
-<IMG SRC="13member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="13member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="14member.jpg" target="ImageWindow">\r
-<IMG SRC="14member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="14member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="15member.jpg" target="ImageWindow">\r
-<IMG SRC="15member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="15member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="16member.jpg" target="ImageWindow">\r
-<IMG SRC="16member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="16member.jpg"></A></FONT></TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="17member.jpg" target="ImageWindow">\r
-<IMG SRC="17member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="17member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="18member.jpg" target="ImageWindow">\r
-<IMG SRC="18member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="18member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="19member.jpg" target="ImageWindow">\r
-<IMG SRC="19member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="19member.jpg"></A></FONT></TD>\r
-<TD ALIGN=CENTER VALIGN=BOTTOM><FONT face="Verdana, Arial, Helvetica, Sans-Serif" size="-2"><A HREF="20member.jpg" target="ImageWindow">\r
-<IMG SRC="20member_t.jpg" WIDTH="80" HEIGHT="80" BORDER="0" ALT="20member.jpg"></A></FONT></TD>\r
-</TR>\r
-\r
-</TABLE>\r
-\r
-<hr>\r
-<b><A HREF="http://www.irfanview.com">Created by IrfanView</A></b>\r
-</center>\r
-</body>\r
-</html>\r
><H2
CLASS="SECT2"
><A
-NAME="AEN1602"
+NAME="AEN1613"
>9.2. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
Privoxy main page:
</P
><A
-NAME="AEN1617"
+NAME="AEN1628"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show information about the current configuration:
</P
><A
-NAME="AEN1624"
+NAME="AEN1635"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show the source code version numbers:
</P
><A
-NAME="AEN1629"
+NAME="AEN1640"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show the client's request headers:
</P
><A
-NAME="AEN1634"
+NAME="AEN1645"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Show which actions apply to a URL and why:
</P
><A
-NAME="AEN1639"
+NAME="AEN1650"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
to run, but only as a pass-through proxy, with no actions taking place:
</P
><A
-NAME="AEN1645"
+NAME="AEN1656"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
> Short cuts. Turn off, then on:
</P
><A
-NAME="AEN1649"
+NAME="AEN1660"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
</P
></BLOCKQUOTE
><A
-NAME="AEN1652"
+NAME="AEN1663"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
Edit the actions list file:
</P
><A
-NAME="AEN1657"
+NAME="AEN1668"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><H2
CLASS="SECT2"
><A
-NAME="AEN268"
+NAME="AEN277"
>5.1. Controlling <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><H2
CLASS="SECT2"
><A
-NAME="AEN286"
+NAME="AEN295"
>5.2. Configuration Files Overview</A
></H2
><P
><H2
CLASS="SECT2"
><A
-NAME="AEN317"
+NAME="AEN326"
>5.3. The Main Configuration File</A
></H2
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN350"
+NAME="AEN359"
>5.3.1. Defining Other Configuration Files</A
></H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN443"
+NAME="AEN452"
>5.3.2. Other Configuration Options</A
></H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN580"
+NAME="AEN589"
>5.3.3. Access Control List (ACL)</A
></H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN778"
+NAME="AEN787"
>5.3.5. Windows GUI Options</A
></H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN880"
+NAME="AEN889"
>5.4.1. URL Domain and Path Syntax</A
></H3
><P
><H3
CLASS="SECT3"
><A
-NAME="AEN956"
+NAME="AEN965"
>5.4.2. Actions</A
></H3
><P
> include:
</P
><A
-NAME="AEN1066"
+NAME="AEN1075"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><H3
CLASS="SECT3"
><A
-NAME="AEN1278"
+NAME="AEN1287"
>5.4.3. Aliases</A
></H3
><P
><H2
CLASS="SECT2"
><A
-NAME="AEN1344"
+NAME="AEN1353"
>5.6. Templates</A
></H2
><P
><LI
><P
CLASS="LITERALLAYOUT"
->Use the Sourceforge Support Forum to get help:<br>
+> Use the Sourceforge Support Forum to get help:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=211118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit bugs only through our Sourceforge Bug Forum:<br>
+> Submit bugs only through our Sourceforge Bug Forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?group_id=11118&atid=111118"
><LI
><P
CLASS="LITERALLAYOUT"
->Submit feature requests only through our Sourceforge feature request forum:<br>
+> Submit feature requests only through our Sourceforge feature request forum:<br>
<br>
<A
HREF="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse"
><LI
><P
CLASS="LITERALLAYOUT"
->You can also send feedback on websites that Privoxy has problems with. Please bookmark<br>
-the following link: <A
+> Submit missed ads and banners, and incorrectly blocked images, popups, etc:<br>
+ <br>
+ <A
+HREF="http://p.p/"
+TARGET="_top"
+>http://p.p/</A
+>, and select <A
HREF="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());"
TARGET="_top"
><SPAN
CLASS="QUOTE"
->"Privoxy - Submit Filter Feedback"</SPAN
+>"actions file feedback system"</SPAN
></A
->. Once you surf to a page with problems, use the<br>
-bookmark to send us feedback. We will look into the issue as soon as possible.<br>
+><br>
</P
+><P
+> This page can also be reached from many of the internal CGI pages.
+ </P
></LI
><LI
><P
CLASS="LITERALLAYOUT"
->For any other issues, feel free to use the mailing lists:<br>
+> For any other issues, feel free to use the mailing lists:<br>
<br>
<A
HREF="http://sourceforge.net/mail/?group_id=11118"
><P
> Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available, too.
+ available too.
</P
></LI
></UL
><H2
CLASS="SECT2"
><A
-NAME="AEN1394"
+NAME="AEN1405"
>7.1. Copyright</A
></H2
><P
></DIV
><P
CLASS="PUBDATE"
->$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $<BR></P
+>$Id: user-manual.sgml,v 1.73 2002/04/10 18:45:15 swa Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><DL
><DT
>4.1. <A
-HREF="quickstart.html#AEN223"
+HREF="quickstart.html#AEN232"
>Command Line Options</A
></DT
></DL
><DL
><DT
>5.1. <A
-HREF="configuration.html#AEN268"
+HREF="configuration.html#AEN277"
>Controlling <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>5.2. <A
-HREF="configuration.html#AEN286"
+HREF="configuration.html#AEN295"
>Configuration Files Overview</A
></DT
><DT
>5.3. <A
-HREF="configuration.html#AEN317"
+HREF="configuration.html#AEN326"
>The Main Configuration File</A
></DT
><DD
><DL
><DT
>5.3.1. <A
-HREF="configuration.html#AEN350"
+HREF="configuration.html#AEN359"
>Defining Other Configuration Files</A
></DT
><DT
>5.3.2. <A
-HREF="configuration.html#AEN443"
+HREF="configuration.html#AEN452"
>Other Configuration Options</A
></DT
><DT
>5.3.3. <A
-HREF="configuration.html#AEN580"
+HREF="configuration.html#AEN589"
>Access Control List (ACL)</A
></DT
><DT
></DT
><DT
>5.3.5. <A
-HREF="configuration.html#AEN778"
+HREF="configuration.html#AEN787"
>Windows GUI Options</A
></DT
></DL
><DL
><DT
>5.4.1. <A
-HREF="configuration.html#AEN880"
+HREF="configuration.html#AEN889"
>URL Domain and Path Syntax</A
></DT
><DT
>5.4.2. <A
-HREF="configuration.html#AEN956"
+HREF="configuration.html#AEN965"
>Actions</A
></DT
><DT
>5.4.3. <A
-HREF="configuration.html#AEN1278"
+HREF="configuration.html#AEN1287"
>Aliases</A
></DT
></DL
></DT
><DT
>5.6. <A
-HREF="configuration.html#AEN1344"
+HREF="configuration.html#AEN1353"
>Templates</A
></DT
></DL
><DL
><DT
>7.1. <A
-HREF="copyright.html#AEN1394"
+HREF="copyright.html#AEN1405"
>Copyright</A
></DT
><DT
></DT
><DT
>9.2. <A
-HREF="appendix.html#AEN1602"
+HREF="appendix.html#AEN1613"
><SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>Privoxy</SPAN
>
into will contain all of the configuration files.</P
+><P
+> If you would like to build binary images on OS/2 yourself, you will need
+ a few Unix-like tools: autoconf, autoheader and sh. These tools will be
+ used to create the required config.h file, which is not part of the
+ source distribution because it differs based on platform. You will also
+ need a compiler.
+ The distribution has been created using IBM VisualAge compilers, but you
+ can use any compiler you like. GCC/EMX has the disadvantage of needing
+ to be single-threaded due to a limitation of EMX's implementation of the
+ <TT
+CLASS="FUNCTION"
+>select()</TT
+> socket call.</P
+><P
+> In addition to needing the source code distribution as outlined earlier,
+ you will want to extract the <TT
+CLASS="FILENAME"
+>os2seutp</TT
+> directory from CVS:
+ <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
+ </PRE
+></TD
+></TR
+></TABLE
+>
+ This will create a directory named os2setup/, which will contain the
+ <TT
+CLASS="FILENAME"
+>Makefile.vac</TT
+> makefile and <TT
+CLASS="FILENAME"
+>os2build.cmd</TT
+>
+ which is used to completely create the binary distribution. The sequence
+ of events for building the executable for yourself goes something like this:
+ <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> cd current
+ autoheader
+ autoconf
+ sh configure
+ cd ..\os2setup
+ nmake -f Makefile.vac
+ </PRE
+></TD
+></TR
+></TABLE
+>
+ You will see this sequence laid out in <TT
+CLASS="FILENAME"
+>os2build.cmd</TT
+>.</P
></DIV
><DIV
CLASS="SECT3"
><H2
CLASS="SECT2"
><A
-NAME="AEN223"
+NAME="AEN232"
>4.1. Command Line Options</A
></H2
><P
-# $Id: privoxy-rh.spec,v 1.24 2002/04/11 10:09:20 oes Exp $
+# $Id: privoxy-rh.spec,v 1.23 2002/04/10 18:14:45 morcego Exp $
#
# Written by and Copyright (C) 2001 the SourceForge
# Privoxy team. http://www.privoxy.org/
%build
autoheader
autoconf
-%configure --disable-dynamic-pcre
+%configure
make
# Docs are in CVS and tarball now.
#%%make dok
%{_mandir}/man1/%{name}.*
%changelog
-* Tue Apr 16 2002 Hal Burgiss <hal@foobox.net>
-+ privoxy-2.9.13-6
-- Add --disable-dynamic-pcre to configure.
-
* Wed Apr 10 2002 Rodrigo Barbosa <rodrigob@tisbrasil.com.br>
+ privoxy-2.9.13-5
- Relisting template files on the %%files section
additional "-r @" flag.
# $Log: privoxy-rh.spec,v $
-# Revision 1.24 2002/04/11 10:09:20 oes
-# Version 2.9.14
-#
# Revision 1.23 2002/04/10 18:14:45 morcego
# - (privoxy-rh.spec only) Relisting template files on the %%files section
# - (configure.in, privoxy-rh.spec) Bumped package release to 5
-# $Id: privoxy-suse.spec,v 1.14 2002/04/11 17:57:40 oes Exp $
+# $Id: privoxy-suse.spec,v 1.12 2002/04/09 13:29:43 swa Exp $
#
# Written by and Copyright (C) 2001 the SourceForge
# Privoxy team. http://www.privoxy.org/
# This program is distributed in the hope that it will
# be useful, but WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A
-# PARTICULAR PURPOSE. See the GNU General Public
+# PARTICULAR PURPOSE. See the GNU General Public
# License for more details.
#
# The GNU General Public License should be included with
#
# do not set to %{name}
-%define privoxyconf %{_sysconfdir}/privoxy
+%define ijbconf %{_sysconfdir}/privoxy
Summary: Privoxy - privacy enhancing proxy
Vendor: http://www.privoxy.org
Distribution: defineme
Version: 2.9.14
Release: 1
-# Needs makefile change: Source: http://prdownloads.sourceforge.net/ijbswa/privoxy-%{version}-%{status}-src.tar.gz
-Source: http://prdownloads.sourceforge.net/ijbswa/privoxy-%{version}.tar.gz
+Source: http://www.waldherr.org/%{name}/privoxy-%{version}.tar.gz
# not sure if this works
BuildRoot: %{_tmppath}/%{name}-%{version}-root
Packager: Stefan Waldherr <stefan@waldherr.org>
Copyright: GPL
Group: Networking/Utilities
URL: http://www.privoxy.org/
+Provides: privoxy
+Obsoletes: privoxy
Autoreqprov: on
BuildRequires: perl gzip libtool autoconf
-Conflicts: junkbuster-raw junkbuster-blank junkbuster-suse junkbuster privoxy
+Conflicts: junkbuster-raw junkbuster-blank junkbuster
#
# -----------------------------------------------------------------------------
%build
autoheader
autoconf
-./configure --disable-dynamic-pcre
+./configure
make
mkdir -p ${RPM_BUILD_ROOT}%{_sbindir} \
${RPM_BUILD_ROOT}%{_mandir}/man8 \
${RPM_BUILD_ROOT}/var/log/privoxy \
- ${RPM_BUILD_ROOT}%{privoxyconf}/templates \
+ ${RPM_BUILD_ROOT}%{ijbconf}/templates \
${RPM_BUILD_ROOT}%{_sysconfdir}/logrotate.d \
${RPM_BUILD_ROOT}%{_sysconfdir}/init.d
gzip README AUTHORS ChangeLog privoxy.1 LICENSE || /bin/true
install -s -m 744 privoxy $RPM_BUILD_ROOT%{_sbindir}/privoxy
cp -f privoxy.1.gz $RPM_BUILD_ROOT%{_mandir}/man8/privoxy.8.gz
-cp -f *.action $RPM_BUILD_ROOT%{privoxyconf}/
-cp -f default.filter $RPM_BUILD_ROOT%{privoxyconf}/default.filter
-cp -f trust $RPM_BUILD_ROOT%{privoxyconf}/trust
-cp -f templates/* $RPM_BUILD_ROOT%{privoxyconf}/templates/
+cp -f *.action $RPM_BUILD_ROOT%{ijbconf}/
+cp -f default.filter $RPM_BUILD_ROOT%{ijbconf}/default.filter
+cp -f trust $RPM_BUILD_ROOT%{ijbconf}/trust
+cp -f templates/* $RPM_BUILD_ROOT%{ijbconf}/templates/
cp -f privoxy.logrotate $RPM_BUILD_ROOT%{_sysconfdir}/logrotate.d/privoxy
install -m 755 privoxy.init.suse $RPM_BUILD_ROOT%{_sysconfdir}/init.d/privoxy
install -m 711 -d $RPM_BUILD_ROOT/var/log/privoxy
# sed 's/^forward.*/forward \/etc\/privoxy\/forward/g' | \
# sed 's/^aclfile.*/aclfile \/etc\/privoxy\/aclfile/g' > \
sed 's/^logdir.*/logdir \/var\/log\/privoxy/g' > \
- $RPM_BUILD_ROOT%{privoxyconf}/config
+ $RPM_BUILD_ROOT%{ijbconf}/config
#
# -----------------------------------------------------------------------------
%doc doc/webserver/p_web.css
%doc doc/webserver/index.html
#%doc privoxy.weekly privoxy.monthly AUTHORS
-%dir %{privoxyconf}
-%config %{privoxyconf}/*
+%dir %{ijbconf}
+%config %{ijbconf}/*
%attr(0744,privoxy,privoxy) %dir /var/log/privoxy
%config %{_sysconfdir}/logrotate.d/privoxy
%attr(0755,root,root)/usr/sbin/privoxy
- new package: version 2.0
# $Log: privoxy-suse.spec,v $
-# Revision 1.14 2002/04/11 17:57:40 oes
-# Fixed(?) Conflicts: Provides: Obsoletes:
-#
-# Revision 1.13 2002/04/11 10:09:20 oes
-# Version 2.9.14
-#
# Revision 1.12 2002/04/09 13:29:43 swa
# build suse and gen-dist with html docs. do not generate docs while building rpm
#
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "PRIVOXY" "1" "11 April 2002" "Privoxy 2.9.14 beta" ""
+.TH "PRIVOXY" "1" "10 April 2002" "Privoxy 2.9.14 beta" ""
.SH NAME
privoxy \- Privacy Enhancing Proxy
.SH SYNOPSIS
leader, don't detach from controlling tty, and do all logging there.
.TP
\fB--pidfile \fIpidfile\fB\fR
-On startup, write the process ID to \fIpidfile\fR.
-Delete the \fIpidfile\fR on exit.
-Failiure to create or delete the \fIpidfile\fR
-is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
+After (optionally) writing the PID file, assume the user ID of user
+and the GID of group, or, if the optional group was not given, the
+default group of user. Exit if the privileges are not sufficient to
+do so.
.TP
\fB--user \fIuser[.group]\fB\fR
After (optionally) writing the PID file, assume the user ID of
#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
-#define PROJECT_H_VERSION "$Id: project.h,v 1.65 2002/04/04 00:36:36 gliptak Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.64 2002/04/03 22:28:03 gliptak Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Revisions :
* $Log: project.h,v $
- * Revision 1.65 2002/04/04 00:36:36 gliptak
- * always use pcre for matching
- *
* Revision 1.64 2002/04/03 22:28:03 gliptak
* Removed references to gnu_regex
*
int debug;
int multi_threaded;
- /* Features that can be enabled/disabled through the config file */
+ /* Features that can be enabled/disabled throuigh the config file */
unsigned feature_flags;
const char *logfile;
</p>
<ul>
<li>
- use the <a href="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</a> to get help.
+ use the <a href="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</a> or (better) the
+ <a href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a> to get help.
</li>
<li>
submit banners and all problems with the actions file only through the
- <a href="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(1;''.concat('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
+ <a href="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</a>.
</li>
<li>
-CHUNK: ASSIGNED TO: RUN1: RUN2:
------------------------------------------------------------------------------
+CHUNK: ASSIGNED TO: RUN1: RUN2:
+---------------------------------------------------------------------
testdrive-intl-aa
testdrive-intl-ab
-testdrive-intl-ac Clifford Caoile <piyokun@email.com>
+testdrive-intl-ac
testdrive-intl-ad
-testdrive-intl-ae bokeh <bokeh@lycos.co.uk>
+testdrive-intl-ae
testdrive-intl-af
testdrive-intl-ag
testdrive-intl-ah
-testdrive-intl-ai swa 1.2
-testdrive-intl-aj swa 1.2
-testdrive-intl-ak swa 1.2
+testdrive-intl-ai swa x
+testdrive-intl-aj
+testdrive-intl-ak
testdrive-unstable
-testdrive-us-aa maynard.o@discourse.mentabolism.org 1.2
-testdrive-us-ab Eugene Wood <gene_wood@yahoo.com>
+testdrive-us-aa
+testdrive-us-ab
testdrive-us-ac
-testdrive-us-ad Hal 1.2
-testdrive-us-ae Hal
+testdrive-us-ad Hal x
+testdrive-us-ae
testdrive-us-af
testdrive-us-ag
testdrive-us-ah
projects / privoxy.git / commitdiff
