import gdb-1999-08-16 snapshot
[deliverable/binutils-gdb.git] / gdb / doc / Makefile.in
CommitLineData
c906108c
SS
1##Copyright (C) 1991, 1992, 1999 Free Software Foundation, Inc.
2
3# Makefile for GDB documentation.
4# This file is part of GDB.
5
6# This program is free software; you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation; either version 2 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program; if not, write to the Free Software
18# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19
20srcdir = @srcdir@
21VPATH = @srcdir@
22
23prefix = @prefix@
24
25infodir = @infodir@
085dd6e6 26htmldir = $(prefix)/html
c906108c
SS
27
28SHELL = @SHELL@
29
30INSTALL = @INSTALL@
31INSTALL_PROGRAM = @INSTALL_PROGRAM@
32INSTALL_DATA = @INSTALL_DATA@
33
34# main GDB source directory
35gdbdir = $(srcdir)/..
36
37# where to find texinfo; GDB dist should include a recent one
38TEXIDIR=${gdbdir}/../texinfo
39
40# where to find makeinfo, preferably one designed for texinfo-2
41MAKEINFO=makeinfo
42
085dd6e6
JM
43MAKEHTML = texi2html
44MAKEHTMLFLAGS = -glossary -menu -split_chapter
45
c906108c
SS
46# where to find texi2roff, ditto
47TEXI2ROFF=texi2roff
48
49# Where is the source dir for the READLINE library doc?
50# Traditionally readline is in .. or .
51READLINE_DIR = ${gdbdir}/../readline/doc
52
53SET_TEXINPUTS = TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$$TEXINPUTS
54
55# There may be alternate predefined collections of switches to configure
56# the GDB manual. Normally this is not done in synch with the software
57# config system, since this choice tends to be independent; most people
58# want a doc config of `all' for a generic manual, regardless of sw config.
59DOC_CONFIG = all
60
61# This list of sed edits will edit the GDB reference card
62# for what fonts and what papersize to use.
63# By default (NO edits applied), the refcard uses:
64# - Computer Modern (CM) fonts
65# - US letter paper (8.5x11in)
66# List some of the following files for alternative fonts and paper:
67# a4rc.sed use A4 paper (297 x 210 mm)
68# psrc.sed use PostScript fonts (Karl Berry short TeX names)
69# lpsrc.sed use PostScript fonts (full PostScript names in TeX)
70# e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
71# for A4, CM fonts: REFEDITS = a4rc.sed
72# for US, PS fonts: REFEDITS = psrc.sed
73# for default:
74REFEDITS =
75
76# Don Knuth's TeX formatter
77TEX = tex
78
79# auxiliary program for sorting Texinfo indices
80TEXINDEX = texindex
81
82# Program to generate Postscript files from DVI files.
83DVIPS = dvips
84
85# Main GDB manual's source files
86SFILES_INCLUDED = gdb-cfg.texi $(srcdir)/remote.texi
87
88SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED)
89
90SFILES_DOC = $(SFILES_LOCAL) \
7be570e7 91 $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texinfo
c906108c
SS
92
93#### Host, target, and site specific Makefile fragments come in here.
94###
95
96all install:
97
98info: gdb.info gdbint.info stabs.info
99dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
100ps: gdb.ps gdbint.ps stabs.ps refcard.ps
085dd6e6 101html: gdb_toc.html gdbint_toc.html stabs_toc.html
c906108c
SS
102all-doc: info dvi ps
103
104install-info: info
105 for i in *.info* ; do \
106 $(INSTALL_DATA) $$i $(infodir)/$$i ; \
107 done
108
085dd6e6
JM
109install-html: html
110 for i in *.html ; do \
111 $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
112 done
113
c906108c
SS
114STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi
115
116# Copy the object files from a particular stage into a subdirectory.
117stage1: force
118 -mkdir stage1
119 -mv $(STAGESTUFF) stage1
120
121stage2: force
122 -mkdir stage2
123 -mv $(STAGESTUFF) stage2
124
125stage3: force
126 -mkdir stage3
127 -mv $(STAGESTUFF) stage3
128
129against=stage2
130
131comparison: force
132 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
133
134de-stage1: force
135 -(cd stage1 ; mv -f * ..)
136 -rmdir stage1
137
138de-stage2: force
139 -(cd stage2 ; mv -f * ..)
140 -rmdir stage2
141
142de-stage3: force
143 -(cd stage3 ; mv -f * ..)
144 -rmdir stage3
145
146# The "least clean" level of cleaning. Get rid of files which are
147# automatically generated files that are just intermediate files,
148#
149mostlyclean:
150 rm -f gdb.mm gdb.ms gdb.me links2roff
151 rm -f *.aux *.cp* *.fn* *.ky* *.log *.pg* *.toc *.tp* *.vr*
152 rm -f sedref.dvi sedref.tex tmp.sed
153
154clean: mostlyclean
7be570e7 155 rm -f rluser.texinfo inc-hist.texinfo gdb-cfg.texi
c906108c
SS
156
157distclean: clean
158 rm -f Makefile config.status
159
160# GDBvn.texi, the dvi files, the info files, and the postscript files,
161# are all part of the distribution, so it should not be removed by
162# "clean" or "distclean". Use maintainer-clean to remove them.
163
164maintainer-clean realclean: distclean
085dd6e6 165 rm -f GDBvn.texi *.info* *.dvi *.ps *.html
c906108c
SS
166
167# GDB QUICK REFERENCE (dvi output)
168refcard.dvi : refcard.tex $(REFEDITS)
169 if [ -z "$(REFEDITS)" ]; then \
170 cp $(srcdir)/refcard.tex sedref.tex ; \
171 else \
172 echo > tmp.sed ; \
173 for f in "$(REFEDITS)" ; do \
174 cat $(srcdir)/$$f >>tmp.sed ; done ; \
175 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex ; \
176 fi
177 $(SET_TEXINPUTS) $(TEX) sedref.tex
178 mv sedref.dvi refcard.dvi
179 rm -f sedref.log sedref.tex tmp.sed
180
181refcard.ps : refcard.dvi
182 $(DVIPS) -t landscape -o $@ $?
183
184# File to record current GDB version number (copied from main dir Makefile.in)
185GDBvn.texi : ${gdbdir}/Makefile.in
186 echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/^VERSION *= *//p'`" > ./GDBvn.new
187 mv GDBvn.new GDBvn.texi
188
189# Updated atomically
190.PRECIOUS: GDBvn.texi
191
192# Choose configuration for GDB manual (normally `all'; normally not tied into
193# `configure' script because most users prefer generic version of manual,
194# not one for their binary config---which may not be specifically
195# defined anyways).
196gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
197 ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
198 ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
199 cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
200
201# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
202# If your texinfo or makeinfo don't support these, get a new texinfo release
203#
204# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
205# Note that we can *generate* GDBvn.texi, but since we distribute one in the
206# source directory for the benefit of people who *don't* use this makefile,
207# VPATH will often tell make not to bother building it, because the one
208# in the srcdir is up to date. (if not, then make should build one here).
209
210# GDB MANUAL: TeX dvi file
211gdb.dvi: ${SFILES_DOC}
212 if [ ! -f ./GDBvn.texi ]; then \
213 ln -s $(srcdir)/GDBvn.texi . || \
214 ln $(srcdir)/GDBvn.texi . || \
215 cp $(srcdir)/GDBvn.texi . ; else true; fi
216 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
217 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
218 $(TEXINDEX) gdb.??
219 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
220 rm -f gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
221 gdb.tp* gdb.vr*
222
223gdb.ps: gdb.dvi
224 $(DVIPS) -o $@ $?
225
226# GDB MANUAL: info file
227# We're using texinfo2, and older makeinfo's may not be able to
228# cope with all the markup.
229gdb.info: ${SFILES_DOC}
230 $(MAKEINFO) -I ${READLINE_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo
231
232# GDB MANUAL: roff translations
233# Try to use a recent texi2roff. v2 was put on prep in jan91.
234# If you want an index, see texi2roff doc for postprocessing
235# and add -i to texi2roff invocations below.
236# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
237# corresponding -e lines when later texi2roff's are current)
238# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
239# + @c's deleted explicitly because texi2roff sees texinfo commands in them
240# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
241# + @alphaenumerate is ridiculously new, turned into @enumerate
242
243# texi2roff doesn't have a notion of include dirs, so we have to fake
244# it out for gdb manual's include files---but only if not configured
245# in main sourcedir.
246links2roff: $(SFILES_INCLUDED)
247 if [ ! -f gdb.texinfo ]; then \
248 ln -s $(SFILES_INCLUDED) . || \
249 ln $(SFILES_INCLUDED) . || \
250 cp $(SFILES_INCLUDED) . ; \
251 fi
252 touch links2roff
253
254# "Readline" appendices. Get them also due to lack of includes,
255# regardless of whether or not configuring in main sourcedir.
256# @ftable removed due to bug in texi2roff-2; if your texi2roff
257# is newer, try just ln or cp
258rluser.texinfo: ${READLINE_DIR}/rluser.texinfo
259 sed -e 's/^@ftable/@table/g' \
260 -e 's/^@end ftable/@end table/g' \
261 ${READLINE_DIR}/rluser.texinfo > ./rluser.texinfo
262
7be570e7
JM
263inc-hist.texinfo: ${READLINE_DIR}/inc-hist.texinfo
264 ln -s ${READLINE_DIR}/inc-hist.texinfo . || \
265 ln ${READLINE_DIR}/inc-hist.texinfo . || \
266 cp ${READLINE_DIR}/inc-hist.texinfo .
c906108c
SS
267
268# gdb manual suitable for [gtn]roff -me
7be570e7 269gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
c906108c
SS
270 sed -e '/\\input texinfo/d' \
271 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
272 -e '/^@ifinfo/,/^@end ifinfo/d' \
273 -e '/^@c /d' \
274 -e 's/{.*,,/{/' \
275 -e 's/@ / /g' \
276 -e 's/^@alphaenumerate/@enumerate/g' \
277 -e 's/^@end alphaenumerate/@end enumerate/g' \
278 $(srcdir)/gdb.texinfo | \
279 $(TEXI2ROFF) -me | \
280 sed -e 's/---/\\(em/g' \
281 >gdb.me
282
283# gdb manual suitable for [gtn]roff -ms
7be570e7 284gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
c906108c
SS
285 sed -e '/\\input texinfo/d' \
286 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
287 -e '/^@ifinfo/,/^@end ifinfo/d' \
288 -e '/^@c /d' \
289 -e 's/{.*,,/{/' \
290 -e 's/@ / /g' \
291 -e 's/^@alphaenumerate/@enumerate/g' \
292 -e 's/^@end alphaenumerate/@end enumerate/g' \
293 $(srcdir)/gdb.texinfo | \
294 $(TEXI2ROFF) -ms | \
295 sed -e 's/---/\\(em/g' \
296 >gdb.ms
297
298# gdb manual suitable for [tn]roff -mm
299# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
300# try leaving them in
7be570e7 301gdb.mm: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texinfo
c906108c
SS
302 sed -e '/\\input texinfo/d' \
303 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
304 -e '/^@ifinfo/,/^@end ifinfo/d' \
305 -e '/^@c /d' \
306 -e 's/{.*,,/{/' \
307 -e '/@noindent/d' \
308 -e 's/@ / /g' \
309 -e 's/^@alphaenumerate/@enumerate/g' \
310 -e 's/^@end alphaenumerate/@end enumerate/g' \
311 $(srcdir)/gdb.texinfo | \
312 $(TEXI2ROFF) -mm | \
313 sed -e 's/---/\\(em/g' \
314 >gdb.mm
315
085dd6e6
JM
316# GDB MANUAL: HTML file
317
318gdb_toc.html: ${SFILES_DOC}
319 $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
320
c906108c
SS
321
322# GDB INTERNALS MANUAL: TeX dvi file
323gdbint.dvi : gdbint.texinfo
324 $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
325 $(TEXINDEX) gdbint.??
326 $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
327 rm -f gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
328 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
329
330gdbint.ps : gdbint.dvi
331 $(DVIPS) -o $@ $?
332
333# GDB INTERNALS MANUAL: info file
334
335gdbint.info: gdbint.texinfo
336 $(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo
337
085dd6e6
JM
338# GDB INTERNALS MANUAL: HTML file
339
340gdbint_toc.html: gdbint.texinfo
341 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
342
c906108c
SS
343stabs.info: stabs.texinfo
344 $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
345
085dd6e6
JM
346# STABS DOCUMENTATION: HTML file
347
348stabs_toc.html: stabs.texinfo
349 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
350
c906108c
SS
351# STABS DOCUMENTATION: TeX dvi file
352stabs.dvi : stabs.texinfo
353 $(SET_TEXINPUTS) $(TEX) stabs.texinfo
354 $(TEXINDEX) stabs.??
355 $(SET_TEXINPUTS) $(TEX) stabs.texinfo
356 rm -f stabs.aux stabs.cp* stabs.fn* stabs.ky* \
357 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
358
359stabs.ps: stabs.dvi
360 $(DVIPS) -o $@ $?
361
362force:
363
364Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
365 $(SHELL) ./config.status
This page took 0.045292 seconds and 4 git commands to generate.