From b8eb89aed72327a3c2a59ff283613a5d7459b14c Mon Sep 17 00:00:00 2001 From: hal9 Date: Sun, 26 May 2002 17:04:25 +0000 Subject: [PATCH] -Spellcheck, very minor edits, and sync across branches --- doc/source/contacting.sgml | 9 +-- doc/source/developer-manual.sgml | 106 +++++++++++++++++++------------ doc/source/p-authors.sgml | 3 +- doc/source/privoxy-man-page.sgml | 17 +++-- doc/source/readme.sgml | 30 +++++---- doc/source/supported.sgml | 4 +- doc/source/user-manual.sgml | 30 +++++---- 7 files changed, 117 insertions(+), 82 deletions(-) diff --git a/doc/source/contacting.sgml b/doc/source/contacting.sgml index d677c139..8789ce54 100644 --- a/doc/source/contacting.sgml +++ b/doc/source/contacting.sgml @@ -1,9 +1,9 @@ @@ -57,7 +58,7 @@ Before doing so, please make sure that the bug has not already been submitted - and observe the aditional hints at the top of the submit form. @@ -112,7 +113,7 @@ For any other issues, feel free to use the mailing lists. Technically interested users and people who wish to contribute to the project are also welcome on the developers list! -You can find an overview of all Prixoxy-related mailing lists, +You can find an overview of all Privoxy-related mailing lists, including list archives, at: http://sourceforge.net/mail/?group_id=11118. diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index ee2b9b68..20777007 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -8,8 +8,8 @@ - - + + @@ -23,7 +23,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $ + $Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -50,7 +50,7 @@ - $Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $ + $Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $ ource$ @@ -1787,7 +1787,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46 2002/05/22 17:15:00 oes Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.48 2002/05/26 12:48:31 roro Exp $" /********************************************************************* * * File : $Source$ @@ -1932,7 +1932,7 @@ at sourceforge. Three simple steps: intelligent (keep it short and precise). - Do not mail to the mailinglist (we cannot keep track on issues there). + Do not mail to the mailing list (we cannot keep track on issues there). @@ -1981,12 +1981,12 @@ at sourceforge. Three simple steps: Y, the version minor, represents the branch within the major version. At any point in time, there are two branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is - being added and only bugfixes are made, and 2N+1, the development branch, in + being added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of Privoxy takes place. This enables us to turn the code upside down and inside out, while at the same time providing and maintaining a stable version. - The minor is reset to zero (and one) when the major is inrcemented. When a development + The minor is reset to zero (and one) when the major is incremented. When a development branch has matured to the point where it can be turned into stable, the old stable branch 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the new stable branch 2N+2, and a new development branch 2N+3 is opened. @@ -2146,22 +2146,22 @@ at sourceforge. Three simple steps: - LICENSE (toplevel directory) + LICENSE (top-level directory) - README (toplevel directory) + README (top-level directory) - AUTHORS (toplevel directory) + AUTHORS (top-level directory) - man page (toplevel directory, Unix-like + man page (top-level directory, Unix-like platforms only) @@ -2177,8 +2177,8 @@ at sourceforge. Three simple steps: Also suggested: Developer Manual - (doc/webserver/devel-manual) and ChangeLog - (toplevel directory). FAQ and the manuals are + (doc/webserver/developer-manual) and ChangeLog + (top-level directory). FAQ and the manuals are HTML docs. There are also text versions in doc/text/ which could conceivably also be included. @@ -2446,30 +2446,46 @@ at sourceforge. Three simple steps: Debian - First, make sure that you have freshly exported the + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then add a log entry to debian/changelog, if it is not already there, for example by running: - - - - debchange -v &p-version;-&p-status;-1 "New upstream version" - - - - After this simply run - - - - dpkg-buildpackage -rfakeroot -us -uc -b - - - - This will create - ../privoxy_&p-version;-&p-status;-1_i386.deb - which can be uploaded. - + + + + debchange -v &p-version;-&p-status;-1 "New upstream version" + + + + After this simply run + + + + dpkg-buildpackage -rfakeroot -us -uc -b + + + + This will create + ../privoxy_&p-version;-&p-status;-1_i386.deb + which can be uploaded. + + + Then, run: + + + + make debian-dist + + + + To upload the package to Sourceforge, simply issue + + + + make debian-upload + + Mac OSX @@ -2519,7 +2535,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg FreeBSD - Login to Sourceforge's compilefarm via ssh: + Login to Sourceforge's compile-farm via ssh: @@ -2702,7 +2718,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Update the Webserver When updating the webserver, please follow these steps to make - sure that no broken links, incosistent contents or permission + sure that no broken links, inconsistent contents or permission problems will occur: @@ -2711,7 +2727,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - make dok # (or make redkat-dok if make dok doesn't work for you) + make dok # (or make redhat-dok if make dok doesn't work for you) @@ -2812,6 +2828,12 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.48 2002/05/26 12:48:31 roro + Add releasing information about Debian. + + Revision 1.47 2002/05/26 04:55:11 mal0rd + Added debian-dist and debian-upload targets. Also documented usage. + Revision 1.46 2002/05/22 17:15:00 oes Updated intro diff --git a/doc/source/p-authors.sgml b/doc/source/p-authors.sgml index 8d1c2d5a..c03091e2 100644 --- a/doc/source/p-authors.sgml +++ b/doc/source/p-authors.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: p-authors.sgml,v 1.7 2002/05/24 03:06:48 hal9 Exp $ + $Id: p-authors.sgml,v 1.8 2002/05/25 15:40:20 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -50,6 +50,7 @@ Gábor Lipták Guy Haroon Rafique + Roland Rosenfeld David Schmidt (OS/2, Mac OSX ports) Joerg Strohmayer Sarantis Paskalis diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index 026f511e..51d799a2 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,7 +5,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 1.12 2002/05/10 01:48:20 hal9 Exp $ + $Id: privoxy-man-page.sgml,v 1.13 2002/05/25 22:32:54 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -215,17 +215,20 @@ The name and number of configuration files has changed from previous - versions, and is subject to change as development progresses. In fact, the - configuration itself is changed and much more sophisticated. See the - user-manual for a - complete explanation of all configuration options and general usage. + versions. In fact, the configuration itself is changed and much more + sophisticated. See the user-manual for a complete + explanation of all configuration options and general usage, and notes for + upgrading from Junkbuster and earlier Privoxy + versions. The actions list (ad blocks, etc) can also be configured with your web browser at http://config.privoxy.org/. Privoxy's configuration parameters can also be viewed at the same page. In addition, Privoxy can be toggled on/off. - This is an internal page. + This is an internal page, and does not require Internet access. @@ -383,7 +386,7 @@ all features are well tested. ]]> - Please see the user-manual on how to contact the + Please see the User Manual on how to contact the developers for feature requests, reporting problems, and other questions. diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 0970d429..a8bba794 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -17,7 +17,7 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $ + $Id: readme.sgml,v 1.15 2002/05/10 01:48:20 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -158,7 +158,8 @@ USER[.GROUP]] [config_file] - See the man page or user-manual for a brief explanation of each option. + See the man page or User Manual for an explanation of each option, and + other configuration and usage issues. If no config_file is specified on the command line, Privoxy will look for a @@ -166,24 +167,27 @@ for 'config.txt'). If no config_file is found, Privoxy will fail to start. - Or for Red Hat: /etc/rc.d/init.d/privoxy start + Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start Or for SuSE: /etc/rc.d/privoxy start + + Or Debian: /etc/init.d/privoxy start + CONFIGURATION See: 'config', 'default.action', 'user.action', and 'default.filter'. - 'user.action' is for personal configuration. These are all well commented. - Most of the magic is in '*.action' files. 'user.action' should be - used for any actions customizations. On Unix-like systems, these files - are installed in /etc/privoxy. On Windows, then wherever the executable - itself is installed. There are many significant changes and advances since - Junkbuster v2.0.x. The user-manual has a run down of configuration options, - and examples: http://www.privoxy.org/user-manual/. + 'user.action' is for personal and local configuration preferences. These are + all well commented. Most of the magic is in '*.action' files. 'user.action' + should be used for any actions customizations. On Unix-like systems, these + files are installed in /etc/privoxy. On Windows, then wherever the + executable itself is installed. There are many significant changes and + advances since Junkbuster v2.0.x. The User Manual has an explanation of + all configuration options, and examples: http://www.privoxy.org/user-manual/. Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or @@ -206,8 +210,8 @@ DOCUMENTATION There should be documentation in the 'doc' subdirectory. In particular, see the user-manual there, - the faq, and those interested in Privoxy development, should look at + is not completed at this point]]>. In particular, see the User Manual there, + the FAQ, and those interested in Privoxy development, should look at developer-manual. @@ -238,7 +242,7 @@ - + diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml index 072b815e..8f6fb32e 100644 --- a/doc/source/supported.sgml +++ b/doc/source/supported.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: supported.sgml,v 1.9 2002/05/10 01:48:20 hal9 Exp $ + $Id: supported.sgml,v 1.10 2002/05/22 17:16:05 oes Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -24,7 +24,7 @@ --> At present, Privoxy is known to run on - Windows(95, 98, ME, 2000, XP), Linux (RedHat, Suse, Debian, Conectiva), + Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva), Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and many more flavors of Unix. diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 60ab2810..7fdf0388 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -30,7 +30,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.122 2002/05/24 13:24:08 oes Exp $ + $Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -56,7 +56,7 @@ -$Id: user-manual.sgml,v 1.122 2002/05/24 13:24:08 oes Exp $ +$Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $