7b0f8b8a0b654e784af5b1bbe108e415ae5daa10
[privoxy.git] / doc / source / install.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "IGNORE"> 
3 <!entity buildsource SYSTEM "buildsource.sgml">
4 <!entity p-version SYSTEM "doc_version.tmp">
5 <!entity p-status SYSTEM "doc_status.tmp">
6 <!entity % p-stable "IGNORE">
7 <!entity % p-not-stable "IGNORE">  <!-- beta or alpha -->
8 <!entity % p-alpha "IGNORE">
9 <!entity % p-beta "IGNORE">
10 <!entity % p-text "INCLUDE">       <!-- define we are a text only doc    -->
11 <!entity % p-doc "IGNORE">         <!-- and never a text doc             -->
12 <!entity % p-readme "INCLUDE">     <!-- This is now in INSTALL           -->
13 ]>
14 <!--
15  File        :  $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $
16
17  Purpose     :  INSTALL file for Privoxy
18                 
19  $Id: install.sgml,v .0 2002/09/05 17:58:29 hal9 Exp $
20
21  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
22  See LICENSE.
23
24  ========================================================================
25  NOTE: Please read developer-manual/documentation.html before touching 
26  anything in this, or other Privoxy documentation. You have been warned!
27  Failure to abide by this rule will result in the revocation of your license 
28  to live a peaceful existence!
29  ========================================================================
30
31  ===================================================================
32  READ: Document Note: This file generates the INSTALL file in the top level
33  source directory. It is generated as only a plain text file. The current
34  markup is not suitable for other formats. Build from Makefile with 'make
35  dok-readme'.
36  ===================================================================
37
38  READ:
39
40  ======================================================================
41  NOTE: The left margin spacing is *important* when using 'literallayout'
42  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
43  the para tag forces a linebreak. Tags need to be carefully placed as a result
44  to avoid extra blank lines, etc. 
45  ======================================================================
46
47  For stable releases, change 
48  
49   entity % p-not-stable "INCLUDE" 
50  
51  to 
52  
53   entity % p-not-stable "IGNORE" 
54   
55  in the DTD at the top. This will toggle various text 'off'. BOTH
56  MUST be toggled in this case or you will get both text referencing 
57  stable and unstable versions. You only want one or the other!
58
59 -->
60 <article id="index">
61 <artheader>
62 <![%dummy;[
63  <para>
64  <comment>
65   This is here to keep vim syntax file from breaking :/
66   If I knew enough to fix it, I would.
67   PLEASE DO NOT REMOVE! HB: hal@foobox.net
68  </comment>
69  </para>
70 ]]>
71 <abstract>
72 <para>
73  <literal>
74   <msgtext>
75    <literallayout>
76 /*********************************************************************
77  *
78  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $
79  *
80  * Purpose     :  INSTALL file to help with installing from source.
81  *
82  * Copyright   :  Written by and Copyright (C) 2001,2002 the SourceForge
83  *                Privoxy team. http://www.privoxy.org/
84  *
85  *                Based on the Internet Junkbuster originally written
86  *                by and Copyright (C) 1997 Anonymous Coders and 
87  *                Junkbusters Corporation.  http://www.junkbusters.com
88  *
89  *                This program is free software; you can redistribute it 
90  *                and/or modify it under the terms of the GNU General
91  *                Public License as published by the Free Software
92  *                Foundation; either version 2 of the License, or (at
93  *                your option) any later version.
94  *
95  *                This program is distributed in the hope that it will
96  *                be useful, but WITHOUT ANY WARRANTY; without even the
97  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
98  *                PARTICULAR PURPOSE.  See the GNU General Public
99  *                License for more details.
100  *
101  *                The GNU General Public License should be included with
102  *                this file.  If not, you can view it at
103  *                http://www.gnu.org/copyleft/gpl.html
104  *                or write to the Free Software Foundation, Inc., 59
105  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
106  *
107  *********************************************************************/
108    </literallayout>
109   </msgtext>
110  </literal>
111 </para>
112
113  </abstract>
114 </artheader>
115
116 <para>
117  <msgtext>
118 <!--   ~~~~~       New section      ~~~~~     -->
119 <!-- include buildsource.sgml boilerplate: -->
120  &buildsource;
121 <!-- end boilderplate -->
122  </msgtext>
123 </para>
124
125
126 </article>