# 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
$(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
#############################################################################
# $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)
#
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 <developers@privoxy.org>
See LICENSE.
This file is included into:
user-manual
- README
INSTALL
-->
</para>
<para>
- Then, in either case, to build from unpacked tarball or CVS source:
+ You can also check out any <application>Privoxy</application>
+ <quote>branch</quote>, just exchange the <application>current</application>
+ name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
+ tree).
+</para>
+
+<para>
+ It is also recommended to not run <application>Privoxy</application> as
+ root, and instead it is suggested to create a <quote>privoxy</quote> user for
+ this purpose.
+</para>
+
+<para>
+ <filename>/etc/passwd</filename> might then look like:
+</para>
+
+<para>
+ <screen> privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</screen>
+</para>
+
+<para>
+ And then <filename>/etc/group</filename>, like:
+</para>
+
+<para>
+ <screen> privoxy:*:7777:privoxy</screen>
+</para>
+
+<para>
+ Then, to build from either unpacked tarball or CVS source:
</para>
<para>
</warning>
<para>
- If you have gnu make, you can have the first four steps
+ If you have GNU <command>make</command>, you can have the first four steps
automatically done for you by just typing:
</para>
</para>
<!-- print for README only -->
+<!-- Actually this is now in INSTALL -->
<![%p-readme;[
<para>
- For binary RPM installation, and other platforms, see the user-manual
+ For binary RPM installation, and other platforms, see the User Manual
as well.
</para>
]]>
--- /dev/null
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!entity % dummy "IGNORE">
+<!entity buildsource SYSTEM "buildsource.sgml">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-stable "IGNORE">
+<!entity % p-not-stable "IGNORE"> <!-- beta or alpha -->
+<!entity % p-alpha "IGNORE">
+<!entity % p-beta "IGNORE">
+<!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
+<!entity % p-doc "IGNORE"> <!-- and never a text doc -->
+<!entity % p-readme "INCLUDE"> <!-- This is now in INSTALL -->
+]>
+<!--
+ File : $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $
+
+ Purpose : INSTALL file for Privoxy
+
+ $Id: install.sgml,v .0 2002/09/05 17:58:29 hal9 Exp $
+
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
+
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching
+ 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!
+ ========================================================================
+
+ ===================================================================
+ READ: Document Note: This file generates the INSTALL file in the top level
+ source directory. It is generated as only a plain text file. The current
+ markup is not suitable for other formats. Build from Makefile with 'make
+ dok-readme'.
+ ===================================================================
+
+ READ:
+
+ ======================================================================
+ NOTE: The left margin spacing is *important* when using 'literallayout'
+ WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
+ the para tag forces a linebreak. Tags need to be carefully placed as a result
+ to avoid extra blank lines, etc.
+ ======================================================================
+
+ For stable releases, change
+
+ entity % p-not-stable "INCLUDE"
+
+ to
+
+ entity % p-not-stable "IGNORE"
+
+ in the DTD at the top. This will toggle various text 'off'. BOTH
+ MUST be toggled in this case or you will get both text referencing
+ stable and unstable versions. You only want one or the other!
+
+-->
+<article id="index">
+<artheader>
+<![%dummy;[
+ <para>
+ <comment>
+ 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
+ </comment>
+ </para>
+]]>
+<abstract>
+<para>
+ <literal>
+ <msgtext>
+ <literallayout>
+/*********************************************************************
+ *
+ * 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.
+ *
+ *********************************************************************/
+ </literallayout>
+ </msgtext>
+ </literal>
+</para>
+
+ </abstract>
+</artheader>
+
+<para>
+ <msgtext>
+<!-- ~~~~~ New section ~~~~~ -->
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilderplate -->
+ </msgtext>
+</para>
+
+
+</article>
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 <developers@privoxy.org>
See LICENSE.
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="install" ><title>INSTALL</title>
-<!-- include buildsource.sgml boilerplate: -->
- &buildsource;
-<!-- end boilderplate -->
+<!-- Install instructions are now in INSTALL -->
+<para>
+ See the INSTALL file in this directory, for installing from source, and
+ the User Manual, for other installation types.
+</para>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<!-- </LiteralLayout> -->
<!-- </para> -->
<!-- <para> -->
-<!-- $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 $ -->
<!-- </para> -->
</article>
projects / privoxy.git / commitdiff