Debian Codegraph @

manuals/Makefile

raw ◀ ▶
1 Debian patch touch this file
1 #
2 # manual.env file is a local file to define specific values if any
3 # manual.env.dist is a template for it.
4 MANUALENVFILE=manual.env
5 ENVFILE=$(shell [ -e ./$(MANUALENVFILE) ] && echo "OK")
6 ifeq ($(ENVFILE),OK)
7 include $(MANUALENVFILE)
8 REALMANUALENV=$(realpath ./$(MANUALENVFILE))
9 else
10 $(error No environment file "$(MANUALENVFILE)" found. You can copy "$(MANUALENVFILE).dist" to "$(MANUALENVFILE)" and adjust some definitions.)
11 endif
12
•13 # if BUILD_VERBOSE is set to 1, output everything to the console
14 ifeq ($(BUILD_VERBOSE),1)
15 AT=
16 else
17 AT=@
18 endif
19
20 #
21 # WARNING !!! The following works *ONLY* when using MAKE with $(MAKE) -C subdir invocation.
22 LICENCE_FILES=$(wildcard $(LICENCE_DIR)/*.tex)
23 WWW_DIR=./www-$(DOC)
24 HTML_DIR=$(abspath ./html)
25 export HTML_DIR
26 TEX_FILES=$(wildcard *tex)
27 WEB_FILES_TO_LINK=$(TRANSLATEIMGS) $(LATEX2HTMLINIT)
28 #
29 # pdflatex commands and/or compilation directives
30 PDFLATEX=$(COMPILER)
31 PDFLATEXSILENT=batchmode
32 PDFLATEXVERBOSE=errorstopmode
•33 ifeq ($(BUILD_VERBOSE),1)
34 PDFLATEXOPTIONS=-halt-on-error -interaction=$(PDFLATEXVERBOSE)
35 PDFOUTPUT=""
36 else
37 PDFLATEXOPTIONS=-halt-on-error -interaction=$(PDFLATEXSILENT)
38 PDFOUTPUT="> $(DOC).out 2>&1"
39 endif
40
41 #
42 # Makefile used to produce HTML documentation
43 EXTSEDFILES=html-external-references.sed
44 INTSEDFILE=html-internal-references.sed
45
46 first_rule: all
47
48 # special option for pdflatex to find custom shared tex libraries
49 TEXINPUTS=.:$(LATEX_DIR)://:
50 export TEXINPUTS
51
52 ifeq ($(DOC),main)
53 TLS=extract-tls
54 CLEANTLS=cleantls
55 else
56 TLS=
57 CLEANTLS=
58 endif
59
60 all: $(TLS) pdflatex web mini-clean
61
62 extract-tls: tls.tex
63 $(TOOLS_DIR)/extract.pl TLS FileDaemon:FileDaemon tls.tex > FileDaemonFileDaemonTls.tex
64 $(TOOLS_DIR)/extract.pl TLS FileDaemon:Director tls.tex > FileDaemonDirectorTls.tex
65 $(TOOLS_DIR)/extract.pl TLS Storage:Storage tls.tex > StorageStorageTls.tex
66 $(TOOLS_DIR)/extract.pl TLS Storage:Director tls.tex > StorageDirectorTls.tex
67 $(TOOLS_DIR)/extract.pl TLS Console:Console tls.tex > ConsoleConsoleTls.tex
68 $(TOOLS_DIR)/extract.pl TLS Console:Director tls.tex > ConsoleDirectorTls.tex
69 $(TOOLS_DIR)/extract.pl TLS Director:Client tls.tex > DirectorClientTls.tex
70 $(TOOLS_DIR)/extract.pl TLS Director:Console tls.tex > DirectorConsoleTls.tex
71 $(TOOLS_DIR)/extract.pl TLS Director:Storage tls.tex > DirectorStorageTls.tex
72 $(TOOLS_DIR)/extract.pl TLS Director:Director tls.tex > DirectorDirectorTls.tex
73 touch extract-tls
74
75
76
77
78 .SUFFIXES: .tex .html
79 .PHONY:
80 .DONTCARE:
81
82 verbose:
83 $(AT)echo "SVG Covers dir:" $(SVGCOVERS_DIR)
84 $(AT)echo "PDF Covers dir:" $(PDFCOVERS_DIR)
85 $(AT)echo "Coverpage name:" $(COVERPAGE_NAME)
86 $(AT)echo "LaTeX dir:" $(LATEX_DIR)
87 $(AT)echo "Bmanual name:" $(BMANUAL_NAME)
88 $(AT)echo "TEXINPUTS: " $(TEXINPUTS)
89 $(AT)echo "WWW_DIR:" $(WWW_DIR)
90 $(AT)echo "TeX files: " $(TEX_FILES)
91 $(AT)echo "Makefile for the web:" $(WEB_MAKEFILE)
92 $(AT)echo "Web files to link: " $(WEB_FILES_TO_LINK)
93 $(AT)echo "HTML files: " $(HTML_FILES)
94
95 pdfcovers:
96 $(AT)echo -n "Linking coverpage and background PDF format..."
97 $(AT)(if [ -e $(SVGCOVERS_DIR) ]; then $(MAKE) -C $(SVGCOVERS_DIR) pdf; fi)
98 $(AT)ln -sf $(PDFCOVERS_DIR)/$(COVERPAGE_NAME).pdf $(LATEX_DIR)/$(BMANUAL_NAME).pdf
99 $(AT)echo "Done."
100
101 pdfimages:
102 $(AT)echo "Converting SVG to PDF images..."
103 $(AT)(if [ -e $(IMAGES_DIR)/svg ]; then $(MAKE) -C $(IMAGES_DIR)/svg pdf; fi)
104 $(AT)echo "Done."
105
106 pngimages:
107 $(AT)echo "Converting SVG to PNG images..."
108 $(AT)(if [ -e $(IMAGES_DIR)/svg ]; then $(MAKE) -C $(IMAGES_DIR) png; fi)
109 $(AT)echo "Done."
110
111 pdflatex: external-references PDF.figlet
112 $(AT)echo " "
113 $(AT)cat PDF.figlet
114 $(AT)makeindex -s $(DOC).ist ${DOC}.idx -o ${DOC}.ind 2>/dev/null
115 $(AT)$(PDFLATEX) $(PDFLATEXOPTIONS) ${DOC}.tex $(PDFOUTPUT)
116 $(AT)$(PDFLATEX) $(PDFLATEXOPTIONS) ${DOC}.tex $(PDFOUTPUT)
117 $(AT)echo "$(DOC).pdf generated."
118 $(AT)mkdir -p pdf
119 $(AT)cp $(DOC).pdf pdf/
120
121 external-references: $(TLS) REF.figlet pdfcovers pdfimages
122 $(AT)echo " "
123 $(AT)cat REF.figlet
124 $(AT)$(PDFLATEX) $(PDFLATEXOPTIONS) ${DOC}.tex $(PDFOUTPUT)
125 $(AT)echo "$(DOC) external references done."
126
127 web: mini-clean HTML.figlet
128 $(AT)echo ""
129 $(AT)cat HTML.figlet
130 $(AT)rm -rf $(WWW_DIR)
131 $(AT)mkdir -p $(WWW_DIR)
132 $(AT)(for F in $(TEX_FILES) ;\
133 do \
134 cat $$F | sed -f ../bpattern > $(WWW_DIR)/$$F ; \
135 done)
136 $(AT)cat $(LATEX_DIR)/bcoverpage.tex | sed -f ../bpattern > $(WWW_DIR)/bcoverpage.tex
137 $(AT)ln -sf $(WEB_MAKEFILE) $(WWW_DIR)/Makefile
138 $(AT)(if [ -e $(REALMANUALENV) ]; then ln -sf $(REALMANUALENV) $(WWW_DIR)/$(MANUALENVFILE); fi)
139 $(AT)(for F in $(WEB_FILES_TO_LINK);\
140 do \
141 ln -sf $$F $(WWW_DIR)/;\
142 done)
143 $(AT)mkdir -p html
144 $(AT)$(MAKE) -C $(WWW_DIR)
145 $(AT)(for F in $(HTML_DIR)/*.html; do sed -i -f ../afterhtml $$F ; for H in ../*/$(EXTSEDFILES) ./$(INTSEDFILE) ; do sed -i -f $$H $$F ; done ; done)
146 $(AT)echo "HTML $(DOC) done."
147
148 references:
149 $(AT)(for F in $(HTML_DIR)/*.html ; do for H in ../*/$(EXTSEDFILES) ./$(INTSEDFILE); do sed -i -f $$H $$F ; done ; done)
150
151 show:
152 xdvi $(DOC)
153
154 texcheck:
155 ./check_tex.pl $(DOC).tex
156
157 main_configs:
158 pic2graph -density 100 <main_configs.pic >main_configs.png
159
160 mini-clean:
161 $(AT)rm -f 1 2 3 *~
162 $(AT)rm -f *.gif *.jpg
163 $(AT)rm -f *.cp *.fn *.ky *.log *.pg
164 $(AT)rm -f *.backup *.ilg *.lof *.lot
165 $(AT)rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
166 $(AT)rm -f *.dnd *.old *.out
167 $(AT)rm -f $(DOC)/*.gif $(DOC)/*.jpg
168 $(AT)rm -f $(DOC)/*.aux $(DOC)/*.cp $(DOC)/*.fn $(DOC)/*.ky $(DOC)/*.log $(DOC)/*.pg
169 $(AT)rm -f $(DOC)/*.backup $(DOC)/*.ilg $(DOC)/*.lof $(DOC)/*.lot
170 $(AT)rm -f $(DOC)/*.cdx $(DOC)/*.cnd $(DOC)/*.ddx $(DOC)/*.ddn $(DOC)/*.fdx $(DOC)/*.fnd $(DOC)/*.ind $(DOC)/*.sdx $(DOC)/*.snd
171 $(AT)rm -f $(DOC)/*.dnd $(DOC)/*.old $(DOC)/*.out
172 $(AT)rm -f $(DOC)/WARNINGS
173 $(AT)rm -rf html
174
175
176 clean: mini-clean
177 $(AT)find . -type f -name "$(DOC).mtc*" -exec rm {} \;
178 $(AT)find . -type l -name "*.tex" -exec rm {} \;
179 $(AT)rm -f 1 2 3 *.tex~
180 $(AT)rm -f *.png *.gif *.jpg
181 $(AT)rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
182 $(AT)rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
183 $(AT)rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd *.maf *.mst *.mw
184 $(AT)rm -f *.dnd imagename_translations
185 $(AT)rm -f *.old WARNINGS *.out *.toc *.idx
186 $(AT)rm -f $(DOC)i-*.tex
187 $(AT)rm -rf $(DOC)
188 $(AT)rm -f $(INTSEDFILE) $(EXTSEDFILES) html-external-references
189
190 webclean:
191 $(AT)rm -rf $(WWW_DIR)
192 $(AT)rm -f bcoverpage.tex
193 $(AT)rm -rf ../images
194
195 distclean: webclean clean $(CLEANTLS)
196 $(AT)rm -f images.pl labels.pl internals.pl
197 $(AT)rm -f version.tex
198 $(AT)rm -rf html
199 $(AT)rm -rf pdf
200 $(AT)rm -f *.figlet *~
201 $(AT)$(MAKE) -C $(SVGCOVERS_DIR) $@
202 $(AT)rm -f $(LATEX_DIR)/$(BMANUAL_NAME).pdf
203
204 cleantls:
205 $(info Cleaning TLS files)
206 $(AT)rm -f *Tls.tex extract-tls
207
208 # The following is not called but explains how the files were generated.
209 REF.figlet:
210 $(AT)figlet "$(BACULAVERSION) $(DOC) cross-references" > REF.figlet
211
212 PDF.figlet:
213 $(AT)figlet "$(BACULAVERSION) $(DOC) PDF" > PDF.figlet
214
215 HTML.figlet:
216 $(AT)figlet "$(BACULAVERSION) $(DOC) HTML" > HTML.figlet
217
218 figlet: REF.figlet PDF.figlet HTML.figlet