Privoxy|Doc/Man page

From 6520ec3e879e2fe42fa854550f13f8f11b123a25 Mon Sep 17 00:00:00 2001 From: swa Date: Sat, 30 Mar 2002 19:04:08 +0000 Subject: [PATCH] people release differently. no good. I want to make parts of the docs only. --- GNUmakefile.in | 64 +++-- doc/source/developer-manual.sgml | 447 ++++++++++++++++++++++++++++++- 2 files changed, 484 insertions(+), 27 deletions(-) diff --git a/GNUmakefile.in b/GNUmakefile.in index add32696..d7b2f8b5 100644 --- a/GNUmakefile.in +++ b/GNUmakefile.in @@ -1,6 +1,6 @@ # Note: Makefile is built automatically from Makefile.in # -# $Id: GNUmakefile.in,v 1.46 2002/03/29 20:09:01 swa Exp $ +# $Id: GNUmakefile.in,v 1.47 2002/03/30 09:05:21 swa Exp $ # # Written by and Copyright (C) 2001 the SourceForge # Privoxy team. http://www.privoxy.org/ @@ -463,24 +463,43 @@ tarball-clean: # converts doc/source/*.sgml into html, text and man pages # ############################################################################# -dok: doc/source/ldpOK.dsl man2html-swa - mkdir -p doc/text doc/man -# user manual - rm -rf doc/webserver/user-manual - cd doc/source && $(DB2HTML) -s ldpOK.dsl user-manual.sgml && mv user-manual ../webserver - cd doc/source && $(DB2HTML) -s ldpOK.dsl --nochunks user-manual.sgml > tmp.html && lynx -dump tmp.html > ../text/user-manual.txt && rm -rf tmp.html user-manual + +# our style file +doc/source/ldpOK.dsl: + if [ "$(DKPREFIX)" != "none" ]; then \ + sed -e "s@/usr/share/sgml/docbook/dsssl-stylesheets@$(DKPREFIX)@g" doc/source/ldp.dsl > doc/source/ldpOK.dsl; \ + else \ + cp doc/source/ldp.dsl doc/source/ldpOK.dsl; \ + fi + +# Otherwise we get plain groff conversion. +groff2html: + $(G2H_CMD) ./privoxy.1 > doc/webserver/man-page/privoxy-man-page.html + ## developer manual +dok-devel: doc/source/ldpOK.dsl + mkdir -p doc/text rm -rf doc/webserver/developer-manual cd doc/source && $(DB2HTML) -s ldpOK.dsl developer-manual.sgml && mv developer-manual ../webserver cd doc/source && $(DB2HTML) -s ldpOK.dsl --nochunks developer-manual.sgml > tmp.html && lynx -dump tmp.html > ../text/developer-manual.txt && rm -rf tmp.html developer-manual + +## user manual +dok-user: doc/source/ldpOK.dsl + mkdir -p doc/text + rm -rf doc/webserver/user-manual + cd doc/source && $(DB2HTML) -s ldpOK.dsl user-manual.sgml && mv user-manual ../webserver + cd doc/source && $(DB2HTML) -s ldpOK.dsl --nochunks user-manual.sgml > tmp.html && lynx -dump tmp.html > ../text/user-manual.txt && rm -rf tmp.html user-manual + ## faq +dok-faq: doc/source/ldpOK.dsl + mkdir -p doc/text rm -rf doc/webserver/faq cd doc/source && $(DB2HTML) -s ldpOK.dsl faq.sgml && mv faq ../webserver cd doc/source && $(DB2HTML) -s ldpOK.dsl --nochunks faq.sgml > tmp.html && lynx -dump tmp.html > ../text/faq.txt && rm -rf tmp.html faq -## kludge to force recreation on next run. Rodgrigo? - @rm -f doc/source/ldpOK.dsl -man2html-swa: +## man page +dok-man: doc/source/ldpOK.dsl + mkdir -p doc/man mkdir -p doc/webserver/man-page if [ "$(MAN2HTML)" != "false" ]; then \ $(ECHO) "Privoxy|Doc/Man page

NAME

" > doc/webserver/man-page/privoxy-man-page.html; \ @@ -491,6 +510,14 @@ man2html-swa: $(MAKE) groff2html; \ fi +dok: dok-devel dok-user dok-faq dok-man +## kludge to force recreation on next run. Rodgrigo? + @rm -f doc/source/ldpOK.dsl + @$(ECHO) Documentation created. + +# +# an alternative to the above dok +# redhat-dok: doc/source/ldpOK.dsl man2html mkdir -p doc/text doc/man doc/source/user-manual \ doc/source/developer-manual doc/source/faq @@ -516,14 +543,6 @@ redhat-dok: doc/source/ldpOK.dsl man2html ## kludge to force recreation on next run. Rodgrigo? @rm -f doc/source/ldpOK.dsl - -doc/source/ldpOK.dsl: - if [ "$(DKPREFIX)" != "none" ]; then \ - sed -e "s@/usr/share/sgml/docbook/dsssl-stylesheets@$(DKPREFIX)@g" doc/source/ldp.dsl > doc/source/ldpOK.dsl; \ - else \ - cp doc/source/ldp.dsl doc/source/ldpOK.dsl; \ - fi - # For those with man2html ala RH7's. man2html: mkdir -p doc/webserver/man-page @@ -534,11 +553,6 @@ man2html: $(MAKE) groff2html; \ fi -# Otherwise we get plain groff conversion. -groff2html: - $(G2H_CMD) ./privoxy.1 > doc/webserver/man-page/privoxy-man-page.html - - ############################################################################# # # Webserver @@ -666,6 +680,10 @@ install: all ## end: # $Log: GNUmakefile.in,v $ +# Revision 1.47 2002/03/30 09:05:21 swa +# better packaging. better rpm building. +# tar failed on sun (no exclude there). +# # Revision 1.46 2002/03/29 20:09:01 swa # al's patch # diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index f8516252..00c8d123 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -6,7 +6,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.12 2002/03/27 01:02:51 hal9 Exp $ + $Id: developer-manual.sgml,v 1.13 2002/03/27 01:16:41 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -20,7 +20,7 @@ Privoxy Developer Manual - $Id: developer-manual.sgml,v 1.12 2002/03/27 01:02:51 hal9 Exp $ + $Id: developer-manual.sgml,v 1.13 2002/03/27 01:16:41 hal9 Exp $ @@ -1256,7 +1256,7 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.12 2002/03/27 01:02:51 hal9 Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.13 2002/03/27 01:16:41 hal9 Exp $"; /********************************************************************* * * File : $Source$ @@ -1316,7 +1316,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.12 2002/03/27 01:02:51 hal9 Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.13 2002/03/27 01:16:41 hal9 Exp $" /********************************************************************* * * File : $Source$ @@ -1473,6 +1473,442 @@ at sourceforge. Three simple steps: + + + Releasing a new version + + To minimize trouble with distribution contents, webpage + errors and the like, I (Stefan) strongly encourage you + to follow this section if you prepare a new release of + code or new pages on the webserver. + + + The following programs are required to follow this process: + ncftpput (ncftp), scp (ssh), +gmake (GNU's version of make), ???. + + Update the webserver + + All files must be group-readable and group-writable (or no one else + will be able to change them). To update the webserver, create any + pages locally in the doc/webserver directory (or + create new directories under doc/webserver), then do + + + + make webserver + + + + Note that make dok creates + doc/webserver/user-manual, + doc/webserver/developer-manual, + doc/webserver/faq and + doc/webserver/man-page automatically. + + + Verify on the webserver that the permissions are set correctly. Do + NOT use any other means of transferring files to the webserver. + + + + SuSE or RedHat + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Update the release number + directly in the specific spec file (particularly, set the release + number to 1 if you have increased the version + number before). Run + + + + autoheader && autoconf && ./configure + + + + Then do + + + + make suse-dist or make redhat-dist + + + + To upload the package to Sourceforge, simply issue + + + + make suse-upload or make redhat-upload + + + + Goto the displayed URL and release the file publically on Sourceforge. + + + + OS/2 + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + autoheader && autoconf && ./configure + + + + Then do FIXME. + + + + Solaris + + Login to Sourceforge's compilefarm via ssh + + + + ssh cf.sourceforge.net + + + + Choose the right operating system (not the Debian one). If you have + downloaded Privoxy before, + + + + cd current && cvs update . + + + + If not, please checkout + Privoxy via CVS first. Verify the version number in + configure.in. If necessary, change the version + number. Run + + + + autoheader && autoconf && ./configure + + + + Then run + + + + gmake solaris-dist + + + + which creates a gzip'ed tar archive. Sadly, you cannot use make + solaris-upload on the Sourceforge machine (no ncftpput). You now have + to manually upload the archive to Sourceforge's ftp server and release + the file publically + + + + Windows + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + autoheader && autoconf && ./configure + + + + Then do FIXME. + + + + Debian + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + autoheader && autoconf && ./configure + + + + Then do FIXME. + + + + Mac OSX + + Login to Sourceforge's compilefarm via ssh + + + + ssh cf.sourceforge.net + + + + Choose the right operating system. If you have downloaded Privoxy + before, + + + + cd current && cvs update . + + + + If not, please checkout + Privoxy via CVS first. Verify the version number in + configure.in. If necessary, change the version + number. Run + + + + autoheader && autoconf && ./configure + + + + Then run + + + + make macosx-dist + + + + which creates a gzip'ed tar archive. Sadly, you cannot use make + macosx-upload on the Sourceforge machine (no ncftpput). You now have + to manually upload the archive to Sourceforge's ftp server and release + the file publically + + + + FreeBSD + + Change the version number of Privoxy in the + configure.in file. Run + + autoheader && autoconf && ./configure + + Then ... + + + Login to Sourceforge's compilefarm via ssh + + + + ssh cf.sourceforge.net + + + + Choose the right operating system. If you have downloaded Privoxy + before, + + + + cd current && cvs update . + + + + If not, please checkout + Privoxy via CVS first. Verify the version number in + configure.in. If necessary, change the version + number. Run + + + + autoheader && autoconf && ./configure + + + + Then run + + + + make freebsd-dist + + + + which creates a gzip'ed tar archive. Sadly, you cannot use make + freebsd-upload on the Sourceforge machine (no ncftpput). You now have + to manually upload the archive to Sourceforge's ftp server and release + the file publically + + + + Tarball + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + make clobber + autoheader && autoconf && ./configure + + + + Then do + + + + make tarball-dist + + + + To upload the package to Sourceforge, simply issue + + + + make tarball-upload + + + + Goto the displayed URL and release the file publically on Sourceforge. + + + + HP-UX 11 + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + autoheader && autoconf && ./configure + + + + Then do FIXME. + + + + Amiga OS + + Ensure that you have the latest code version. Hence run + + + + cvs update . + + + + first. If necessary, change the version number of + Privoxy in the + configure.in file. Run + + + + autoheader && autoconf && ./configure + + + + Then do FIXME. + + + + AIX + + Login to Sourceforge's compilefarm via ssh + + + + ssh cf.sourceforge.net + + + + Choose the right operating system. If you have downloaded Privoxy + before, + + + + cd current && cvs update . + + + + If not, please checkout + Privoxy via CVS first. Verify the version number in + configure.in. If necessary, change the version + number. Run + + + + autoheader && autoconf && ./configure + + + + Then run + + + + make aix-dist + + + + which creates a gzip'ed tar archive. Sadly, you cannot use make + aix-upload on the Sourceforge machine (no ncftpput). You now have + to manually upload the archive to Sourceforge's ftp server and release + the file publically + + + + Contact the developers @@ -1513,6 +1949,9 @@ at sourceforge. Three simple steps: Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.13 2002/03/27 01:16:41 hal9 + ditto + Revision 1.12 2002/03/27 01:02:51 hal9 Touch up on name change... -- 2.39.2