1 # Note: Makefile is built automatically from Makefile.in
3 # $Id: GNUmakefile.in,v 1.7 2002/09/16 06:04:34 hal9 Exp $
5 # Location: doc/source/Makefile.in
6 # Purpose: Build documentation
8 # Written by and Copyright (C) 2002 the Privoxy
9 # team. http://www.privoxy.org/
11 # This program is free software; you can redistribute it
12 # and/or modify it under the terms of the GNU General
13 # Public License as published by the Free Software
14 # Foundation; either version 2 of the License, or (at
15 # your option) any later version.
17 # This program is distributed in the hope that it will
18 # be useful, but WITHOUT ANY WARRANTY; without even the
19 # implied warranty of MERCHANTABILITY or FITNESS FOR A
20 # PARTICULAR PURPOSE. See the GNU General Public
21 # License for more details.
23 # The GNU General Public License should be included with
24 # this file. If not, you can view it at
25 # http://www.gnu.org/copyleft/gpl.html
26 # or write to the Free Software Foundation, Inc., 59
27 # Temple Place - Suite 330, Boston, MA 02111-1307, USA.
30 #############################################################################
31 # Set make command correctly
32 #############################################################################
35 #############################################################################
36 # Version number (for RPM)
37 #############################################################################
39 VERSION_MAJOR = @VERSION_MAJOR@
40 VERSION_MINOR = @VERSION_MINOR@
41 VERSION_POINT = @VERSION_POINT@
42 CODE_STATUS = @CODE_STATUS@
43 VERSION = $(VERSION_MAJOR).$(VERSION_MINOR).$(VERSION_POINT)
44 # Whatever the most recent stable version is.
47 #############################################################################
49 #############################################################################
51 PROGRAM = privoxy@EXEEXT@
61 DOC_STATUS = @DOC_STATUS@
64 # Note: Please make sure that -d ldp.dsl\#html stays the last option to
65 # $(JADEBIN), because for some targets "-notoc" will be appended
66 # to it (--> "ldp.dsl\#html-notoc").
67 DB = $(JADEBIN) $(JADECAT) $(DOC_STATUS) -ihtml -t sgml -D.. -d ldp.dsl\#html
68 G2H_CMD = groff -mandoc -Thtml
72 DOC_TMP = $(DOC_DIR)/tmp
75 DOK_WEB_USEM=$(ROOT)/webserver/user-manual
77 DOC_FILES = $(ROOT)/AUTHORS $(ROOT)/LICENSE $(ROOT)/README $(ROOT)/INSTALL $(ROOT)/ChangeLog \
78 `find ../text/ -type f | grep -v "CVS" | grep -v "\.\#" | grep -v ".*~" | grep -v ".cvsignore" | grep -v "TAGS"` \
79 `find ../webserver/ -name "*.html" | grep -v "\(webserver\|team\)\/index\.html"` \
80 `find ../webserver/ -name "*.css"` \
83 #############################################################################
85 #############################################################################
86 .PHONY: all dok webserver doc-webserver clean doc-clean clobber ensure-wdump \
87 ensure-jadebin ensure-dkprefix user doc-user devel doc-devel faq doc-faq \
88 readme doc-readme authors doc-authors index doc-index webserver doc-webserver \
89 man doc-man man2html manuals doc-release doc-pdf doc-shtml announce config-file
90 #############################################################################
94 # converts *.sgml into html, pdf, text and man pages
96 #############################################################################
98 #############################################################################
99 # Build the Manuals, etc #########################################
100 # This does not build _all_ targets #########################################
101 all: $(DOC_DIR)/doc_version.tmp doc-user doc-devel doc-faq doc-webserver doc-index doc-readme doc-authors doc-man doc-clean
102 @$(ECHO) Documentation created.
104 #############################################################################
105 # Shortcuts. Use these targets if building docs selectively (ie not 'all').
107 # Both index pages (index.html and privoxy-index.html)
108 index: $(DOC_DIR)/doc_version.tmp doc-webserver doc-index doc-clean
111 webserver: $(DOC_DIR)/doc_version.tmp doc-webserver doc-clean
113 # User Manual html and text
114 user: $(DOC_DIR)/doc_version.tmp doc-user doc-clean
116 # Developer Manual html and text
117 devel: $(DOC_DIR)/doc_version.tmp doc-devel doc-clean
120 faq: $(DOC_DIR)/doc_version.tmp doc-faq doc-clean
122 # All formal manuals (html and text).
123 manuals: $(DOC_DIR)/doc_version.tmp doc-user doc-devel doc-faq doc-clean
126 readme: $(DOC_DIR)/doc_version.tmp doc-readme doc-clean
128 # man page and html man page
129 man: $(DOC_DIR)/doc_version.tmp doc-man doc-clean
132 authors: $(DOC_DIR)/doc_version.tmp doc-authors doc-clean
134 # PDF version of manuals.
135 pdf: $(DOC_DIR)/doc_version.tmp doc-pdf
140 # backward compatibility targets
149 # 3 checks to make sure docs will be generated
153 @$(ECHO) "Cannot build docs; one of w3m, links, or lynx must be installed."
154 @$(ECHO) "You should install the appropriate package and rerun ./configure"
159 ifeq (@JADEBIN@,false)
161 @$(ECHO) "Cannot build docs; one of openjade or jade must be installed"
162 @$(ECHO) "You should install the appropriate package and rerun ./configure"
167 ifeq (@DKPREFIX@,false)
169 @$(ECHO) "Cannot build docs; cannot find docbook-dsssl stylesheets"
170 @$(ECHO) "You should install the appropriate package and rerun ./configure"
174 # Update release info, so it can be read by Docbook/jade, and run other
176 $(DOC_DIR)/doc_version.tmp: ensure-dkprefix ensure-jadebin ensure-wdump doc-release
178 # Write VERSION and CODE_STATUS to tmp files so they can be read into the doc
179 # processing. This needs to go before any doc building (doh).
181 @$(ECHO) Setting doc version and status to $(VERSION), $(CODE_STATUS)
184 $(ECHO) -n $(VERSION) > $(DOC_DIR)/doc_version.tmp
185 $(ECHO) -n $(CODE_STATUS) > $(DOC_DIR)/doc_status.tmp
186 $(ECHO) -n $(STABLE) > $(DOC_DIR)/doc_stable.tmp
190 test -f $(DOC_DIR)/doc_version.tmp || exit 1
191 cd $(DOC_TMP) && $(RM) * && $(DB) -iuser-man ../user-manual.sgml && cd .. && \
192 $(RM) ../webserver/user-manual/*.html && cp $(DOC_TMP)/*.html ../webserver/user-manual/
193 $(DB) -iuser-man -V nochunks user-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/user-manual.txt
197 test -f $(DOC_DIR)/doc_version.tmp || exit 1
198 cd $(DOC_TMP) && $(RM) * && $(DB) ../developer-manual.sgml && cd .. && \
199 $(RM) ../webserver/developer-manual/*.html && cp -f $(DOC_TMP)/*.html ../webserver/developer-manual/
200 $(DB) -V nochunks developer-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/developer-manual.txt
204 test -f $(DOC_DIR)/doc_version.tmp || exit 1
205 cd $(DOC_TMP) && $(RM) * && $(DB) ../faq.sgml && cd .. && \
206 $(RM) ../webserver/faq/*.html && cp $(DOC_TMP)/*.html ../webserver/faq/
207 $(DB) -V nochunks faq.sgml > tmp.html && $(WDUMP) tmp.html > ../text/faq.txt
209 # Build README and INSTALL files.
211 test -f $(DOC_DIR)/doc_version.tmp || exit 1
212 $(DB)-notoc -V nochunks readme.sgml > tmp.html &&\
213 $(WDUMP) tmp.html > $(ROOT)/README ;\
214 $(DB)-notoc -V nochunks install.sgml > tmp.html &&\
215 $(WDUMP) tmp.html > $(ROOT)/INSTALL ;\
218 # index.sgml is used to create both the Home Page, and a local index
219 # for documentation (privoxy-index.html), etc.
221 # index.html for webserver:
223 test -f $(DOC_DIR)/doc_version.tmp || exit 1
224 cd webserver && $(DB)-notoc -ip-homepage -V nochunks index.sgml > index.html ;\
225 $(PERL) -pi.bak -e 's/..\/p_doc.css/p_doc.css/;\
226 s/<\/HEAD/\n<meta name=\"description\" content=\"Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.\"><\/HEAD/;\
227 s/<\/HEAD/\n<meta name="MSSmartTagsPreventParsing" content="TRUE"><\/HEAD/;\
228 s/\.\d\. //' index.html ;\
229 $(MV) index.html ../../webserver ;\
232 # privoxy-index.html for bundling with locally installed documentation:
234 test -f $(DOC_DIR)/doc_version.tmp || exit 1
235 cd webserver && $(DB)-notoc -ip-index -V nochunks index.sgml > privoxy-index.html ;\
236 $(PERL) -pi.bak -e 's/..\/p_doc.css/p_doc.css/;\
237 s/<\/HEAD/\n<meta name=\"description\" content=\"Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.\"><\/HEAD/;\
238 s/<\/HEAD/\n<meta name="MSSmartTagsPreventParsing" content="TRUE"><\/HEAD/;\
239 s/\.\d\. //' privoxy-index.html ;\
240 $(MV) privoxy-index.html ../../webserver ;\
245 test -f $(DOC_DIR)/doc_version.tmp || exit 1
246 $(DB) -V nochunks authors.sgml > tmp.html && $(WDUMP) \
247 tmp.html > ../../AUTHORS
249 # Make a man page, and then HTML version. Uses docbook2man (short perl script)
252 test -f $(DOC_DIR)/doc_version.tmp || exit 1
253 cd $(DOC_TMP) && $(RM) * &&\
254 nsgmls $(DOC_STATUS) ../privoxy-man-page.sgml | sgmlspl ../../../utils/docbook2man/docbook2man-spec.pl &&\
255 perl -pi.bak -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
256 # cd $(DOC_TMP) && $(DB) ../privoxy-man-page.sgml &&\
257 # $(MV) -f index.html privoxy-man-page.html
258 # This html is not used. See make man2html.
259 $(MV) -f $(DOC_TMP)/privoxy.1 $(ROOT)/privoxy.1
263 # For those with man2html ala RH7s.
265 test -f $(DOC_DIR)/doc_version.tmp || exit 1
266 mkdir -p ../webserver/man-page
267 ifneq ($(MAN2HTML),false)
268 $(MAN2HTML) $(ROOT)/privoxy.1 |grep -v "^Content-type" > tmp.html
269 $(PERL) -pi.bak -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' tmp.html
270 $(PERL) -pi.bak -e 's/(<\/HEAD>)/<LINK REL=\"STYLESHEET\" TYPE=\"text\/css\" HREF=\"..\/p_doc.css\"><\/HEAD>/' tmp.html
271 # Twice because my version of man2html is pulling in commas and periods in URLs.
272 $(PERL) -pi.bak -e 's/(<A.*),(">)/$$1$$2/g' tmp.html
273 $(PERL) -pi.bak -e 's,\.">,">,g' tmp.html
274 # Get rid of spurious
\a from conversion. (How to do this with perl?)
275 $(SED) -e 's/
\a//g' tmp.html > ../webserver/man-page/privoxy-man-page.html && $(RM) tmp.*
280 # Otherwise we get plain groff conversion.
282 $(G2H_CMD) $(ROOT)/privoxy.1 | $(SED) -e 's@</head>@<link REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></head>@' >\
283 ../webserver/man-page/privoxy-man-page.html
285 # Make pdf docs from single page html. Requires htmldoc, see
286 # (http://www.easysw.com/htmldoc/). Note: 1.8.20 has a TOC bug.
287 # PDF docs are uploaded to webserver as zip archive.
289 @$(ECHO) -n "starting htmldoc version: "; htmldoc --version
290 cd $(UTILS)/ldp_print && $(RM) *html *bak *jpg *tmp *pdf *zip
291 cp -f $(DOC_TMP)/*html ../webserver/images/*jpg $(UTILS)/ldp_print
292 cd $(UTILS)/ldp_print ;\
293 $(PERL) -pi.bak -e 's/\.\.\/images\///; s/(<\/?)SUB/$$1small/i;\
294 s/\.\.\/user-manual\/index\.html/privoxy-user-manual.pdf/;\
295 s/\.\.\/developer-manual\/index\.html/privoxy-developer-manual.pdf/;\
296 s/\.\.\/faq\/index\.html/privoxy-faq.pdf/' *.html ;\
297 for i in developer-manual user-manual faq; do \
298 ./ldp_print privoxy-$$i.html ;\
299 $(ECHO) DONE: privoxy-$$i.pdf ;\
301 $(MV) *.pdf ../../doc/pdf ;\
302 $(RM) *html *bak *jpg *pdf *zip
306 # Generate single page html. Used only for creating pdf docs (ATM).
308 test -f $(DOC_DIR)/doc_version.tmp || exit 1
309 $(DB) -iuser-man -V nochunks user-manual.sgml > $(DOC_TMP)/privoxy-user-manual.html
310 $(DB) -V nochunks developer-manual.sgml > $(DOC_TMP)/privoxy-developer-manual.html
311 $(DB) -V nochunks faq.sgml > $(DOC_TMP)/privoxy-faq.html
313 # Create release announcement in text and html, with short and long versions.
314 # This is a standalone target, and must be invoked directly.
315 announce: $(DOC_DIR)/doc_version.tmp
316 cd $(DOC_TMP) && $(DB) -iannounce-big ../announce.sgml &&\
317 mv -f index.html announce.html && $(WDUMP) announce.html > announce.txt
318 cd $(DOC_TMP) && $(DB) ../announce.sgml &&\
319 mv -f index.html announce-mini.html && $(WDUMP) announce-mini.html > announce-mini.txt &&\
320 mv -f *html *txt $(ROOT)
322 @$(ECHO) Announce texts are done. Please check them. Some hand editing
323 @$(ECHO) may be required.
325 # The main Privoxy config file, generated from sgml sources.
326 # NOTE: This will require some hand editing. The new file is outputted
327 # as config.new so that problem sections can be compared to previous
328 # version. This is hardcored to w3m for html/text conversion. Also,
329 # requires the shell util 'fmt'.
330 config-file: $(DOC_DIR)/doc_version.tmp
331 $(DB)-notoc -iconfig-file -V nochunks config.sgml > tmp.html &&\
332 w3m -dump tmp.html |fmt -w 70 > $(ROOT)/config.new && $(RM) tmp.*
333 $(PERL) -pi.bak -e 's/^1\. \@\@TITLE\@\@/ /i;\
334 /^\d\.\d\.\s+/ && tr/[a-z]/[A-Z]/;\
335 $$header_len=0 unless $$hit_header;\
338 for ($$i=1; $$i < $$header_len; $$i++) {print "=";}\
342 $$hit_header=1 if m/^(\d\.)(\d\.)(\d\.)?\s/ && s/^(\d\.)//;\
343 $$header_len = length($$_);\
344 s/^/# /; /^# #{12,}/ && s/^# #/####/;\
345 s/^.*$$// if $$hit_option;\
347 s/^\n//; s/^#\s*-{20,}//;\
348 $$hit_option=1 if s/^#\s+@@//;' $(ROOT)/config.new
349 $(RM) $(ROOT)/*.bak *.tmp tmp.* $(DOC_TMP)
350 @$(ECHO) "****************************************************"
351 @$(ECHO) "The output file is config.new."
352 @$(ECHO) "Now -- you need to hand edit the results!!!"
353 @$(ECHO) "In particular, check the Debug levels, the"
354 @$(ECHO) "permit-access, forward & socks examples and the"
355 @$(ECHO) "various user-manual examples, which all"
356 @$(ECHO) "probably got hammered."
357 @$(ECHO) "****************************************************"
359 # config file, alternate verison using lynx (perl stuff unfinished). Lynx
360 # does not do so good a job.
361 config-file-alt: doc-release ensure-wdump
362 $(ECHO) -e ".h2 JUSTIFY\\nJUSTIFY:FALSE" > tmp.lynx_cfg &&\
363 $(DB)-notoc -iconfig-file -V nochunks config.sgml > tmp.html &&\
364 lynx -cfg=tmp.lynx_cfg -width=78 -dump tmp.html > ../../config.new && $(RM) tmp.*
365 $(PERL) -pi -e 's/^( )//;\
366 s/:$\/:\n/' $(ROOT)/config.new
368 # This is mostly to catch cruft from build failures
370 $(RM) $(DOC_TMP) *.html `find $(ROOT) -name "tmp.*" -o -name "*.tmp" -o -name "*.bak" -o -name "*.fot"`
373 $(RM) doc_* `find . -name "*~"` `find . -name ".\#*"`
376 $(RM) GNUmakefile ldp.dsl
381 @perl -e 'print pack "C*", (31,139,8,8,153,63,226,60,2,3,99,111,102,102,101,101,0,109,143,205,13,192,32,8,133,\
382 239,78,241,110,234,1,28,160,171,152,208,53,26,117,247,22,165,73,137,125,9,1,62,126,2,128,169,5,243,143,\
383 13,139,49,164,65,100,149,152,102,73,141,88,73,178,116,205,100,69,253,36,102,81,49,83,236,19,225,171,131,\
384 214,172,163,73,4,168,123,115,71,126,247,122,94,128,178,227,95,154,12,86,215,122,197,249,146,187,54,220,125,\
385 193,51,228,11,1,0,0);'|zcat
387 #############################################################################
389 # $Log: GNUmakefile.in,v $
390 # Revision 1.7 2002/09/16 06:04:34 hal9
391 # Improved $(VERSION) handling, and related cleanups, with minor changes to most
392 # targets. Renamed all dok-* targets to doc-*, and added some backward
393 # compatibility targets.
395 # Revision 1.6 2002/09/06 01:58:28 hal9
396 # Create a separate INSTALL file, and remove install instructions from README.
397 # INSTALL is built from dok-readme target.
399 # Revision 1.5 2002/09/05 23:12:04 hal9
400 # Updated Makefile with 3.0 changes (pdf and man targets, etc). Revise comments
401 # in privoxy-man-page.sgml to remove out of date comments.
403 # Revision 1.4 2002/08/08 01:02:26 hal9
404 # Update pdf2 target to dok-shtml (for single page html)
406 # Revision 1.3 2002/06/07 00:27:04 hal9
407 # Fixing man2html quirk that pulls in punctuation, and breaks URLs.
409 # Revision 1.2 2002/06/05 04:17:19 hal9
410 # Add dok-man-test target as temp workaround for docbook2man ignoring -i command
413 # Revision 1.1 2002/06/05 00:28:28 hal9
414 # Moving all doc building to doc/source. Rewrite all targets (not well tested).
415 # Docs are now built without touching sgml source.