Update documentation, to formulate the markup rules more compactly.
[org-mode/org-mode-NeilSmithlineMods.git] / Makefile
blob6707d24365911b1692432eef3a0abb8424aeea14
1 # Makefile - for the org-mode distribution
3 # Maintainer: Carsten Dominik <dominik@science.uva.nl>
4 # Version: VERSIONTAG
6 # To install org-mode, edit the Makefile, type `make', then `make install'.
7 # To create the PDF and HTML documentation files, type `make doc'.
9 ##----------------------------------------------------------------------
10 ## YOU MUST EDIT THE FOLLOWING LINES
11 ##----------------------------------------------------------------------
13 # Name of your emacs binary
14 EMACS=emacs
16 # Where local software is found
17 prefix=/usr/local
19 # Where local lisp files go.
20 lispdir = $(prefix)/share/emacs/site-lisp
22 # Where info files go.
23 infodir = $(prefix)/info
25 ##----------------------------------------------------------------------
26 ## YOU MAY NEED TO EDIT THESE
27 ##----------------------------------------------------------------------
29 # Using emacs in batch mode.
30 # BATCH=$(EMACS) -batch -q
31 # BATCH=$(EMACS) -batch -q -eval "(add-to-list (quote load-path) \".\")"
33 BATCH=$(EMACS) -batch -q -eval \
34 "(progn (add-to-list (quote load-path) (expand-file-name \"./lisp/\")) \
35 (add-to-list (quote load-path) \"$(lispdir)\"))"
37 # Specify the byte-compiler for compiling org-mode files
38 ELC= $(BATCH) -f batch-byte-compile
40 # How to make a pdf file from a texinfo file
41 TEXI2PDF = texi2pdf
43 # How to create directories
44 MKDIR = mkdir -p
46 # How to create the info files from the texinfo file
47 MAKEINFO = makeinfo
49 # How to create the HTML file
50 TEXI2HTML = makeinfo --html --number-sections
52 # How to move the byte compiled files to their destination.
53 MV = mv
55 # How to copy the lisp files to their distination.
56 CP = cp -p
58 ##----------------------------------------------------------------------
59 ## BELOW THIS LINE ON YOUR OWN RISK!
60 ##----------------------------------------------------------------------
62 # The following variables need to be defined by the maintainer
63 LISPF = org.el \
64 org-agenda.el \
65 org-archive.el \
66 org-bbdb.el \
67 org-bibtex.el \
68 org-clock.el \
69 org-colview.el \
70 org-colview-xemacs.el \
71 org-compat.el \
72 org-exp.el \
73 org-export-latex.el \
74 org-faces.el \
75 org-gnus.el \
76 org-info.el \
77 org-infojs.el \
78 org-irc.el \
79 org-mac-message.el \
80 org-macs.el \
81 org-mew.el \
82 org-mhe.el \
83 org-mouse.el \
84 org-publish.el \
85 org-remember.el \
86 org-rmail.el \
87 org-table.el \
88 org-vm.el \
89 org-wl.el
91 LISPFILES0 = $(LISPF:%=lisp/%)
92 LISPFILES = $(LISPFILES0) lisp/org-install.el
93 ELCFILES0 = $(LISPFILES0:.el=.elc)
94 ELCFILES = $(LISPFILES:.el=.elc)
95 DOCFILES = doc/org.texi doc/org.pdf doc/org doc/dir
96 CARDFILES = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
97 TEXIFILES = doc/org.texi
98 INFOFILES = doc/org
101 .SUFFIXES: .el .elc .texi
102 SHELL = /bin/sh
104 # Additional distribution files
105 DISTFILES_extra= Makefile ChangeLog request-assign-future.txt CONTRIB
106 DISTFILES_xemacs= xemacs/noutline.el xemacs/ps-print-invisible.el xemacs/README
108 default: $(ELCFILES)
110 all: $(ELCFILES) $(INFOFILES)
112 compile: $(ELCFILES0)
114 install: install-lisp
116 doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf
119 make pdf && open doc/org.pdf
122 make card && gv doc/orgcard.ps
124 install-lisp: $(LISPFILES) $(ELCFILES)
125 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
126 $(CP) $(LISPFILES) $(lispdir)
127 $(CP) $(ELCFILES) $(lispdir)
129 install-info: $(INFOFILES)
130 if [ ! -d $(infodir) ]; then $(MKDIR) $(infodir); else true; fi ;
131 $(CP) $(INFOFILES) $(infodir)
133 install-noutline: xemacs/noutline.elc
134 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
135 $(CP) xemacs/noutline.el xemacs/noutline.elc $(lispdir)
137 autoloads: lisp/org-install.el
139 lisp/org-install.el: $(LISPFILES0) Makefile
140 $(BATCH) --eval "(require 'autoload)" \
141 --eval '(find-file "org-install.el")' \
142 --eval '(erase-buffer)' \
143 --eval '(mapc (lambda (x) (generate-file-autoloads (symbol-name x))) (quote ($(LISPFILES0))))' \
144 --eval '(insert "\n(provide (quote org-install))\n")' \
145 --eval '(save-buffer)'
146 mv org-install.el lisp
148 xemacs/noutline.elc: xemacs/noutline.el
150 doc/org: doc/org.texi
151 (cd doc; $(MAKEINFO) --no-split org.texi -o org)
153 doc/org.pdf: doc/org.texi
154 (cd doc; $(TEXI2PDF) org.texi)
156 doc/org.html: doc/org.texi
157 (cd doc; $(TEXI2HTML) --no-split -o org.html org.texi)
159 doc/orgcard.dvi: doc/orgcard.tex
160 (cd doc; tex orgcard.tex)
162 doc/orgcard.pdf: doc/orgcard.dvi
163 dvips -q -f -t landscape doc/orgcard.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard.pdf -c .setpdfwrite -
165 doc/orgcard.ps: doc/orgcard.dvi
166 dvips -t landscape -o doc/orgcard.ps doc/orgcard.dvi
168 doc/orgcard_letter.dvi: doc/orgcard.tex
169 perl -pe 's/letterpaper=0/letterpaper=1/' doc/orgcard.tex > doc/orgcard_letter.tex
170 (cd doc; tex orgcard_letter.tex)
172 doc/orgcard_letter.pdf: doc/orgcard_letter.dvi
173 dvips -q -f -t landscape doc/orgcard_letter.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard_letter.pdf -c .setpdfwrite -
175 doc/orgcard_letter.ps: doc/orgcard_letter.dvi
176 dvips -t landscape -o doc/orgcard_letter.ps doc/orgcard_letter.dvi
178 # Below here are special targets for maintenance only
180 updateweb:
181 ssh cdominik@caprisun.dreamhost.com 'pull-worg-org.sh && publish-worg-org.sh'
183 html: doc/org.html
185 html_manual: doc/org.texi
186 rm -rf doc/manual
187 mkdir doc/manual
188 $(TEXI2HTML) -o doc/manual doc/org.texi
190 info: doc/org
192 pdf: doc/org.pdf
194 card: doc/orgcard.pdf doc/orgcard.ps doc/orgcard_letter.pdf doc/orgcard_letter.ps
196 distfile:
197 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
198 touch doc/org.texi doc/orgcard.tex # force update
199 make info
200 make doc
201 make lisp/org-install.el
202 rm -rf org-$(TAG) org-$(TAG).zip
203 $(MKDIR) org-$(TAG)
204 $(MKDIR) org-$(TAG)/xemacs
205 $(MKDIR) org-$(TAG)/doc
206 $(MKDIR) org-$(TAG)/lisp
207 cp -r $(LISPFILES) org-$(TAG)/lisp
208 cp -r $(DOCFILES) $(CARDFILES) org-$(TAG)/doc
209 cp -r $(DISTFILES_extra) org-$(TAG)/
210 cp -r README_DIST org-$(TAG)/README
211 cp -r ORGWEBPAGE/Changes.org org-$(TAG)/
212 cp -r $(DISTFILES_xemacs) org-$(TAG)/xemacs/
213 zip -r org-$(TAG).zip org-$(TAG)
214 gtar zcvf org-$(TAG).tar.gz org-$(TAG)
216 release:
217 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
218 make distfile
219 make doc
220 make html_manual
221 rm -rf RELEASEDIR
222 $(MKDIR) RELEASEDIR
223 cp org-$(TAG).zip org-$(TAG).tar.gz RELEASEDIR
224 cp doc/org.pdf doc/orgcard.pdf doc/org.texi doc/org.html RELEASEDIR
225 cp RELEASEDIR/org-$(TAG).zip RELEASEDIR/org.zip
226 cp RELEASEDIR/org-$(TAG).tar.gz RELEASEDIR/org.tar.gz
228 upload_release:
229 (cd RELEASEDIR; lftp -f ../../org-mode-proprietary/ftp_upload_release_legito)
231 upload_manual:
232 lftp -f ../org-mode-proprietary/ftp_upload_manual_legito
234 relup0:
235 make release
236 make upload_release
238 relup:
239 make release
240 make upload_release
241 make upload_manual
244 grep -e '(debug)' lisp/*el
246 cleanelc:
247 rm -f $(ELCFILES)
248 cleandoc:
249 (cd doc; rm -f org.pdf org org.html orgcard.pdf orgcard.ps)
250 (cd doc; rm -f *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.pg *.pgs)
251 (cd doc; rm -f *.toc *.tp *.tps *.vr *.vrs *.log *.html *.ps)
252 (cd doc; rm -f orgcard_letter.tex orgcard_letter.pdf)
253 (cd doc; rm -rf manual)
254 clean:
255 make cleanelc
256 make cleandoc
257 rm -f *~ */*~ */*/*~
258 rm -rf RELEASEDIR
259 rm -f lisp/org-install.el
261 .el.elc:
262 $(ELC) $<
265 push:
266 git-push git+ssh://repo.or.cz/srv/git/org-mode.git master
268 pushtag:
269 git-tag -m "Adding tag" -a $(TAG)
270 git-push git+ssh://repo.or.cz/srv/git/org-mode.git $(TAG)
272 pushreleasetag:
273 git-tag -m "Adding tag" -a release_$(TAG)
274 git-push git+ssh://repo.or.cz/srv/git/org-mode.git release_$(TAG)
278 # Dependencies
280 lisp/org.elc: lisp/org-macs.elc lisp/org-compat.elc lisp/org-faces.elc
281 lisp/org-agenda.elc: lisp/org.elc
282 lisp/org-archive.elc: lisp/org.elc
283 lisp/org-bbdb.elc: lisp/org.elc
284 lisp/org-bibtex.elc: lisp/org.elc
285 lisp/org-clock.elc: lisp/org.elc
286 lisp/org-colview.elc: lisp/org.elc
287 lisp/org-colview-xemacs.elc: lisp/org.elc
288 lisp/org-compat.elc:
289 lisp/org-exp.elc: lisp/org.elc lisp/org-agenda.elc
290 lisp/org-export-latex.elc: lisp/org.elc lisp/org-exp.elc
291 lisp/org-faces.elc: lisp/org-macs.elc lisp/org-compat.elc
292 lisp/org-gnus.elc: lisp/org.elc
293 lisp/org-info.elc: lisp/org.elc
294 lisp/org-infojs.elc: lisp/org.elc lisp/org-exp.elc
295 lisp/org-irc.elc: lisp/org.elc
296 lisp/org-mac-message.elc: lisp/org.elc
297 lisp/org-macs.elc:
298 lisp/org-mew.elc: lisp/org.elc
299 lisp/org-mhe.elc: lisp/org.elc
300 lisp/org-mouse.elc: lisp/org.elc
301 lisp/org-publish.elc:
302 lisp/org-remember.elc: lisp/org.elc
303 lisp/org-rmail.elc: lisp/org.elc
304 lisp/org-table.elc: lisp/org.elc
305 lisp/org-vm.elc: lisp/org.elc
306 lisp/org-wl.elc: lisp/org.elc