X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fbuildsource.sgml;h=b498a893d81c6ae089b8165eb3452dd4b5863103;hp=994d4953bd1a705fc929a666d418822edc4a07a2;hb=7a99a61ab1a3ce0401821aedcd06eba19a698b2a;hpb=efba502b2f83dd3a28c79b8807e1834153219b74 diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index 994d4953..b498a893 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -2,27 +2,27 @@ File : $Source: /cvsroot/ijbswa/current/doc/source/buildsource.sgml,v $ Purpose : Entity included in other project documents. - - $Id: buildsource.sgml,v 2.9 2006/09/22 10:38:05 hal9 Exp $ - Copyright (C) 2001-2006 Privoxy Developers http://privoxy.org + $Id: buildsource.sgml,v 2.19 2011/09/04 11:10:12 fabiankeil Exp $ + + Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ See LICENSE. ====================================================================== This file used for inclusion with other documents only. ====================================================================== - If you make changes to this file, please verify the finished + If you make changes to this file, please verify the finished docs all display as intended. This file is included into: user-manual - README + INSTALL --> - To build Privoxy from source, + To build Privoxy from source, autoconf, GNU make @@ -32,24 +32,24 @@ When building from a source tarball, - first unpack the source: + tarball), +--> first unpack the source: - tar xzvf privoxy-&p-version;-src* [.tgz or .tar.gz] - cd privoxy-&p-version; + tar xzvf privoxy-&p-version;-src.tar.gz + cd privoxy-&p-version; For retrieving the current CVS sources, you'll need a CVS client installed. - Note that sources from CVS are typicially development quality, and may not be + Note that sources from CVS are typically development quality, and may not be stable, or well tested. To download CVS source, check the Sourceforge documentation, which might give commands like: @@ -63,7 +63,7 @@ - This will create a directory named current/, which will + This will create a directory named current/, which will contain the source tree. @@ -76,9 +76,12 @@ It is also strongly recommended to not run Privoxy - as root, and instead it is suggested to create a privoxy user - and group for this purpose. See your local documentation for the correct - command line to do this. + as root. You should configure/install/run Privoxy as + an unprivileged user, preferably by creating a privoxy user + and group just for this purpose. See your local documentation for the correct + command line to do add new users and groups (something like + adduser, but the command syntax may vary from platform + to platform). @@ -110,14 +113,14 @@ autoheader autoconf ./configure # (--help to see options) - make # (the make from GNU, sometimes called gmake) - su + make # (the make from GNU, sometimes called gmake) + su # Possibly required make -n install # (to see where all the files will go) make -s install # (to really install, -s to silence output) - If you have GNU make, you can have the first four steps + Using GNU make, you can have the first four steps automatically done for you by just typing: @@ -132,16 +135,16 @@ - To build an executable with security enhanced features so that - users cannot easily bypass the proxy (e.g. go there anyway, or - change their own configurations, configure like this: + To build an executable with security enhanced features so that + users cannot easily bypass the proxy (e.g. Go There Anyway), or + alter their own configurations, configure like this: ./configure --disable-toggle --disable-editor --disable-force - + -Then build as above. + Note that all of these options can also be disabled through the configuration file. WARNING: If installing as root, the install will fail @@ -158,8 +161,8 @@ Then build as above. --with-group options for setting user and group ownership of the configuration files (which need to be writable by the daemon). The specified user must already exist. When starting - Privoxy, it should be run as this same user to - insure write access to configuration and log files. + Privoxy, it must be run as this same user to + insure write access to configuration and log files! @@ -173,12 +176,13 @@ Then build as above. - The default installation path for make install is - /usr/local. This may of course be customized with - the various ./configure path options. If you are doing - a root install to anywhere else besides /usr/local, be + The default installation path for make install is + /usr/local. This may of course be customized with + the various ./configure path options. If you are doing + an install to anywhere besides /usr/local, be sure to set the appropriate paths with the correct configure options - (./configure --help). + (./configure --help). Non-privileged users must of course + have write access permissions to wherever the target installation is going. @@ -192,10 +196,10 @@ Then build as above. - If installing to /usr/local, the docs will go by default - to $prefix/share/doc. But if this directory doesn't - exist, it will then try $prefix/doc and install there before - creating a new $prefix/share/doc just for + If installing to /usr/local, the documentation will go + by default to $prefix/share/doc. But if this directory + doesn't exist, it will then try $prefix/doc and install + there before creating a new $prefix/share/doc just for Privoxy. @@ -204,44 +208,48 @@ Then build as above. localstatedir (ie: var/) will default to /var instead of $prefix/var so the logs will go to /var/log/privoxy/, and the pid file - will be created in /var/run/privoxy.pid. + will be created in /var/run/privoxy.pid. - make install will attempt to set the correct values - in config (main configuration file). You may want - to check this to make sure all values are correct. If appropriate, - an init script will be installed, but it is up to the user to determine - how and where to start Privoxy. The init + make install will attempt to set the correct values + in config (main configuration file). You should + check this to make sure all values are correct. If appropriate, + an init script will be installed, but it is up to the user to determine + how and where to start Privoxy. The init script should be checked for correct paths and values, if anything other than a default install is done. - If install finds previous versions of any local configuration files, these - will not be overwritten, and the new ones will be installed with a - new extension. default.action, default.filter, and - standard.action will be overwritten. You will then need to manually update - the other installed configuration files as needed. All template files will be - overwritten. If you have customized, local templates, you should save these - first. If a previous version of Privoxy is - already running, you will have to restart it manually. + If install finds previous versions of local configuration files, most of + these will not be overwritten, and the new ones will be installed with a + new extension. default.action and default.filter + will be overwritten. You will then need + to manually update the other installed configuration files as needed. The + default template files will be overwritten. If you have + customized, local templates, these should be stored safely in a separate + directory and defined in config by the + templdir directive. It is of course wise to always back-up any + important configuration files just in case. If a previous + version of Privoxy is already running, you will + have to restart it manually. For more detailed instructions on how to build Redhat RPMs, Windows self-extracting installers, building on platforms with special requirements etc, please consult the developer manual. + url="http://www.privoxy.org/developer-manual/newrelease.html">developer manual. - The simplest command line to start Privoxy is - $path/privoxy --user=privoxy $path/etc/privoxy/config. - See privoxy --usage, or the man page, for other options, + The simplest command line to start Privoxy is + $path/privoxy --user=privoxy $path/etc/privoxy/config. + See privoxy --usage, or the man page, for other options, and configuration. ]]>