# Note: Makefile is built automatically from Makefile.in
#
-# $Id: GNUmakefile.in,v 1.62 2002/04/04 20:49:50 swa Exp $
+# $Id: GNUmakefile.in,v 1.69 2002/04/07 08:10:47 swa Exp $
#
# Written by and Copyright (C) 2001 the SourceForge
# Privoxy team. http://www.privoxy.org/
MAN2HTML = @MAN2HTML@
G2H_CMD = groff -mandoc -Thtml
TARGET_OS = @host@
+PERL = perl
#User Group paras
USER = @USER@
# - Jon
#DOSFILTER = $(SED) -e $$'s,$$,\r,'
#DOSFILTER = gawk -v ORS='\r\n' '{print $0;}'
-DOSFILTER = perl -p -e 's/\n/\r\n/'
+DOSFILTER = $(PERL) -p -e 's/\n/\r\n/'
#############################################################################
# Setup for make distribution rh and suse for now
# Otherwise we get plain groff conversion.
groff2html:
- $(G2H_CMD) ./privoxy.1 > doc/webserver/man-page/privoxy-man-page.html
+ $(G2H_CMD) ./privoxy.1 | $(SED) -e 's@</head>@<link REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></head>@' > doc/webserver/man-page/privoxy-man-page.html
# developer manual
dok-devel: doc/source/ldpOK.dsl
- rm -rf doc/webserver/developer-manual doc/source/developer-manual
+ rm -f doc/webserver/developer-manual/*.html
+ rm -rf doc/source/developer-manual
mkdir -p doc/text doc/source/developer-manual
- cd doc/source/developer-manual && $(DB) ../developer-manual.sgml && cd .. && mv developer-manual ../webserver
+ cd doc/source/developer-manual && $(DB) ../developer-manual.sgml && cd .. && cp developer-manual/*.html ../webserver/developer-manual/
cd doc/source && $(DB) -V nochunks developer-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/developer-manual.txt && rm -rf tmp.html developer-manual
# user manual
dok-user: doc/source/ldpOK.dsl
- rm -rf doc/webserver/user-manual doc/source/user-manual
+ rm -f doc/webserver/user-manual/*.html
+ rm -rf doc/source/user-manual/
mkdir -p doc/text doc/source/user-manual
- cd doc/source/user-manual && $(DB) ../user-manual.sgml && cd .. && mv user-manual ../webserver
+ cd doc/source/user-manual && $(DB) ../user-manual.sgml && cd .. && cp user-manual/*.html ../webserver/user-manual/
cd doc/source && $(DB) -V nochunks user-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/user-manual.txt && rm -rf tmp.html user-manual
# faq
dok-faq: doc/source/ldpOK.dsl
- rm -rf doc/webserver/faq doc/source/faq
+ rm -f doc/webserver/faq/*.html
+ rm -rf doc/source/faq
mkdir -p doc/text doc/source/faq
- cd doc/source/faq && $(DB) ../faq.sgml && cd .. && mv faq ../webserver
+ cd doc/source/faq && $(DB) ../faq.sgml && cd .. && cp faq/*.html ../webserver/faq/
cd doc/source && $(DB) -V nochunks faq.sgml > tmp.html && $(WDUMP) tmp.html > ../text/faq.txt && rm -rf tmp.html faq
# man page
dok-man: doc/source/ldpOK.dsl
- rm -rf doc/man doc/webserver/man-page
- mkdir -p doc/man -p doc/webserver/man-page
- if [ "$(MAN2HTML)" != "false" ]; then \
- $(ECHO) "<html><head><title>Privoxy Man page</title><link rel=\"stylesheet\" type=\"text/css\" href=\"../p_web.css\"></head><body><H2>NAME</H2>" > doc/webserver/man-page/privoxy-man-page.html; \
- man ./privoxy.1 | $(MAN2HTML) -bare \
- >> doc/webserver/man-page/privoxy-man-page.html; \
- $(ECHO) "</body></html>" >> doc/webserver/man-page/privoxy-man-page.html; \
- else \
- $(MAKE) groff2html; \
- fi
+ rm -f doc/man/* doc/webserver/man-page/*.html
+ifneq ($(MAN2HTML),false)
+ $(ECHO) "<html><head><title>Privoxy Man page</title><link rel=\"stylesheet\" type=\"text/css\" href=\"../p_web.css\"></head><body><H2>NAME</H2>" > doc/webserver/man-page/privoxy-man-page.html
+ man ./privoxy.1 | $(MAN2HTML) -bare >> doc/webserver/man-page/privoxy-man-page.html
+ $(ECHO) "</body></html>" >> doc/webserver/man-page/privoxy-man-page.html
+else
+ $(MAKE) groff2html
+endif
# readme page
dok-readme: doc/source/ldpOK.dsl
cd doc/source && $(DB) -V nochunks readme.sgml > tmp.html &&\
$(WDUMP) tmp.html > ../../README && rm -rf tmp.html
-dok: dok-devel dok-user dok-faq dok-man dok-readme
+# webserver files
+dok-webserver: doc/source/ldpOK.dsl
+ cd doc/source/webserver && $(DB) -V nochunks index.sgml > ../../webserver/index.html
+
+dok: dok-devel dok-user dok-faq dok-man dok-readme dok-webserver
# 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
-## user manual
- rm -rf doc/webserver/user-manual
- cd doc/source/user-manual && $(DB) ../user-manual.sgml && cd .. &&\
- mv user-manual ../webserver
- cd doc/source && $(DB) -V nochunks user-manual.sgml > tmp.html && \
- $(WDUMP) tmp.html > ../text/user-manual.txt && rm -rf tmp.html \
- user-manual
-## developer manual
- rm -rf doc/webserver/developer-manual
- cd doc/source/developer-manual && $(DB) ../developer-manual.sgml &&\
- cd .. && mv developer-manual ../webserver
- cd doc/source && $(DB) -V nochunks developer-manual.sgml > tmp.html && \
- $(WDUMP) tmp.html > ../text/developer-manual.txt && rm -rf tmp.html \
- developer-manual
-## faq
- rm -rf doc/webserver/faq
- cd doc/source/faq && $(DB) ../faq.sgml && cd .. && mv faq ../webserver
- cd doc/source && $(DB) -V nochunks faq.sgml > tmp.html && $(WDUMP) \
- tmp.html > ../text/faq.txt && rm -rf tmp.html faq
-## readme
- $(MAKE) redhat-readme
+# an alternative to the above dok. disabled man page creation for the moment
+#
+redhat-dok: dok-devel dok-user dok-faq redhat-readme dok-webserver
# kludge to force recreation on next run. Rodgrigo?
@rm -f doc/source/ldpOK.dsl
+ @$(ECHO) Documentation created.
# For those with man2html ala RH7's.
man2html:
mkdir -p doc/webserver/man-page
- if [ "$(MAN2HTML)" != "false" ]; then \
- $(MAN2HTML) privoxy.1 |grep -v "^Content-type" > doc/webserver/man-page/privoxy-man-page.html; \
- perl -pi -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' doc/webserver/man-page/privoxy-man-page.html; \
- else \
- $(MAKE) groff2html; \
- fi
+ifneq ($(MAN2HTML),false)
+ $(MAN2HTML) privoxy.1 |grep -v "^Content-type" > tmp.html
+ $(PERL) -pi -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' tmp.html
+ $(PERL) -pi -e 's/(<\/HEAD>)/<LINK REL=\"STYLESHEET\" TYPE=\"text\/css\" HREF=\"..\/p_doc.css\"><\/HEAD>/' tmp.html
+# Get rid of spurious \a from converion. (How to do this with perl?)
+ $(SED) -e 's/\a//g' tmp.html > doc/webserver/man-page/privoxy-man-page.html && rm -f tmp.html
+else
+ $(MAKE) groff2html
+endif
## Make README
redhat-readme: doc/source/ldpOK.dsl
cd doc/source && $(DB) -V nochunks readme.sgml > tmp.html && $(WDUMP) \
- tmp.html > ../../README && rm -rf tmp.html
- # kludge to force recreation on next run. Rodgrigo?
+ tmp.html > ../../README && rm -rf tmp.html
+ # kludge to force recreation on next run. Rodgrigo?
@rm -f doc/source/ldpOK.dsl
+#### WIP targets HB ##################
+## Make AUTHORS file
+authors: doc/source/ldpOK.dsl
+ cd doc/source && $(DB) -V nochunks authors.sgml > tmp.html && $(WDUMP) \
+ tmp.html > ../../AUTHORS && rm -f tmp.html
+ # kludge to force recreation on next run. Rodgrigo?
+ @rm -f doc/source/ldpOK.dsl
+
+# make a man page, and then (lousy) HTML version.
+man: doc/source/ldpOK.dsl
+ mkdir -p doc/source/man
+ cd doc/source/man && docbook2man ../privoxy-man-page.sgml &&\
+ $(PERL) -pi -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
+ cd doc/source/man && $(DB) ../privoxy-man-page.sgml &&\
+ mv -f index.html privoxy-man-page.html
+ # kludge to force recreation on next run. Rodgrigo?
+ @rm -f doc/source/ldpOK.dsl
+
+# Set doc entities for VERSION and CODE_STATUS. Toggle content
+# exceptions accordingly. When 'make dok' gets stable, this
+# needs to go before any doc building (doh).
+make dok-release:
+ @$(ECHO) Setting doc version and status to $(VERSION), $(CODE_STATUS)
+ @$(PERL) -pi -e 's/<!entity +p-version.*>/<!entity p-version "$(VERSION)">/;\
+ s/<!entity +p-status.*>/<!entity p-status "$(CODE_STATUS)">/' \
+ doc/source/*sgml
+ifeq ($(CODE_STATUS),stable)
+ @$(ECHO) Setting docs to stable $(VERSION)
+ @$(PERL) -pi -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "INCLUDE">/;\
+ s/<!entity +% +p-not-stable.*>/<!entity % p-not-stable "IGNORE">/' \
+ doc/source/*sgml
+else
+ @$(ECHO) Setting docs to not stable $(VERSION)
+ @$(PERL) -pi -e 's/<!entity +% +p-stable.*>/<!entity % p-stable "IGNORE">/;\
+ s/<!entity +% +p-not-stable.*>/<!entity % p-not-stable "INCLUDE">/' \
+ doc/source/*sgml
+endif
+
#############################################################################
#
# Webserver
$(LD) $(LDFLAGS) -o $(PROGRAM) $(OBJS) $(LIBS)
clean:
- $(RM) a.out $(OBJS) $(W32_FILES) $(W32_INIS) $(PROGRAM) `find . -iname TAGS`
+ $(RM) a.out $(OBJS) $(W32_FILES) $(W32_INIS) $(PROGRAM) `find . -name TAGS -o -name tags`
tidy:
$(RM) `find . -name "*~" -o -name "#*#"`
## end:
# $Log: GNUmakefile.in,v $
+# Revision 1.69 2002/04/07 08:10:47 swa
+# create some of the webserver docs
+# automatically (in particular if
+# those docs recycle other documentation
+# fragments). Now committed webserver's
+# index file.
+#
+# Revision 1.68 2002/04/07 07:58:11 swa
+# create some of the webserver docs
+# automatically (in particular if
+# those docs recycle other documentation
+# fragments)
+#
+# Revision 1.67 2002/04/07 05:31:42 hal9
+# Add 'dok-release' target:
+# -Set doc entities to VERSION and CODE_STATUS during make.
+# -Set doc conditional content flags (stable vs non-stable).
+# A separate target for the time being but needs to be incorporated into
+# dok build at some point.
+# -Filter out a spurious ^G from new man page > html converion in man2html.
+#
+# Revision 1.66 2002/04/06 20:28:21 jongfoster
+# Prettifying groff2html.
+# Using GNU Make's conditional makefile feature rather than shell "if"s.
+# (The shell "if"s were hiding errors)
+# "perl" -> "$(PERL)"
+# Spaces->tabs in a couple of places.
+#
+# Revision 1.65 2002/04/06 05:16:39 hal9
+# -Add 'authors' and 'man' targets for AUTHORS and man-page (WIP).
+# -Both of these will soon be generated files.
+#
+# Revision 1.64 2002/04/04 22:14:51 oes
+# No longer rely on find honoring -iname
+#
+# Revision 1.63 2002/04/04 21:06:22 swa
+# cosmetics.
+#
# Revision 1.62 2002/04/04 20:49:50 swa
# attempt to consolidate the
# different dokbook versions.