1 ##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002
2 ##Free Software Foundation, Inc.
4 # Makefile for GDB documentation.
5 # This file is part of GDB.
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 htmldir = $(prefix)/html
34 INSTALL_PROGRAM = @INSTALL_PROGRAM@
35 INSTALL_DATA = @INSTALL_DATA@
37 # main GDB source directory
40 # where to find texinfo; GDB dist should include a recent one
41 TEXIDIR=${gdbdir}/../texinfo
43 # where to find makeinfo, preferably one designed for texinfo-2
46 # Note that texinfo 4.0's makeinfo --html can only generate a
47 # single file, which would be too large, so continue to use
48 # texi2html. -sts 2000-03-28
51 MAKEHTMLFLAGS = -menu -split_chapter
53 # where to find texi2roff, ditto
56 # where to find texi2dvi, ditto
59 # Where is the source dir for the READLINE library doc?
60 # Traditionally readline is in .. or .
61 READLINE_DIR = ${gdbdir}/../readline/doc
63 # The GDB/MI docs come from a sibling directory ../mi
64 GDBMI_DIR = ${gdbdir}/mi
67 TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS
69 # Files which should be generated via 'info' and installed by 'install-info'
70 INFO_DEPS = gdb.info gdbint.info stabs.info
72 # There may be alternate predefined collections of switches to configure
73 # the GDB manual. Normally this is not done in synch with the software
74 # config system, since this choice tends to be independent; most people
75 # want a doc config of `all' for a generic manual, regardless of sw config.
78 # This list of sed edits will edit the GDB reference card
79 # for what fonts and what papersize to use.
80 # By default (NO edits applied), the refcard uses:
81 # - Computer Modern (CM) fonts
82 # - US letter paper (8.5x11in)
83 # List some of the following files for alternative fonts and paper:
84 # a4rc.sed use A4 paper (297 x 210 mm)
85 # psrc.sed use PostScript fonts (Karl Berry short TeX names)
86 # lpsrc.sed use PostScript fonts (full PostScript names in TeX)
87 # e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
88 # for A4, CM fonts: REFEDITS = a4rc.sed
89 # for US, PS fonts: REFEDITS = psrc.sed
93 # Don Knuth's TeX formatter
96 # Program to generate Postscript files from DVI files.
100 GDB_DOC_SOURCE_INCLUDES = \
103 $(READLINE_DIR)/rluser.texinfo \
104 $(READLINE_DIR)/inc-hist.texinfo
105 GDB_DOC_BUILD_INCLUDES = \
109 $(srcdir)/gdb.texinfo \
110 $(GDB_DOC_SOURCE_INCLUDES) \
111 $(GDB_DOC_BUILD_INCLUDES)
114 GDBINT_DOC_SOURCE_INCLUDES = \
116 $(srcdir)/observer.texi
117 GDBINT_DOC_BUILD_INCLUDES = \
121 $(srcdir)/gdbint.texinfo \
122 $(GDBINT_DOC_SOURCE_INCLUDES) \
123 $(GDBINT_DOC_BUILD_INCLUDES)
125 # Stabs manual: All files
126 STABS_DOC_SOURCE_INCLUDES =
127 STABS_DOC_BUILD_INCLUDES =
129 $(srcdir)/stabs.texinfo \
130 $(STABS_DOC_SOURCE_INCLUDES) \
131 $(STABS_DOC_BUILD_INCLUDES)
133 #### Host, target, and site specific Makefile fragments come in here.
139 dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
140 ps: gdb.ps gdbint.ps stabs.ps refcard.ps
141 html: gdb_toc.html gdbint_toc.html stabs_toc.html
142 pdf: gdb.pdf gdbint.pdf stabs.pdf
143 all-doc: info dvi ps # pdf
146 install-info: $(INFO_DEPS)
147 $(SHELL) $(srcdir)/../../mkinstalldirs $(infodir)
148 @list='$(INFO_DEPS)'; \
149 for file in $$list; do \
150 if test -f $$file; then d=.; else d=$(srcdir); fi; \
151 for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
152 if test -f $$d/$$ifile; then \
153 echo " $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile"; \
154 $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile; \
159 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
160 list='$(INFO_DEPS)'; \
161 for file in $$list; do \
162 echo " install-info --info-dir=$(infodir) $(infodir)/$$file";\
163 install-info --info-dir=$(infodir) $(infodir)/$$file || :;\
169 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
172 list='$(INFO_DEPS)'; \
173 for file in $$list; do \
175 || install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \
178 list='$(INFO_DEPS)'; \
179 for file in $$list; do \
180 (cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \
184 for i in *.html ; do \
185 $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
188 STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
190 # Copy the object files from a particular stage into a subdirectory.
193 -mv $(STAGESTUFF) stage1
197 -mv $(STAGESTUFF) stage2
201 -mv $(STAGESTUFF) stage3
206 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
209 -(cd stage1 ; mv -f * ..)
213 -(cd stage2 ; mv -f * ..)
217 -(cd stage3 ; mv -f * ..)
220 # GDB QUICK REFERENCE (dvi output)
221 refcard.dvi : refcard.tex $(REFEDITS)
223 for f in x $(REFEDITS) ; do \
224 test x$$f = xx && continue ; \
225 cat $(srcdir)/$$f >>tmp.sed ; \
227 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
228 $(SET_TEXINPUTS) $(TEX) sedref.tex
229 mv sedref.dvi refcard.dvi
230 rm -f sedref.log sedref.tex tmp.sed
232 refcard.ps : refcard.dvi
233 $(DVIPS) -t landscape -o $@ $?
235 # File to record current GDB version number (copied from main dir version.in)
236 GDBvn.texi : ${gdbdir}/version.in
237 echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new
238 mv GDBvn.new GDBvn.texi
241 .PRECIOUS: GDBvn.texi
243 # Choose configuration for GDB manual (normally `all'; normally not tied into
244 # `configure' script because most users prefer generic version of manual,
245 # not one for their binary config---which may not be specifically
247 gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
248 (test "$(LN_S)" = "ln -s" && \
249 ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
250 ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
251 cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
253 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
254 # If your texinfo or makeinfo don't support these, get a new texinfo release
256 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
257 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
258 # source directory for the benefit of people who *don't* use this makefile,
259 # VPATH will often tell make not to bother building it, because the one
260 # in the srcdir is up to date. (if not, then make should build one here).
262 # Clean these up before each run. Avoids a catch 22 with not being
263 # able to re-generate these files (to fix a corruption) because these
264 # files contain a corruption.
265 GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
268 # GDB MANUAL: TeX dvi file
269 gdb.dvi: ${GDB_DOC_FILES}
270 if [ ! -f ./GDBvn.texi ]; then \
271 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
272 ln $(srcdir)/GDBvn.texi . || \
273 cp $(srcdir)/GDBvn.texi . ; else true; fi
274 rm -f $(GDB_TEX_TMPS)
275 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo
280 gdb.pdf: ${GDB_DOC_FILES}
281 if [ ! -f ./GDBvn.texi ]; then \
282 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
283 ln $(srcdir)/GDBvn.texi . || \
284 cp $(srcdir)/GDBvn.texi . ; else true; fi
285 rm -f $(GDB_TEX_TMPS)
286 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo
288 # GDB MANUAL: info file
289 gdb.info: ${GDB_DOC_FILES}
290 $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
291 -o gdb.info $(srcdir)/gdb.texinfo
293 # GDB MANUAL: roff translations
294 # Try to use a recent texi2roff. v2 was put on prep in jan91.
295 # If you want an index, see texi2roff doc for postprocessing
296 # and add -i to texi2roff invocations below.
297 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
298 # corresponding -e lines when later texi2roff's are current)
299 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
300 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
301 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
302 # + @alphaenumerate is ridiculously new, turned into @enumerate
304 # texi2roff doesn't have a notion of include dirs, so we have to fake
305 # it out for gdb manual's include files---but only if not configured
307 links2roff: $(GDB_DOC_SOURCE_INCLUDES)
308 if [ ! -f gdb.texinfo ]; then \
309 (test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
310 ln $(GDB_DOC_SOURCE_INCLUDES) . || \
311 cp $(GDB_DOC_SOURCE_INCLUDES) . ; \
315 # gdb manual suitable for [gtn]roff -me
316 gdb.me: $(GDB_DOC_FILES) links2roff
317 sed -e '/\\input texinfo/d' \
318 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
319 -e '/^@ifinfo/,/^@end ifinfo/d' \
323 -e 's/^@alphaenumerate/@enumerate/g' \
324 -e 's/^@end alphaenumerate/@end enumerate/g' \
325 $(srcdir)/gdb.texinfo | \
327 sed -e 's/---/\\(em/g' \
330 # gdb manual suitable for [gtn]roff -ms
331 gdb.ms: $(GDB_DOC_FILES) links2roff
332 sed -e '/\\input texinfo/d' \
333 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
334 -e '/^@ifinfo/,/^@end ifinfo/d' \
338 -e 's/^@alphaenumerate/@enumerate/g' \
339 -e 's/^@end alphaenumerate/@end enumerate/g' \
340 $(srcdir)/gdb.texinfo | \
342 sed -e 's/---/\\(em/g' \
345 # gdb manual suitable for [tn]roff -mm
346 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
347 # try leaving them in
348 gdb.mm: $(GDB_DOC_FILES) links2roff
349 sed -e '/\\input texinfo/d' \
350 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
351 -e '/^@ifinfo/,/^@end ifinfo/d' \
356 -e 's/^@alphaenumerate/@enumerate/g' \
357 -e 's/^@end alphaenumerate/@end enumerate/g' \
358 $(srcdir)/gdb.texinfo | \
360 sed -e 's/---/\\(em/g' \
363 # GDB MANUAL: HTML file
365 gdb_toc.html: ${GDB_DOC_FILES}
366 $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
368 # Clean these up before each run. Avoids a catch 22 with not being
369 # able to re-generate these files (to fix a corruption) because these
370 # files contain a corruption.
371 GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
372 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
374 # GDB INTERNALS MANUAL: TeX dvi file
375 gdbint.dvi: $(GDBINT_DOC_FILES)
376 rm -f $(GDBINT_TEX_TMPS)
377 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo
379 gdbint.ps : gdbint.dvi
382 gdbint.pdf: $(GDBINT_DOC_FILES)
383 rm -f $(GDBINT_TEX_TMPS)
384 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo
386 # GDB INTERNALS MANUAL: info file
388 gdbint.info: $(GDBINT_DOC_FILES)
389 $(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo
391 # GDB INTERNALS MANUAL: HTML file
393 gdbint_toc.html: $(GDBINT_DOC_FILES)
394 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
396 stabs.info: $(STABS_DOC_FILES)
397 $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
399 # STABS DOCUMENTATION: HTML file
401 stabs_toc.html: $(STABS_DOC_FILES)
402 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
404 # Clean these up before each run. Avoids a catch 22 with not being
405 # able to re-generate these files (to fix a corruption) because these
406 # files contain a corruption.
407 STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
408 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
410 # STABS DOCUMENTATION: TeX dvi file
411 stabs.dvi : $(STABS_DOC_FILES)
412 rm -f $(STABS_TEX_TMPS)
413 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo
418 stabs.pdf: $(STABS_DOC_FILES)
419 rm -f $(STABS_TEX_TMPS)
420 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo
424 Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
425 $(SHELL) ./config.status
428 # The "least clean" level of cleaning. Get rid of files which are
429 # automatically generated files that are just intermediate files,
432 rm -f gdb.mm gdb.ms gdb.me links2roff
433 rm -f $(GDB_TEX_TMPS)
434 rm -f $(GDBINT_TEX_TMPS)
435 rm -f $(STABS_TEX_TMPS)
436 rm -f sedref.dvi sedref.tex tmp.sed
442 rm -f Makefile config.status config.log
444 # GDBvn.texi, the dvi files, the info files, and the postscript files,
445 # are all part of the distribution, so it should not be removed by
446 # "clean" or "distclean". Use maintainer-clean to remove them.
448 maintainer-clean realclean: distclean
449 rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf
451 install: install-info
453 uninstall: uninstall-info