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.pl \
  71               doc/help-pages-list \
  72               doc/prepdoc.sh
  73
  74 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
  75         $(AM_V_GEN)$(PERL) $(top_srcdir)/doc/get-commands.pl $(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/crosstabs.sps \
 121  doc/pspp-figures/descriptives.sps \
 122  doc/pspp-figures/flip.sps \
 123  doc/pspp-figures/frequencies.sps \
 124  doc/pspp-figures/means.sps \
 125  doc/pspp-figures/one-sample-t.sps \
 126  doc/pspp-figures/independent-samples-t.sps \
 127  doc/pspp-figures/reliability.sps \
 128  doc/pspp-figures/select-if.sps \
 129  doc/pspp-figures/sort-cases.sps \
 130  doc/pspp-figures/split.sps \
 131  doc/pspp-figures/temporary.sps \
 132  doc/pspp-figures/tutorial1.sps \
 133  doc/pspp-figures/tutorial2.sps \
 134  doc/pspp-figures/tutorial3.sps \
 135  doc/pspp-figures/tutorial4.sps \
 136  doc/pspp-figures/tutorial5.sps \
 137  doc/pspp-figures/tutorial6.sps \
 138  doc/pspp-figures/tutorial7.sps \
 139  doc/pspp-figures/weight.sps
 140
 141
 142 EXTRA_DIST += $(FIGURE_SYNTAX)
 143
 144 FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \
 145         doc/pspp-figures/tutorial2a.spv \
 146         doc/pspp-figures/tutorial2b.spv \
 147         doc/pspp-figures/tutorial5a.spv \
 148         doc/pspp-figures/tutorial5b.spv \
 149         doc/pspp-figures/tutorial7a.spv \
 150         doc/pspp-figures/tutorial7b.spv
 151 FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt)
 152 FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi)
 153 FIGURE_HTMLS = $(FIGURE_SPVS:.spv=.html)
 154 FIGURE_PDFS = $(FIGURE_SPVS:.spv=.pdf)
 155 FIGURE_PNGS = $(FIGURE_SPVS:.spv=.png)
 156
 157 figure-spvs: $(FIGURE_SPVS)
 158 figure-txts: $(FIGURE_TXTS)
 159 figure-texis: $(FIGURE_TEXIS)
 160 figure-htmls: $(FIGURE_HTMLS)
 161 figure-pdfs: $(FIGURE_PDFS)
 162 figure-pngs: $(FIGURE_PNGS)
 163 PHONY += \
 164         figure-spv \
 165         figure-txts \
 166         figure-texis \
 167         figure-htmls \
 168         figure-pdfs \
 169         figure-pngs
 170
 171 $(top_builddir)/doc/pspp.info:  $(FIGURE_PNGS)
 172 $(top_builddir)/doc/pspp.ps:    $(FIGURE_TEXIS)
 173 $(top_builddir)/doc/pspp.dvi:   $(FIGURE_TEXIS)
 174 $(top_builddir)/doc/pspp.html:  $(FIGURE_HTMLS)
 175 $(top_builddir)/doc/pspp.pdf:   $(FIGURE_TEXIS)
 176 $(top_builddir)/doc/pspp.xml:   $(FIGURE_TEXIS)
 177
 178 CLEANFILES += \
 179         $(FIGURE_TXTS) \
 180         $(FIGURE_SPVS) \
 181         $(FIGURE_TEXIS) \
 182         $(FIGURE_HTMLS) \
 183         $(FIGURE_PNGS)
 184 SUFFIXES += .sps .spv .txt .html .texi .pdf .png
 185
 186 # Use pspp to process a syntax file into an output file.
 187 if cross_compiling
 188 pspp = native/src/ui/terminal/pspp
 189 pspp_output = native/utilities/pspp-output
 190
 191 native/Makefile:
 192         $(MKDIR_P) native
 193         (cd native && $(abs_top_srcdir)/configure --host=$(build) --without-gui)
 194
 195 native/gl/libgl.la: native/Makefile
 196         (cd native && flock --verbose $(top_builddir)/native-lock $(MAKE) gl/libgl.la)
 197
 198 $(pspp): native/gl/libgl.la
 199         (cd native && flock --verbose $(top_builddir)/native-lock $(MAKE) src/ui/terminal/pspp)
 200
 201 $(pspp_output): native/gl/libgl.la
 202         (cd native && flock --verbose $(top_builddir)/native-lock $(MAKE) utilities/pspp-output)
 203 else
 204 pspp = src/ui/terminal/pspp$(EXEEXT)
 205 pspp_output = utilities/pspp-output$(EXEEXT)
 206 endif
 207
 208 $(FIGURE_SPVS): $(pspp)
 209 .sps.spv:
 210         $(AM_V_GEN)(cd "$(top_srcdir)/examples" \
 211          && "$(abs_top_builddir)/$(pspp)" ../doc/pspp-figures/$(<F) -o - -O format=spv) > $@.tmp
 212         $(AM_V_at)mv $@.tmp $@
 213
 214 # In some cases, the tutorial only wants some parts of the output.
 215 convert = $(AM_V_GEN)LSAN_OPTIONS="suppressions=$(abs_top_srcdir)/tests/lsan.supp:print_suppressions=0:$$LSAN_OPTIONS" $(pspp_output) convert $< $@
 216 doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
 217         $(convert) --command='Descriptives'
 218 doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
 219         $(convert) --label='Extreme Values'
 220 doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
 221         $(convert) --commands=examine --nth-command=1 --labels=descriptives
 222 doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
 223         $(convert) --commands=examine --nth-command=2 --labels=descriptives
 224 doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
 225         $(convert) --commands=regression --nth-command=1 --subtypes=coefficients
 226 doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
 227         $(convert) --commands=regression --nth-command=2 --subtypes=coefficients
 228
 229
 230 $(FIGURE_PNGS): $(pspp_output)
 231 $(FIGURE_TXTS): $(pspp_output)
 232 $(FIGURE_HTMLS): $(pspp_output)
 233 $(FIGURE_PDFS): $(pspp_output)
 234
 235 # Convert an output file into a text file or HTML file.
 236 $(FIGURE_TXTS) $(FIGURE_HTMLS): $(pspp_output)
 237 .spv.txt:
 238         $(convert)
 239 .spv.pdf:
 240         $(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
 241 .spv.png:
 242         $(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
 243 EXTRA_DIST += doc/tutorial.stt
 244 .spv.html:
 245         $(convert) -O format=html -O bare=true
 246
 247 # Convert a text file into a Texinfo file.
 248 .txt.texi:
 249         $(AM_V_GEN)$(SED) -e 's/@/@@/g' $< > $@
 250
 251 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
 252 # Adjust the path for screenshot images.
 253 # But make sure these operations are idempotent.
 254 html-local: doc/pspp.html
 255         test -d doc/pspp.html
 256         for h in doc/pspp.html/*.html; do \
 257                 if grep -Fq '<img src="screenshots/' $$h; then continue; fi ; \
 258                 $(SED) -i -e 's|<img src="\([^"]*\)"|<img src="screenshots/\1"|' $$h; \
 259         done
 260
 261 install-html-local: html-local $(HTML_SCREENSHOTS)
 262         $(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
 263         $(INSTALL) -d $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots
 264         for p in $(HTML_SCREENSHOTS); do \
 265                 $(INSTALL_DATA) $$p $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots ;\
 266         done
 267         $(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
 268
 269 \f
 270
 271 desktopdir = $(datadir)/applications
 272
 273 doc/org.fsf.pspp.metainfo.xml: doc/org.fsf.pspp.metainfo.xml.in $(POFILES)
 274         $(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
 275           $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po
 276
 277 doc/org.fsf.pspp.desktop: doc/org.fsf.pspp.desktop.in $(POFILES)
 278         $(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po
 279
 280 CLEANFILES+=doc/org.fsf.pspp.desktop \
 281             doc/org.fsf.pspp.metainfo.xml
 282
 283 desktop_DATA = doc/org.fsf.pspp.desktop
 284
 285 appdatadir = $(datadir)/metainfo
 286 dist_appdata_DATA = doc/org.fsf.pspp.metainfo.xml
 287
 288 EXTRA_DIST += doc/org.fsf.pspp.metainfo.xml.in \
 289         doc/org.fsf.pspp.desktop.in
 290
 291 \f
 292
 293 SCREENSHOTS = \
 294 $(top_srcdir)/doc/screenshots/autorecode.grab \
 295 $(top_srcdir)/doc/screenshots/chisquare.grab \
 296 $(top_srcdir)/doc/screenshots/count.grab \
 297 $(top_srcdir)/doc/screenshots/count-define.grab \
 298 $(top_srcdir)/doc/screenshots/compute.grab \
 299 $(top_srcdir)/doc/screenshots/crosstabs.grab \
 300 $(top_srcdir)/doc/screenshots/descriptives.grab \
 301 $(top_srcdir)/doc/screenshots/one-sample-t.grab \
 302 $(top_srcdir)/doc/screenshots/independent-samples-t.grab \
 303 $(top_srcdir)/doc/screenshots/define-groups-t.grab \
 304 $(top_srcdir)/doc/screenshots/frequencies.grab \
 305 $(top_srcdir)/doc/screenshots/reliability.grab \
 306 $(top_srcdir)/doc/screenshots/split-status-bar.grab \
 307 $(top_srcdir)/doc/screenshots/sort-simple.grab \
 308 $(top_srcdir)/doc/screenshots/sort.grab
 309
 310
 311 PDF_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.png)
 312 EPS_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.eps)
 313 HTML_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
 314 INFO_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
 315
 316 doc-make: doc/doc-make.in Makefile
 317         $(SED) -e 's|%top_srcdir%|@top_srcdir@|g' \
 318         -e 's|%abs_builddir%|@abs_builddir@|g' \
 319         -e 's|%MKDIR_P%|@MKDIR_P@|g' \
 320         -e 's|%src_ui_gui_psppiredir%|$(src_ui_gui_psppiredir)|g' \
 321         -e 's|%UI_FILES%|$(UI_FILES)|g' \
 322         -e 's|%IMAGES%|$(INFO_SCREENSHOTS) $(HTML_SCREENSHOTS) $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS)|g' \
 323         $< > $@
 324
 325
 326 # Install all the PNG files so that info readers can recognise them
 327 install-info-local: $(FIGURE_PNGS)
 328         $(MKDIR_P) $(DESTDIR)$(infodir)/screenshots
 329         for p in $(INFO_SCREENSHOTS); do \
 330                 $(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/screenshots ;\
 331         done
 332         $(INSTALL) -d $(DESTDIR)$(infodir)/pspp-figures
 333         for p in $(FIGURE_PNGS); do \
 334                 $(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/pspp-figures ;\
 335         done
 336
 337 uninstall-local:
 338         for p in $(INFO_SCREENSHOTS); do \
 339                 f=`basename $$p ` ; \
 340                 rm -f $(DESTDIR)$(infodir)/screenshots/$$f ; \
 341         done
 342         for p in $(FIGURE_PNGS); do \
 343                 f=`basename $$p ` ; \
 344                 rm -f $(DESTDIR)$(infodir)/pspp-figures/$$f ; \
 345         done
 346
 347 EXTRA_DIST+= $(SCREENSHOTS) doc/doc-make.in doc/screengrab
 348
 349 EXTRA_DIST+= $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS) $(INFO_SCREENSHOTS)