Improve error messages for missing subcommands.
[pspp] / doc / automake.mk
1 ## PSPP - a program for statistical analysis.
2 ## Copyright (C) 2019, 2020 Free Software Foundation, Inc.
3 ##
4 ## This program is free software: you can redistribute it and/or modify
5 ## it under the terms of the GNU General Public License as published by
6 ## the Free Software Foundation, either version 3 of the License, or
7 ## (at your option) any later version.
8 ##
9 ## This program is distributed in the hope that it will be useful,
10 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
11 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 ## GNU General Public License for more details.
13 ##
14 ## You should have received a copy of the GNU General Public License
15 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 ## Process this file with automake to produce Makefile.in  -*- makefile -*-
18
19 info_TEXINFOS = doc/pspp.texi doc/pspp-dev.texi
20
21 doc_pspp_TEXINFOS = doc/version.texi \
22         doc/bugs.texi \
23         doc/command-index.texi \
24         doc/concept-index.texi \
25         doc/data-io.texi \
26         doc/data-selection.texi \
27         doc/expressions.texi \
28         doc/files.texi \
29         doc/combining.texi \
30         doc/flow-control.texi \
31         doc/function-index.texi \
32         doc/installing.texi \
33         doc/introduction.texi \
34         doc/invoking.texi \
35         doc/language.texi \
36         doc/license.texi \
37         doc/pspp-convert.texi \
38         doc/pspp-output.texi \
39         doc/pspp-dump-sav.texi \
40         doc/ni.texi \
41         doc/not-implemented.texi \
42         doc/statistics.texi \
43         doc/transformation.texi \
44         doc/tutorial.texi \
45         doc/tut.texi \
46         doc/regression.texi \
47         doc/utilities.texi \
48         doc/variables.texi \
49         doc/matrices.texi \
50         doc/fdl.texi
51
52 doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
53         doc/dev/intro.texi \
54         doc/dev/concepts.texi \
55         doc/dev/gui.texi \
56         doc/dev/syntax.texi \
57         doc/dev/data.texi \
58         doc/dev/i18n.texi \
59         doc/dev/output.texi \
60         doc/dev/system-file-format.texi \
61         doc/dev/pc+-file-format.texi \
62         doc/dev/portable-file-format.texi \
63         doc/dev/spv-file-format.texi \
64         doc/dev/tlo-file-format.texi \
65         doc/dev/encrypted-file-wrappers.texi
66
67 dist_man_MANS += doc/pspp.1 \
68                  doc/psppire.1
69
70 EXTRA_DIST += doc/get-commands.py \
71               doc/help-pages-list \
72               doc/prepdoc.sh
73
74 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.py
75         $(AM_V_GEN)$(PYTHON3) $(top_srcdir)/doc/get-commands.py $(top_srcdir)/src/language/command.def > $@
76
77 $(srcdir)/doc/tut.texi:
78         $(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@
79
80
81 doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
82 if BROKEN_DOCBOOK_XML
83         touch $@
84 else
85         $(AM_V_GEN)$(MAKEINFO) --docbook $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) \
86                 -I doc -I $(srcdir)/doc $< -o $@
87 endif
88
89 docbookdir = $(docdir)
90 dist_docbook_DATA = doc/pspp.xml
91
92
93 CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml
94
95
96 doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PNGS) $(HTMLS) $(dist_docbook_DATA)
97 PHONY += doc
98
99 doc/help-pages-list: $(UI_FILES)
100          $(AM_V_GEN)cat $^ | grep '"help[-_]page"' | \
101    $(SED) -e 's% *<property name="help[-_]page">\([^<]*\)</property>%//*[@id='"'"'\1'"'"']%' \
102         -e 's%#%'"'"']/*[@id='"'"'%g' > $@,tmp
103         test -s $@,tmp
104         mv $@,tmp $@
105
106 EXTRA_DIST += \
107         doc/help-pages-list \
108         doc/pspp-manual.css
109
110 am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc:$(top_builddir)/doc
111
112 ################# Example programs ##############################
113
114 FIGURE_SYNTAX = \
115  doc/pspp-figures/aggregate.sps \
116  doc/pspp-figures/autorecode.sps \
117  doc/pspp-figures/chisquare.sps \
118  doc/pspp-figures/compute.sps \
119  doc/pspp-figures/count.sps \
120  doc/pspp-figures/ctables1.sps \
121  doc/pspp-figures/ctables2.sps \
122  doc/pspp-figures/ctables3.sps \
123  doc/pspp-figures/ctables4.sps \
124  doc/pspp-figures/ctables5.sps \
125  doc/pspp-figures/ctables6.sps \
126  doc/pspp-figures/ctables7.sps \
127  doc/pspp-figures/ctables8.sps \
128  doc/pspp-figures/ctables9.sps \
129  doc/pspp-figures/ctables10.sps \
130  doc/pspp-figures/ctables11.sps \
131  doc/pspp-figures/ctables12.sps \
132  doc/pspp-figures/ctables13.sps \
133  doc/pspp-figures/ctables14.sps \
134  doc/pspp-figures/ctables15.sps \
135  doc/pspp-figures/ctables16.sps \
136  doc/pspp-figures/ctables17.sps \
137  doc/pspp-figures/ctables18.sps \
138  doc/pspp-figures/ctables19.sps \
139  doc/pspp-figures/ctables20.sps \
140  doc/pspp-figures/ctables21.sps \
141  doc/pspp-figures/ctables22.sps \
142  doc/pspp-figures/ctables23.sps \
143  doc/pspp-figures/ctables24.sps \
144  doc/pspp-figures/ctables25.sps \
145  doc/pspp-figures/ctables26.sps \
146  doc/pspp-figures/ctables27.sps \
147  doc/pspp-figures/ctables28.sps \
148  doc/pspp-figures/ctables29.sps \
149  doc/pspp-figures/ctables30.sps \
150  doc/pspp-figures/ctables31.sps \
151  doc/pspp-figures/ctables32.sps \
152  doc/pspp-figures/ctables33.sps \
153  doc/pspp-figures/ctables34.sps \
154  doc/pspp-figures/ctables35.sps \
155  doc/pspp-figures/ctables36.sps \
156  doc/pspp-figures/crosstabs.sps \
157  doc/pspp-figures/descriptives.sps \
158  doc/pspp-figures/flip.sps \
159  doc/pspp-figures/frequencies.sps \
160  doc/pspp-figures/matrix-print.sps \
161  doc/pspp-figures/means.sps \
162  doc/pspp-figures/one-sample-t.sps \
163  doc/pspp-figures/independent-samples-t.sps \
164  doc/pspp-figures/reliability.sps \
165  doc/pspp-figures/select-if.sps \
166  doc/pspp-figures/show-system.sps \
167  doc/pspp-figures/sort-cases.sps \
168  doc/pspp-figures/split.sps \
169  doc/pspp-figures/temporary.sps \
170  doc/pspp-figures/tutorial1.sps \
171  doc/pspp-figures/tutorial2.sps \
172  doc/pspp-figures/tutorial3.sps \
173  doc/pspp-figures/tutorial4.sps \
174  doc/pspp-figures/tutorial5.sps \
175  doc/pspp-figures/tutorial6.sps \
176  doc/pspp-figures/tutorial7.sps \
177  doc/pspp-figures/weight.sps
178
179
180 EXTRA_DIST += $(FIGURE_SYNTAX)
181
182 FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \
183         doc/pspp-figures/tutorial2a.spv \
184         doc/pspp-figures/tutorial2b.spv \
185         doc/pspp-figures/tutorial5a.spv \
186         doc/pspp-figures/tutorial5b.spv \
187         doc/pspp-figures/tutorial7a.spv \
188         doc/pspp-figures/tutorial7b.spv
189 FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt)
190 FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi)
191 FIGURE_HTMLS = $(FIGURE_SPVS:.spv=.html)
192 FIGURE_PDFS = $(FIGURE_SPVS:.spv=.pdf)
193 FIGURE_PNGS = $(FIGURE_SPVS:.spv=.png)
194
195 figure-spvs: $(FIGURE_SPVS)
196 figure-txts: $(FIGURE_TXTS)
197 figure-texis: $(FIGURE_TEXIS)
198 figure-htmls: $(FIGURE_HTMLS)
199 figure-pdfs: $(FIGURE_PDFS)
200 figure-pngs: $(FIGURE_PNGS)
201 PHONY += \
202         figure-spv \
203         figure-txts \
204         figure-texis \
205         figure-htmls \
206         figure-pdfs \
207         figure-pngs
208
209 $(top_builddir)/doc/pspp.info:  $(FIGURE_PNGS)
210 $(top_builddir)/doc/pspp.ps:    $(FIGURE_TEXIS)
211 $(top_builddir)/doc/pspp.dvi:   $(FIGURE_TEXIS)
212 $(top_builddir)/doc/pspp.html:  $(FIGURE_HTMLS)
213 $(top_builddir)/doc/pspp.pdf:   $(FIGURE_TEXIS)
214 $(top_builddir)/doc/pspp.xml:   $(FIGURE_TEXIS)
215
216 CLEANFILES += \
217         $(FIGURE_TXTS) \
218         $(FIGURE_SPVS) \
219         $(FIGURE_TEXIS) \
220         $(FIGURE_HTMLS) \
221         $(FIGURE_PNGS)
222 SUFFIXES += .sps .spv .txt .html .texi .pdf .png
223
224 # Use pspp to process a syntax file into an output file.
225 if cross_compiling
226 pspp = native/src/ui/terminal/pspp
227 pspp_output = native/utilities/pspp-output
228
229 native/Makefile:
230         $(MKDIR_P) native
231         (cd native && $(abs_top_srcdir)/configure --host=$(build) --without-gui)
232
233 # The gnulib header files are required for the object files of the native pspp
234 # They are defined in BUILT_SOURCES but that is only defined as a first dependency
235 # for the make all target. src/ui/terminal/pspp as a target will try to compile the
236 # objects first but that fails without the header files. Therefore I build the native
237 # executables via the default make target
238 $(pspp) $(pspp_output) &: native/Makefile
239         (cd native && flock --verbose $(top_builddir)/native-lock $(MAKE) )
240
241 else
242 pspp = src/ui/terminal/pspp$(EXEEXT)
243 pspp_output = utilities/pspp-output$(EXEEXT)
244 endif
245
246 $(FIGURE_SPVS): $(pspp)
247 .sps.spv:
248         $(AM_V_GEN)(cd "$(top_srcdir)/examples" \
249          && "$(abs_top_builddir)/$(pspp)" ../doc/pspp-figures/$(<F) -o - -O format=spv) > $@.tmp
250         $(AM_V_at)mv $@.tmp $@
251
252 # In some cases, the tutorial only wants some parts of the output.
253 convert = $(AM_V_GEN)LSAN_OPTIONS="suppressions=$(abs_top_srcdir)/tests/lsan.supp:print_suppressions=0:$$LSAN_OPTIONS" $(pspp_output) convert $< $@
254 doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
255         $(convert) --command='Descriptives'
256 doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
257         $(convert) --label='Extreme Values'
258 doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
259         $(convert) --commands=examine --nth-command=1 --labels=descriptives
260 doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
261         $(convert) --commands=examine --nth-command=2 --labels=descriptives
262 doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
263         $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
264 doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
265         $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
266
267
268 $(FIGURE_PNGS): $(pspp_output)
269 $(FIGURE_TXTS): $(pspp_output)
270 $(FIGURE_HTMLS): $(pspp_output)
271 $(FIGURE_PDFS): $(pspp_output)
272
273 # Convert an output file into a text file or HTML file.
274 $(FIGURE_TXTS) $(FIGURE_HTMLS): $(pspp_output)
275 .spv.txt:
276         $(convert)
277 .spv.pdf:
278         $(convert) -O trim=true -O left-margin=0in -O right-margin=0in -O top-margin=0in -O bottom-margin=0in -O paper-size=7.5x99in --table-look=$(srcdir)/doc/tutorial.stt
279 .spv.png:
280         $(convert) -O trim=true -O left-margin=0in -O right-margin=0in -O top-margin=0in -O bottom-margin=0in -O paper-size=7.5x99in --table-look=$(srcdir)/doc/tutorial.stt
281 EXTRA_DIST += doc/tutorial.stt
282 .spv.html:
283         $(convert) -O format=html -O bare=true
284
285 # Make sure that tutorial.stt outputs all layers, because a few of the
286 # examples in the manual rely on that and it would be easy to replace
287 # it with a style that didn't.
288 ALL_LOCAL += tutorial-stt-must-print-all-layers
289 tutorial-stt-must-print-all-layers:
290         $(AM_V_GEN)grep 'printAllLayers="true"' $(srcdir)/doc/tutorial.stt >/dev/null 2>&1 && touch $@
291
292 # Convert a text file into a Texinfo file.
293 .txt.texi:
294         $(AM_V_GEN)$(SED) -e 's/@/@@/g' $< > $@
295
296 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
297 # Adjust the path for screenshot images.
298 # But make sure these operations are idempotent.
299 html-local: doc/pspp.html
300         test -d doc/pspp.html
301         for h in doc/pspp.html/*.html; do \
302                 if grep -Fq '<img src="screenshots/' $$h; then continue; fi ; \
303                 $(SED) -i -e 's|<img src="\([^"]*\)"|<img src="screenshots/\1"|' $$h; \
304         done
305
306 install-html-local: html-local $(HTML_SCREENSHOTS)
307         $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
308         $(INSTALL) -d $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots
309         for p in $(HTML_SCREENSHOTS); do \
310                 $(INSTALL_DATA) $$p $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots ;\
311         done
312         $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
313
314 \f
315
316 desktopdir = $(datadir)/applications
317
318 doc/org.gnu.pspp.metainfo.xml: doc/org.gnu.pspp.metainfo.xml.in $(POFILES)
319         $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
320           $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
321
322 doc/org.gnu.pspp.desktop: doc/org.gnu.pspp.desktop.in $(POFILES)
323         $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
324
325 CLEANFILES+=doc/org.gnu.pspp.desktop \
326             doc/org.gnu.pspp.metainfo.xml
327
328 desktop_DATA = doc/org.gnu.pspp.desktop
329
330 appdatadir = $(datadir)/metainfo
331 dist_appdata_DATA = doc/org.gnu.pspp.metainfo.xml
332
333 EXTRA_DIST += doc/org.gnu.pspp.metainfo.xml.in \
334         doc/org.gnu.pspp.desktop.in
335
336 \f
337
338 SCREENSHOTS = \
339 $(top_srcdir)/doc/screenshots/autorecode.grab \
340 $(top_srcdir)/doc/screenshots/chisquare.grab \
341 $(top_srcdir)/doc/screenshots/count.grab \
342 $(top_srcdir)/doc/screenshots/count-define.grab \
343 $(top_srcdir)/doc/screenshots/compute.grab \
344 $(top_srcdir)/doc/screenshots/crosstabs.grab \
345 $(top_srcdir)/doc/screenshots/descriptives.grab \
346 $(top_srcdir)/doc/screenshots/one-sample-t.grab \
347 $(top_srcdir)/doc/screenshots/independent-samples-t.grab \
348 $(top_srcdir)/doc/screenshots/define-groups-t.grab \
349 $(top_srcdir)/doc/screenshots/frequencies.grab \
350 $(top_srcdir)/doc/screenshots/reliability.grab \
351 $(top_srcdir)/doc/screenshots/split-status-bar.grab \
352 $(top_srcdir)/doc/screenshots/sort-simple.grab \
353 $(top_srcdir)/doc/screenshots/sort.grab
354
355
356 PDF_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.png)
357 EPS_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.eps)
358 HTML_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
359 INFO_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
360
361 doc-make: doc/doc-make.in Makefile
362         $(SED) -e 's|%top_srcdir%|@top_srcdir@|g' \
363         -e 's|%abs_builddir%|@abs_builddir@|g' \
364         -e 's|%MKDIR_P%|@MKDIR_P@|g' \
365         -e 's|%src_ui_gui_psppiredir%|$(src_ui_gui_psppiredir)|g' \
366         -e 's|%UI_FILES%|$(UI_FILES)|g' \
367         -e 's|%IMAGES%|$(INFO_SCREENSHOTS) $(HTML_SCREENSHOTS) $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS)|g' \
368         $< > $@
369
370
371 # Install all the PNG files so that info readers can recognise them
372 install-info-local: $(FIGURE_PNGS)
373         $(MKDIR_P) $(DESTDIR)$(infodir)/screenshots
374         for p in $(INFO_SCREENSHOTS); do \
375                 $(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/screenshots ;\
376         done
377         $(INSTALL) -d $(DESTDIR)$(infodir)/pspp-figures
378         for p in $(FIGURE_PNGS); do \
379                 $(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/pspp-figures ;\
380         done
381
382 uninstall-local:
383         for p in $(INFO_SCREENSHOTS); do \
384                 f=`basename $$p ` ; \
385                 rm -f $(DESTDIR)$(infodir)/screenshots/$$f ; \
386         done
387         for p in $(FIGURE_PNGS); do \
388                 f=`basename $$p ` ; \
389                 rm -f $(DESTDIR)$(infodir)/pspp-figures/$$f ; \
390         done
391
392 EXTRA_DIST+= $(SCREENSHOTS) doc/doc-make.in doc/screengrab
393
394 EXTRA_DIST+= $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS) $(INFO_SCREENSHOTS)