doc/Makefile

   1 ### Makefile - for DOCUMENTATION (./doc) of ESS distribution.
   2 ###
   3
   4 ## Before making changes here, please take a look at Makeconf
   5 include ../Makeconf
   6
   7 # program to convert .texi{nfo} to .html
   8 #MM: use makeinfo (i.e. MAKEHTML from above) which is more
   9 #--  standardized than texi2html which exists in
  10 #MM  at least two widely differing versions (TeX vs GNU):
  11 TEXI2HTML = LANG=C texi2html -verbose -iso
  12 SPLITCHAP = -split_chapter -menu -glossary
  13 ##
  14
  15 TEXI2DVI = LANG=C texi2dvi
  16 TEXI2PDF = LANG=C texi2dvi --pdf
  17
  18 # To obtain sorted indices run: "texindex ess.??".
  19
  20 #### no user servicable parts beyond this point ####
  21
  22 TEXISRC = announc.texi authors.texi bugrept.texi bugs.texi bugs-ms.texi     \
  23         credits.texi currfeat.texi ess.texi ess-defs.texi getting.texi help-s.texi \
  24         help-sas.texi inst_svn.texi inst_tar.texi license.texi mailing.texi \
  25         newfeat.texi readme.texi requires.texi stabilty.texi help-bugs.texi \
  26         ../VERSION
  27
  28 ### Targets --
  29 PDFs = ess.pdf readme.pdf
  30 DVIs = ess.dvi readme.dvi
  31 TXTs = ../README ../ANNOUNCE
  32
  33 all  : info text html dvi pdf
  34 docs : info text html
  35 info : info/ess.info
  36 text : $(TXTs)
  37 html : html/ess.html html/readme.html
  38 dvi  : $(DVIs)
  39 pdf  : $(PDFs)
  40 ps   : ess.ps  readme.ps
  41
  42 ess.dvi : $(TEXISRC); $(TEXI2DVI) ess.texi
  43 ess.pdf : $(TEXISRC); $(TEXI2PDF) ess.texi
  44 ess.ps  : ess.dvi; LANG=C dvips $^ -o $@
  45
  46 readme.dvi : $(TEXISRC); $(TEXI2DVI) readme.texi
  47 readme.pdf : $(TEXISRC); $(TEXI2PDF) readme.texi
  48 readme.ps  : readme.dvi; dvips $^ -o $@
  49
  50 cleanaux:
  51         -@rm -f *.aux *.cp *.cps *.fn *.fns *.ky *.kys *.log *.out \
  52                 *.pg *.pgs *.ps *.ps-2 *.tmp *.toc *.tp *.vr *.vrs
  53 ## this shall remove *exactly* those things that are *not* in version control:
  54 clean: cleanaux
  55         -@rm -f $(PDFs) $(DVIs) info/*.info*
  56
  57 ## this removes also things in VC (when they are remade by "make"):
  58 distclean : clean
  59         -@rm -f $(TXTs) html/*
  60
  61 ../README: $(TEXISRC)
  62         $(MAKETXT) readme.texi \
  63         | perl -pe 'last if /^Concept Index/; print "For INSTALLATION, see way below.\n\n" if /^\s*ESS grew out of/' \
  64         > ../README
  65
  66 ../ANNOUNCE: $(TEXISRC)
  67         $(MAKETXT) announc.texi \
  68         | perl -pe 'last if /^Concept Index/;' > ../ANNOUNCE
  69
  70 README.Microsoft : README.Microsoft.texi
  71         $(MAKETXT) README.Microsoft.texi \
  72         | perl -pe 'last if /^Concept Index/;' > README.Microsoft
  73
  74 ### File Dependencies
  75
  76 info/ess.info: $(TEXISRC)
  77         @echo "making Info documentation..."
  78         $(MAKEINFO) ess.texi
  79         mv -f ess.info* info
  80
  81 install : info/ess.info
  82         -$(INSTALLDIR) $(INFODIR)
  83         $(INSTALL) info/ess.info* $(INFODIR)
  84         test -f $(INFODIR)/dir || $(INSTALL) info/dir $(INFODIR)
  85
  86 ##  TO DO:  ess_toc.html & readme_toc.html should be merged into index.html
  87 html/ess.html: $(TEXISRC)
  88         @echo "making HTML documentation..."
  89         $(MAKEHTML) ess.texi && mv -f ess.html html
  90 #MM     $(TEXI2HTML) $(SPLITCHAP) ess.texi
  91 #MM     test -d ess && cp -p ess/ess_toc.html html/index.html || cp -p ess_toc.html html/index.html
  92 #MM     test -d ess && mv -f ess/*.html html || mv -f *.html html
  93
  94 html/readme.html: $(TEXISRC)
  95         $(MAKEHTML)  --no-validate readme.texi
  96 ##                   ^^^^^^^^^^^^^ (design bug: "FIXME" in ess.texi)
  97 #MM     $(TEXI2HTML) readme.texi
  98         mv -f readme.html html