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
= \
101 $(srcdir)/annotate.texi \
104 $(GDBMI_DIR
)/gdbmi.texinfo \
105 $(READLINE_DIR
)/rluser.texinfo \
106 $(READLINE_DIR
)/inc-hist.texinfo
107 GDB_DOC_BUILD_INCLUDES
= \
111 $(srcdir)/gdb.texinfo \
112 $(GDB_DOC_SOURCE_INCLUDES
) \
113 $(GDB_DOC_BUILD_INCLUDES
)
116 GDBINT_DOC_SOURCE_INCLUDES
= \
118 GDBINT_DOC_BUILD_INCLUDES
= \
122 $(srcdir)/gdbint.texinfo \
123 $(GDBINT_DOC_SOURCE_INCLUDES
) \
124 $(GDBINT_DOC_BUILD_INCLUDES
)
126 # Stabs manual: All files
127 STABS_DOC_SOURCE_INCLUDES
=
128 STABS_DOC_BUILD_INCLUDES
=
130 $(srcdir)/stabs.texinfo \
131 $(STABS_DOC_SOURCE_INCLUDES
) \
132 $(STABS_DOC_BUILD_INCLUDES
)
134 #### Host, target, and site specific Makefile fragments come in here.
140 dvi: gdb.
dvi gdbint.
dvi stabs.
dvi refcard.
dvi
141 ps
: gdb.ps gdbint.ps stabs.ps refcard.ps
142 html
: gdb_toc.html gdbint_toc.html stabs_toc.html
143 pdf
: gdb.pdf gdbint.pdf stabs.pdf
144 all-doc
: info dvi ps
# pdf
147 install-info
: $(INFO_DEPS
)
148 $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
$(infodir)
149 @list
='$(INFO_DEPS)'; \
150 for file in
$$list; do \
151 if
test -f
$$file; then d
=.
; else d
=$(srcdir); fi
; \
152 for ifile in
`cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
153 if
test -f
$$d/$$ifile; then \
154 echo
" $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile"; \
155 $(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 ||
:;\
168 for i in
*.html
; do \
169 $(INSTALL_DATA
) $$i $(htmldir
)/$$i ; \
172 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
*.ps
*.
dvi *.pdf
174 # Copy the object files from a particular stage into a subdirectory.
177 -mv
$(STAGESTUFF
) stage1
181 -mv
$(STAGESTUFF
) stage2
185 -mv
$(STAGESTUFF
) stage3
190 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
193 -(cd stage1
; mv
-f
* ..
)
197 -(cd stage2
; mv
-f
* ..
)
201 -(cd stage3
; mv
-f
* ..
)
204 # GDB QUICK REFERENCE (dvi output)
205 refcard.
dvi : refcard.
tex $(REFEDITS
)
207 for f in x
$(REFEDITS
) ; do \
208 test x
$$f = xx
&& continue
; \
209 cat
$(srcdir)/$$f >>tmp.sed
; \
211 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
212 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
213 mv sedref.
dvi refcard.
dvi
214 rm -f sedref.log sedref.
tex tmp.sed
216 refcard.ps
: refcard.
dvi
217 $(DVIPS
) -t landscape
-o
$@
$?
219 # File to record current GDB version number (copied from main dir version.in)
220 GDBvn.texi
: ${gdbdir}/version.in
221 echo
"@set GDBVN `sed q $(srcdir)/../version.in`" > .
/GDBvn.new
222 mv GDBvn.new GDBvn.texi
225 .PRECIOUS
: GDBvn.texi
227 # Choose configuration for GDB manual (normally `all'; normally not tied into
228 # `configure' script because most users prefer generic version of manual,
229 # not one for their binary config---which may not be specifically
231 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
232 (test "$$LN_S" = "ln -s" && \
233 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
) || \
234 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
235 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
237 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
238 # If your texinfo or makeinfo don't support these, get a new texinfo release
240 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
241 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
242 # source directory for the benefit of people who *don't* use this makefile,
243 # VPATH will often tell make not to bother building it, because the one
244 # in the srcdir is up to date. (if not, then make should build one here).
246 # Clean these up before each run. Avoids a catch 22 with not being
247 # able to re-generate these files (to fix a corruption) because these
248 # files contain a corruption.
249 GDB_TEX_TMPS
= gdb.aux gdb.cp
* gdb.fn
* gdb.ky
* gdb.log gdb.pg
* gdb.toc \
252 # GDB MANUAL: TeX dvi file
253 gdb.
dvi: ${GDB_DOC_FILES}
254 if
[ ! -f .
/GDBvn.texi
]; then \
255 (test "$$LN_S" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
256 ln
$(srcdir)/GDBvn.texi . || \
257 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
258 rm -f
$(GDB_TEX_TMPS
)
259 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdb.texinfo
264 gdb.pdf
: ${GDB_DOC_FILES}
265 if
[ ! -f .
/GDBvn.texi
]; then \
266 (test "$$LN_S" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
267 ln
$(srcdir)/GDBvn.texi . || \
268 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
269 rm -f
$(GDB_TEX_TMPS
)
270 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdb.texinfo
272 # GDB MANUAL: info file
273 gdb.
info: ${GDB_DOC_FILES}
274 $(MAKEINFO
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) \
275 -o gdb.
info $(srcdir)/gdb.texinfo
277 # GDB MANUAL: roff translations
278 # Try to use a recent texi2roff. v2 was put on prep in jan91.
279 # If you want an index, see texi2roff doc for postprocessing
280 # and add -i to texi2roff invocations below.
281 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
282 # corresponding -e lines when later texi2roff's are current)
283 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
284 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
285 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
286 # + @alphaenumerate is ridiculously new, turned into @enumerate
288 # texi2roff doesn't have a notion of include dirs, so we have to fake
289 # it out for gdb manual's include files---but only if not configured
291 links2roff
: $(GDB_DOC_SOURCE_INCLUDES
)
292 if
[ ! -f gdb.texinfo
]; then \
293 (test "$$LN_S" = "ln -s" && ln
-s
$(GDB_DOC_SOURCE_INCLUDES
) .
) || \
294 ln
$(GDB_DOC_SOURCE_INCLUDES
) . || \
295 cp
$(GDB_DOC_SOURCE_INCLUDES
) .
; \
299 # gdb manual suitable for [gtn]roff -me
300 gdb.me
: $(GDB_DOC_FILES
) links2roff
301 sed
-e
'/\\input texinfo/d' \
302 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
303 -e
'/^@ifinfo/,/^@end ifinfo/d' \
307 -e
's/^@alphaenumerate/@enumerate/g' \
308 -e
's/^@end alphaenumerate/@end enumerate/g' \
309 $(srcdir)/gdb.texinfo | \
311 sed
-e
's/---/\\(em/g' \
314 # gdb manual suitable for [gtn]roff -ms
315 gdb.ms
: $(GDB_DOC_FILES
) links2roff
316 sed
-e
'/\\input texinfo/d' \
317 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
318 -e
'/^@ifinfo/,/^@end ifinfo/d' \
322 -e
's/^@alphaenumerate/@enumerate/g' \
323 -e
's/^@end alphaenumerate/@end enumerate/g' \
324 $(srcdir)/gdb.texinfo | \
326 sed
-e
's/---/\\(em/g' \
329 # gdb manual suitable for [tn]roff -mm
330 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
331 # try leaving them in
332 gdb.mm
: $(GDB_DOC_FILES
) links2roff
333 sed
-e
'/\\input texinfo/d' \
334 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
335 -e
'/^@ifinfo/,/^@end ifinfo/d' \
340 -e
's/^@alphaenumerate/@enumerate/g' \
341 -e
's/^@end alphaenumerate/@end enumerate/g' \
342 $(srcdir)/gdb.texinfo | \
344 sed
-e
's/---/\\(em/g' \
347 # GDB MANUAL: HTML file
349 gdb_toc.html
: ${GDB_DOC_FILES}
350 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) $(srcdir)/gdb.texinfo
352 # Clean these up before each run. Avoids a catch 22 with not being
353 # able to re-generate these files (to fix a corruption) because these
354 # files contain a corruption.
355 GDBINT_TEX_TMPS
= gdbint.aux gdbint.cp
* gdbint.fn
* gdbint.ky
* \
356 gdbint.log gdbint.pg
* gdbint.toc gdbint.tp
* gdbint.vr
*
358 # GDB INTERNALS MANUAL: TeX dvi file
359 gdbint.
dvi: $(GDBINT_DOC_FILES
)
360 rm -f
$(GDBINT_TEX_TMPS
)
361 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdbint.texinfo
363 gdbint.ps
: gdbint.
dvi
366 gdbint.pdf
: $(GDBINT_DOC_FILES
)
367 rm -f
$(GDBINT_TEX_TMPS
)
368 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdbint.texinfo
370 # GDB INTERNALS MANUAL: info file
372 gdbint.
info: $(GDBINT_DOC_FILES
)
373 $(MAKEINFO
) -I
$(srcdir) -o gdbint.
info $(srcdir)/gdbint.texinfo
375 # GDB INTERNALS MANUAL: HTML file
377 gdbint_toc.html
: $(GDBINT_DOC_FILES
)
378 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/gdbint.texinfo
380 stabs.
info: $(STABS_DOC_FILES
)
381 $(MAKEINFO
) -o stabs.
info $(srcdir)/stabs.texinfo
383 # STABS DOCUMENTATION: HTML file
385 stabs_toc.html
: $(STABS_DOC_FILES
)
386 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/stabs.texinfo
388 # Clean these up before each run. Avoids a catch 22 with not being
389 # able to re-generate these files (to fix a corruption) because these
390 # files contain a corruption.
391 STABS_TEX_TMPS
= stabs.aux stabs.cp
* stabs.fn
* stabs.ky
* \
392 stabs.log stabs.pg
* stabs.toc stabs.tp
* stabs.vr
*
394 # STABS DOCUMENTATION: TeX dvi file
395 stabs.
dvi : $(STABS_DOC_FILES
)
396 rm -f
$(STABS_TEX_TMPS
)
397 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/stabs.texinfo
402 stabs.pdf
: $(STABS_DOC_FILES
)
403 rm -f
$(STABS_TEX_TMPS
)
404 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/stabs.texinfo
408 Makefile
: Makefile.in
$(host_makefile_frag
) $(target_makefile_frag
) config.status
409 $(SHELL
) .
/config.status
412 # The "least clean" level of cleaning. Get rid of files which are
413 # automatically generated files that are just intermediate files,
416 rm -f gdb.mm gdb.ms gdb.me links2roff
417 rm -f
$(GDB_TEX_TMPS
)
418 rm -f
$(GDBINT_TEX_TMPS
)
419 rm -f
$(STABS_TEX_TMPS
)
420 rm -f sedref.
dvi sedref.
tex tmp.sed
426 rm -f Makefile config.status
428 # GDBvn.texi, the dvi files, the info files, and the postscript files,
429 # are all part of the distribution, so it should not be removed by
430 # "clean" or "distclean". Use maintainer-clean to remove them.
432 maintainer-clean
realclean: distclean
433 rm -f GDBvn.texi
*.
info* *.
dvi *.ps
*.html
*.pdf