c380d12ec3887f3ac23002cab97ec3229b3a8885
[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/fdl.texi
50
51 doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
52         doc/dev/intro.texi \
53         doc/dev/concepts.texi \
54         doc/dev/syntax.texi \
55         doc/dev/data.texi \
56         doc/dev/i18n.texi \
57         doc/dev/output.texi \
58         doc/dev/system-file-format.texi \
59         doc/dev/pc+-file-format.texi \
60         doc/dev/portable-file-format.texi \
61         doc/dev/spv-file-format.texi \
62         doc/dev/encrypted-file-wrappers.texi \
63         doc/dev/q2c.texi
64
65 dist_man_MANS += doc/pspp.1 \
66                  doc/psppire.1
67
68 EXTRA_DIST += doc/get-commands.pl \
69               doc/help-pages-list \
70               doc/prepdoc.sh
71
72 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
73         $(AM_V_GEN)$(PERL) $(top_srcdir)/doc/get-commands.pl $(top_srcdir)/src/language/command.def > $@
74
75 $(srcdir)/doc/tut.texi:
76         $(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@
77
78
79 doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
80 if BROKEN_DOCBOOK_XML
81         touch $@
82 else
83         $(AM_V_GEN)$(MAKEINFO) $(AM_MAKEINFOFLAGS) --docbook -I $(top_srcdir) \
84                 $< -o $@
85 endif
86
87 docbookdir = $(docdir)
88 dist_docbook_DATA = doc/pspp.xml
89
90
91 CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml
92
93
94 doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PSS) $(HTMLS) $(dist_docbook_DATA)
95 PHONY += doc
96
97 doc/help-pages-list: $(UI_FILES)
98          $(AM_V_GEN)cat $^ | grep '"help[-_]page"' | \
99    $(SED) -e 's% *<property name="help[-_]page">\([^<]*\)</property>%//*[@id='"'"'\1'"'"']%' \
100         -e 's%#%'"'"']/*[@id='"'"'%g' > $@,tmp
101         test -s $@,tmp
102         mv $@,tmp $@
103
104 EXTRA_DIST += \
105         doc/help-pages-list \
106         doc/pspp-manual.css
107
108
109 AM_MAKEINFOFLAGS=-I $(top_srcdir)/doc/examples -I $(top_builddir)/doc/examples
110 am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc/examples:$(top_builddir)/doc/examples
111
112 ################# Example programs ##############################
113
114 EXAMPLE_SYNTAX = \
115  doc/examples/autorecode.sps \
116  doc/examples/chisquare.sps \
117  doc/examples/compute.sps \
118  doc/examples/count.sps \
119  doc/examples/descriptives.sps \
120  doc/examples/flip.sps \
121  doc/examples/frequencies.sps \
122  doc/examples/means.sps \
123  doc/examples/one-sample-t.sps \
124  doc/examples/independent-samples-t.sps \
125  doc/examples/reliability.sps \
126  doc/examples/split.sps \
127  doc/examples/tutorial1.sps \
128  doc/examples/tutorial2.sps \
129  doc/examples/tutorial3.sps \
130  doc/examples/tutorial4.sps \
131  doc/examples/tutorial5.sps \
132  doc/examples/tutorial6.sps \
133  doc/examples/tutorial7.sps \
134  doc/examples/weight.sps
135
136
137 EXTRA_DIST += $(EXAMPLE_SYNTAX)
138
139 EXAMPLE_SPVS = $(EXAMPLE_SYNTAX:.sps=.spv) \
140         doc/examples/tutorial2a.spv \
141         doc/examples/tutorial2b.spv \
142         doc/examples/tutorial5a.spv \
143         doc/examples/tutorial5b.spv \
144         doc/examples/tutorial7a.spv \
145         doc/examples/tutorial7b.spv
146 EXAMPLE_TXTS = $(EXAMPLE_SPVS:.spv=.txt)
147 EXAMPLE_TEXIS = $(EXAMPLE_TXTS:.txt=.texi)
148 EXAMPLE_HTML = $(EXAMPLE_SPVS:.spv=.html)
149
150 example-spv: $(EXAMPLE_SPVS)
151 example-txts: $(EXAMPLE_TXTS)
152 example-texis: $(EXAMPLE_TEXIS)
153 example-html: $(EXAMPLE_HTML)
154 PHONY += example-spv example-txts example-texis example-html
155
156 $(top_builddir)/doc/pspp.info:  $(EXAMPLE_TEXIS)
157 $(top_builddir)/doc/pspp.ps:    $(EXAMPLE_TEXIS)
158 $(top_builddir)/doc/pspp.dvi:   $(EXAMPLE_TEXIS)
159 $(top_builddir)/doc/pspp.html:  $(EXAMPLE_HTML)
160 $(top_builddir)/doc/pspp.pdf:   $(EXAMPLE_TEXIS)
161 $(top_builddir)/doc/pspp.xml:   $(EXAMPLE_TEXIS)
162
163 CLEANFILES += $(EXAMPLE_TXTS) $(EXAMPLE_SPVS) $(EXAMPLE_TEXIS) $(EXAMPLE_HTML)
164 SUFFIXES += .sps .spv .txt .html .texi
165
166 # Use pspp to process a syntax file into an output file.
167 pspp = src/ui/terminal/pspp
168 $(EXAMPLE_SPVS): $(pspp)
169 .sps.spv:
170         $(AM_V_GEN)(cd $(top_srcdir)/examples \
171          && $(abs_top_builddir)/$(pspp) ../doc/examples/$(<F) -o - -O format=spv) > $@.tmp
172         $(AM_V_at)mv $@.tmp $@
173
174 # In some cases, the tutorial only wants some parts of the output.
175 pspp_output = utilities/pspp-output
176 convert = $(AM_V_GEN)$(pspp_output) convert $< $@
177 doc/examples/tutorial2a.spv: doc/examples/tutorial2.spv $(pspp_output)
178         $(convert) --command='Descriptives'
179 doc/examples/tutorial2b.spv: doc/examples/tutorial2.spv $(pspp_output)
180         $(convert) --label='Extreme Values'
181 doc/examples/tutorial5a.spv: doc/examples/tutorial5.spv $(pspp_output)
182         $(convert) --commands=examine --nth-command=1 --labels=descriptives
183 doc/examples/tutorial5b.spv: doc/examples/tutorial5.spv $(pspp_output)
184         $(convert) --commands=examine --nth-command=2 --labels=descriptives
185 doc/examples/tutorial7a.spv: doc/examples/tutorial7.spv $(pspp_output)
186         $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
187 doc/examples/tutorial7b.spv: doc/examples/tutorial7.spv $(pspp_output)
188         $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
189
190 # Convert an output file into a text file or HTML file.
191 $(EXAMPLE_TXTS) $(EXAMPLE_HTML): $(pspp_output)
192 .spv.txt:
193         $(AM_V_GEN)utilities/pspp-output convert $< $@
194 .spv.html:
195         $(AM_V_GEN)utilities/pspp-output convert $< - -O format=html -O bare=true > $@.tmp
196         $(AM_V_at)mv $@.tmp $@
197
198 # Convert a text file into a Texinfo file.
199 .txt.texi:
200         $(AM_V_GEN)sed 's/@/@@/g' < $< > $@.tmp
201         $(AM_V_at)mv $@.tmp $@
202
203 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
204 install-html-local: html-local
205         $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
206         $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
207
208
209 \f
210
211 desktopdir = $(datadir)/applications
212
213 doc/org.fsf.pspp.metainfo.xml: doc/org.fsf.pspp.metainfo.xml.in $(POFILES)
214         $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
215           $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
216
217 doc/org.fsf.pspp.desktop: doc/org.fsf.pspp.desktop.in $(POFILES)
218         $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
219
220 CLEANFILES+=doc/org.fsf.pspp.desktop \
221             doc/org.fsf.pspp.metainfo.xml
222
223 desktop_DATA = doc/org.fsf.pspp.desktop
224
225 appdatadir = $(datadir)/metainfo
226 dist_appdata_DATA = doc/org.fsf.pspp.metainfo.xml
227
228 EXTRA_DIST += doc/org.fsf.pspp.metainfo.xml.in \
229         doc/org.fsf.pspp.desktop.in