1 # Note: Makefile is built automatically from Makefile.in
3 # $Id: GNUmakefile.in,v 1.2 2002/06/05 04:17:19 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)
45 #############################################################################
47 #############################################################################
49 PROGRAM = privoxy@EXEEXT@
59 DOC_STATUS = @DOC_STATUS@
61 # Note: Please make sure that -d ldp.dsl\#html stays the last option to
62 # $(JADEBIN), because for some targets "-notoc" will be appended
63 # to it (--> "ldp.dsl\#html-notoc").
64 DB = $(JADEBIN) $(JADECAT) $(DOC_STATUS) -ihtml -t sgml -D.. -d ldp.dsl\#html
65 G2H_CMD = groff -mandoc -Thtml
69 DOC_TMP = $(DOC_DIR)/tmp
71 DOK_WEB_USEM=$(ROOT)/webserver/user-manual
73 DOC_FILES = AUTHORS LICENSE README ChangeLog \
74 `find ../text/ -type f | grep -v "CVS" | grep -v "\.\#" | grep -v ".*~" | grep -v ".cvsignore" | grep -v "TAGS"` \
75 `find ../webserver/ -name "*.html" | grep -v "\(webserver\|team\)\/index\.html"` \
76 `find ../webserver/ -name "*.css"` \
79 #############################################################################
81 #############################################################################
82 .PHONY: all dok webserver dok-webserver clean dok-clean clobber ensure-wdump \
83 ensure-jadebin ensure-dkprefix user dok-user devel dok-devel faq dok-faq \
84 readme dok-readme authors dok-authors index dok-index webserver dok-webserver \
85 man dok-man man2html manuals dok-release dok-pdf dok-pdf2 announce config-file
86 #############################################################################
90 # converts *.sgml into html, text and man pages
92 #############################################################################
94 # Build the Manuals, etc #########################################
95 # This does not build _all_ targets #########################################
96 all: dok-release dok-user dok-devel dok-faq dok-index dok-readme dok-authors dok-clean
97 @$(ECHO) Documentation created.
99 # Shortcuts. Use these targets.
101 index: dok-release dok-webserver dok-index dok-clean
102 user: dok-release dok-user dok-clean
103 devel: dok-release dok-devel dok-clean
104 faq: dok-release dok-faq dok-clean
105 manuals: dok-release dok-user dok-devel dok-faq dok-clean
106 readme: dok-release dok-readme dok-clean
107 webserver: dok-release dok-webserver dok-clean
108 man: dok-release dok-man dok-clean
109 authors: dok-release dok-authors dok-clean
111 # 3 checks to make sure docs will be generated
115 @$(ECHO) "Cannot build docs; one of w3m, links, or lynx must be installed."
116 @$(ECHO) "You should install the appropriate package and rerun ./configure"
121 ifeq (@JADEBIN@,false)
123 @$(ECHO) "Cannot build docs; one of openjade or jade must be installed"
124 @$(ECHO) "You should install the appropriate package and rerun ./configure"
129 ifeq (@DKPREFIX@,false)
131 @$(ECHO) "Cannot build docs; cannot find docbook-dsssl stylesheets"
132 @$(ECHO) "You should install the appropriate package and rerun ./configure"
137 dok-user: ensure-dkprefix ensure-jadebin ensure-wdump
138 cd $(DOC_TMP) && $(RM) * && $(DB) -iuser-man ../user-manual.sgml && cd .. && \
139 $(RM) ../webserver/user-manual/*.html && cp $(DOC_TMP)/*.html ../webserver/user-manual/
140 $(DB) -iuser-man -V nochunks user-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/user-manual.txt
143 dok-devel: ensure-dkprefix ensure-jadebin ensure-wdump
144 cd $(DOC_TMP) && $(RM) * && $(DB) ../developer-manual.sgml && cd .. && \
145 $(RM) ../webserver/developer-manual/*.html && cp -f $(DOC_TMP)/*.html ../webserver/developer-manual/
146 $(DB) -V nochunks developer-manual.sgml > tmp.html && $(WDUMP) tmp.html > ../text/developer-manual.txt
149 dok-faq: ensure-dkprefix ensure-jadebin ensure-wdump
150 cd $(DOC_TMP) && $(RM) * && $(DB) ../faq.sgml && cd .. && \
151 $(RM) ../webserver/faq/*.html && cp $(DOC_TMP)/*.html ../webserver/faq/
152 $(DB) -V nochunks faq.sgml > tmp.html && $(WDUMP) tmp.html > ../text/faq.txt
154 # man page, using one variant of man2html that reads page from stdin.
155 dok-man-suse: ensure-dkprefix ensure-jadebin ensure-wdump dok-release
156 $(RM) ../webserver/man-page/*.html
157 ifneq ($(MAN2HTML),false)
158 $(ECHO) "<html><head><title>Privoxy Man page</title><link rel=\"stylesheet\" type=\"text/css\" href=\"../p_web.css\"></head><body><H2>NAME</H2>" > \
159 ../webserver/man-page/privoxy-man-page.html
160 man $(ROOT)/privoxy.1 | $(MAN2HTML) -bare >> ../webserver/man-page/privoxy-man-page.html
161 $(ECHO) "</body></html>" >> ../webserver/man-page/privoxy-man-page.html
167 dok-readme: ensure-dkprefix ensure-jadebin ensure-wdump
168 $(DB)-notoc -V nochunks readme.sgml > tmp.html &&\
169 $(WDUMP) tmp.html > $(ROOT)/README
171 # index.sgml is used to create both the Home Page, and a local index
172 # for documentation (privoxy-index.html), etc.
174 # index.html for webserver:
175 dok-webserver: ensure-dkprefix ensure-jadebin ensure-wdump
176 cd webserver && $(DB)-notoc -ip-homepage -V nochunks index.sgml > ../../webserver/index.html
177 $(PERL) -pi.bak -e 's/..\/p_doc.css/p_doc.css/;\
178 s/<\/HEAD/\n<meta name=\"description\" content=\"Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.\"><\/HEAD/;\
179 s/<\/HEAD/\n<meta name="MSSmartTagsPreventParsing" content="TRUE"><\/HEAD/;\
181 ../webserver/index.html
183 # privoxy-index.html for local documentation:
184 dok-index: ensure-dkprefix ensure-jadebin ensure-wdump
185 cd webserver && $(DB)-notoc -ip-index -V nochunks index.sgml > ../../webserver/privoxy-index.html
186 $(PERL) -pi.bak -e 's/..\/p_doc.css/p_doc.css/;\
187 s/<\/HEAD/\n<meta name=\"description\" content=\"Privoxy helps consumers reduce unwanted junk email and protect their privacy from direct marketing companies.\"><\/HEAD/;\
188 s/<\/HEAD/\n<meta name="MSSmartTagsPreventParsing" content="TRUE"><\/HEAD/;\
190 ../webserver/privoxy-index.html
193 dok-authors: ensure-dkprefix ensure-jadebin ensure-wdump
194 $(DB) -V nochunks authors.sgml > tmp.html && $(WDUMP) \
195 tmp.html > ../../AUTHORS
197 # Make a man page, and then (lousy) HTML version.
198 # Requires docbook2man (short perl script), see comments
199 # in privoxy-man-page.sgml. This target is not invoked from other dok targets.
200 # It is built separately due to dependencies on off-beat perl scripts.
201 # Note: docbook2man eats all command line arguments except file name. Bummer.
202 dok-man: ensure-dkprefix ensure-jadebin
203 cd $(DOC_TMP) && $(RM) * && docbook2man $(DOC_STATUS) ../privoxy-man-page.sgml &&\
204 perl -pi.bak -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
205 cd $(DOC_TMP) && $(DB) ../privoxy-man-page.sgml &&\
206 $(MV) -f index.html privoxy-man-page.html
207 # This html is not used. See make man2html.
208 $(MV) -f $(DOC_TMP)/privoxy.1 $(ROOT)/privoxy.1
209 # Build a proper HTML man page.
212 # This is laternate version of above, that does handle command line options,
214 dok-man-test: ensure-dkprefix ensure-jadebin dok-release
215 cd $(DOC_TMP) && $(RM) * &&\
216 nsgmls $(DOC_STATUS) ../privoxy-man-page.sgml | sgmlspl `find /usr/share/sgml -name docbook2man-spec.pl` &&\
217 perl -pi.bak -e 's/ <URL:.*>//; s/\[ /\[/g' privoxy.1
218 cd $(DOC_TMP) && $(DB) ../privoxy-man-page.sgml &&\
219 $(MV) -f index.html privoxy-man-page.html
220 # This html is not used. See make man2html.
221 $(MV) -f $(DOC_TMP)/privoxy.1 $(ROOT)/privoxy.1
225 # For those with man2html ala RH7s.
226 man2html: ensure-dkprefix ensure-jadebin ensure-wdump
227 mkdir -p doc/webserver/man-page
228 ifneq ($(MAN2HTML),false)
229 $(MAN2HTML) privoxy.1 |grep -v "^Content-type" > tmp.html
230 $(PERL) -pi.bak -e 's/<A .*Contents<\/A>//; s/<A .*man2html<\/A>/man2html/' tmp.html
231 $(PERL) -pi.bak -e 's/(<\/HEAD>)/<LINK REL=\"STYLESHEET\" TYPE=\"text\/css\" HREF=\"..\/p_doc.css\"><\/HEAD>/' tmp.html
232 # Twice because my version of man2html is pulling in commas and periods in URLs.
233 $(PERL) -pi.bak -e 's/(<A.*),(">)/$$1$$2/g' tmp.html
234 $(PERL) -pi.bak -e 's,\.">,">,g' tmp.html
235 # Get rid of spurious
\a from conversion. (How to do this with perl?)
236 $(SED) -e 's/
\a//g' tmp.html > doc/webserver/man-page/privoxy-man-page.html && $(RM) tmp.*
241 # Otherwise we get plain groff conversion.
243 $(G2H_CMD) $(ROOT)/privoxy.1 | $(SED) -e 's@</head>@<link REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></head>@' >\
244 ../webserver/man-page/privoxy-man-page.html
246 # Write VERSION and CODE_STATUS to tmp files so they can be read into the doc
247 # processing. This needs to go before any doc building (doh).
249 @$(ECHO) Setting doc version and status to $(VERSION), $(CODE_STATUS)
252 $(ECHO) -n $(VERSION) > $(DOC_DIR)/doc_version.tmp
253 $(ECHO) -n $(CODE_STATUS) > $(DOC_DIR)/doc_status.tmp
259 cd ../pdf && db2pdf --pdf -s ldp.dsl user-manual.sgml && mv user-manual.pdf privoxy-user-manual.pdf > /dev/null 2>&1
260 cd ../pdf && db2pdf --pdf -s ldp.dsl developer-manual.sgml && mv developer-manual.pdf privoxy-developer-manual.pdf > /dev/null 2>&1
261 cd ../pdf && db2pdf --pdf -s ldp.dsl faq.sgml && mv faq.pdf privoxy-faq.pdf > /dev/null 2>&1
262 $(RM) ../pdf/*.sgml ../pdf/*.dsl ../pdf/*.out ../pdf/*.tex ../pdf/*.log ../pdf/*.aux
264 # the layout and style with db2pdf sucks, here is an alternative
265 dok-pdf2: dok-release
266 mkdir -p $(DOC_TMP) # this directory not in cvs
267 $(DB) -V nochunks user-manual.sgml > $(DOC_TMP)/privoxy-user-manual.html
268 $(DB) -V nochunks developer-manual.sgml > $(DOC_TMP)/privoxy-developer-manual.html
269 $(DB) -V nochunks faq.sgml > $(DOC_TMP)/privoxy-faq.html
270 # one could use html2ps and ps2pdf. well, that does not work. htmlps produces incorrect output.
272 # Create release announcement in text and html, with short and long versions.
273 # This is a standalone target, and must be invoked directly.
274 announce: dok-release ensure-wdump
275 cd $(DOC_TMP) && $(DB) -iannounce-big ../announce.sgml &&\
276 mv -f index.html announce.html && $(WDUMP) announce.html > announce.txt
277 cd $(DOC_TMP) && $(DB) ../announce.sgml &&\
278 mv -f index.html announce-mini.html && $(WDUMP) announce-mini.html > announce-mini.txt &&\
279 mv -f *html *txt $(ROOT)
281 @$(ECHO) Announce texts are done. Please check them. Some hand editing
282 @$(ECHO) may be required.
284 # The main Privoxy config file, generated from sgml sources.
285 # NOTE: This will require some hand editing. The new file is outputted
286 # as config.new so that problem sections can be compared to previous
287 # version. This is hardcored to w3m for html/text conversion. Also,
288 # requires the shell util 'fmt'.
289 config-file: ensure-dkprefix ensure-jadebin ensure-wdump dok-release
290 $(DB)-notoc -iconfig-file -V nochunks config.sgml > tmp.html &&\
291 w3m -dump tmp.html |fmt -w 70 > $(ROOT)/config.new && $(RM) tmp.*
292 $(PERL) -pi.bak -e 's/^1\. \@\@TITLE\@\@/ /i;\
293 /^\d\.\d\.\s+/ && tr/[a-z]/[A-Z]/;\
294 $$header_len=0 unless $$hit_header;\
297 for ($$i=1; $$i < $$header_len; $$i++) {print "=";}\
301 $$hit_header=1 if m/^(\d\.)(\d\.)(\d\.)?\s/ && s/^(\d\.)//;\
302 $$header_len = length($$_);\
303 s/^/# /; /^# #{12,}/ && s/^# #/####/;\
304 s/^.*$$// if $$hit_option;\
306 s/^\n//; s/^#\s*-{20,}//;\
307 $$hit_option=1 if s/^#\s+@@//;' $(ROOT)/config.new
308 $(RM) $(ROOT)/*.bak *.tmp tmp.* $(DOC_TMP)
309 @$(ECHO) "****************************************************"
310 @$(ECHO) "The output file is config.new."
311 @$(ECHO) "Now -- you need to hand edit the results!!!"
312 @$(ECHO) "In particular, check the Debug levels, and the"
313 @$(ECHO) "permit-access, forward & socks examples. They"
314 @$(ECHO) "probably got hammered."
315 @$(ECHO) "****************************************************"
317 # config file, alternate verison using lynx (perl stuff unfinished). Lynx
318 # does not do so good a job.
319 config-file-alt: dok-release ensure-wdump
320 $(ECHO) -e ".h2 JUSTIFY\\nJUSTIFY:FALSE" > tmp.lynx_cfg &&\
321 $(DB)-notoc -iconfig-file -V nochunks config.sgml > tmp.html &&\
322 lynx -cfg=tmp.lynx_cfg -width=78 -dump tmp.html > ../../config.new && $(RM) tmp.*
323 $(PERL) -pi -e 's/^( )//;\
324 s/:$\/:\n/' $(ROOT)/config.new
326 # This is mostly to catch cruft from build failures
328 $(RM) $(DOC_TMP) `find $(ROOT) -name "tmp.*" -o -name "*.tmp" -o -name "*.bak" -o -name "*.fot"`
331 $(RM) `find . -name "*~"`
332 $(RM) `find . -name ".\#*"`
335 $(RM) GNUmakefile ldp.dsl
340 @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,\
341 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,\
342 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,\
343 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,\
344 193,51,228,11,1,0,0);'|zcat
346 #############################################################################
348 # $Log: GNUmakefile.in,v $
349 # Revision 1.2 2002/06/05 04:17:19 hal9
350 # Add dok-man-test target as temp workaround for docbook2man ignoring -i command
353 # Revision 1.1 2002/06/05 00:28:28 hal9
354 # Moving all doc building to doc/source. Rewrite all targets (not well tested).
355 # Docs are now built without touching sgml source.