From f8671e665b0d0b979873f848272f05ce7ba09161 Mon Sep 17 00:00:00 2001 From: hal9 Date: Fri, 6 Sep 2002 01:58:28 +0000 Subject: [PATCH] Create a separate INSTALL file, and remove install instructions from README. INSTALL is built from dok-readme target. --- doc/source/GNUmakefile.in | 12 +++- doc/source/buildsource.sgml | 39 +++++++++-- doc/source/install.sgml | 126 ++++++++++++++++++++++++++++++++++++ doc/source/readme.sgml | 12 ++-- 4 files changed, 176 insertions(+), 13 deletions(-) create mode 100644 doc/source/install.sgml diff --git a/doc/source/GNUmakefile.in b/doc/source/GNUmakefile.in index 9f1f3446..62161cad 100644 --- a/doc/source/GNUmakefile.in +++ b/doc/source/GNUmakefile.in @@ -1,6 +1,6 @@ # Note: Makefile is built automatically from Makefile.in # -# $Id: GNUmakefile.in,v 1.4 2002/08/08 01:02:26 hal9 Exp $ +# $Id: GNUmakefile.in,v 1.5 2002/09/05 23:12:04 hal9 Exp $ # # Location: doc/source/Makefile.in # Purpose: Build documentation @@ -155,10 +155,12 @@ dok-faq: ensure-dkprefix ensure-jadebin ensure-wdump $(RM) ../webserver/faq/*.html && cp $(DOC_TMP)/*.html ../webserver/faq/ $(DB) -V nochunks faq.sgml > tmp.html && $(WDUMP) tmp.html > ../text/faq.txt -# readme page -dok-readme: ensure-dkprefix ensure-jadebin ensure-wdump +# Build README and INSTALL files. +dok-readme: dok-release ensure-dkprefix ensure-jadebin ensure-wdump $(DB)-notoc -V nochunks readme.sgml > tmp.html &&\ $(WDUMP) tmp.html > $(ROOT)/README ;\ + $(DB)-notoc -V nochunks install.sgml > tmp.html &&\ + $(WDUMP) tmp.html > $(ROOT)/INSTALL ;\ $(RM) tmp.* # index.sgml is used to create both the Home Page, and a local index @@ -336,6 +338,10 @@ coffee: ############################################################################# # $Log: GNUmakefile.in,v $ +# Revision 1.5 2002/09/05 23:12:04 hal9 +# Updated Makefile with 3.0 changes (pdf and man targets, etc). Revise comments +# in privoxy-man-page.sgml to remove out of date comments. +# # Revision 1.4 2002/08/08 01:02:26 hal9 # Update pdf2 target to dok-shtml (for single page html) # diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index 957d54b5..db5680de 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: buildsource.sgml,v 1.9.2.1 2002/08/25 17:10:55 hal9 Exp $ + $Id: buildsource.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -18,7 +18,6 @@ This file is included into: user-manual - README INSTALL --> @@ -66,7 +65,36 @@ - Then, in either case, to build from unpacked tarball or CVS source: + You can also check out any Privoxy + branch, just exchange the current + name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs + tree). + + + + It is also recommended to not run Privoxy as + root, and instead it is suggested to create a privoxy user for + this purpose. + + + + /etc/passwd might then look like: + + + + privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell + + + + And then /etc/group, like: + + + + privoxy:*:7777:privoxy + + + + Then, to build from either unpacked tarball or CVS source: @@ -90,7 +118,7 @@ - If you have gnu make, you can have the first four steps + If you have GNU make, you can have the first four steps automatically done for you by just typing: @@ -112,9 +140,10 @@ + - For binary RPM installation, and other platforms, see the user-manual + For binary RPM installation, and other platforms, see the User Manual as well. ]]> diff --git a/doc/source/install.sgml b/doc/source/install.sgml new file mode 100644 index 00000000..7b0f8b8a --- /dev/null +++ b/doc/source/install.sgml @@ -0,0 +1,126 @@ + + + + + + + + + + + +]> + +
+ + + + This is here to keep vim syntax file from breaking :/ + If I knew enough to fix it, I would. + PLEASE DO NOT REMOVE! HB: hal@foobox.net + + +]]> + + + + + +/********************************************************************* + * + * File : $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $ + * + * Purpose : INSTALL file to help with installing from source. + * + * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge + * 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 + * + * This program is free software; you can redistribute it + * and/or modify it under the terms of the GNU General + * Public License as published by the Free Software + * Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * 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 + * License for more details. + * + * The GNU General Public License should be included with + * this file. If not, you can view it at + * http://www.gnu.org/copyleft/gpl.html + * or write to the Free Software Foundation, Inc., 59 + * Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + *********************************************************************/ + + + + + + + + + + + + + &buildsource; + + + + + +
diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 410b95c1..e97c2099 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -19,7 +19,7 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ + $Id: readme.sgml,v 2.3 2002/09/05 17:58:29 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -153,9 +153,11 @@ INSTALL - - &buildsource; - + + + See the INSTALL file in this directory, for installing from source, and + the User Manual, for other installation types. + @@ -253,7 +255,7 @@ - + -- 2.39.2