Fix typo in documentation.
[org-mode.git] / Makefile
blob4523b6775b7d5b4586a4d52904b9624b89014182
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 copy the lisp files and elc files to their distination.
53 CP = cp -p
55 ##----------------------------------------------------------------------
56 ## BELOW THIS LINE ON YOUR OWN RISK!
57 ##----------------------------------------------------------------------
59 # The following variables need to be defined by the maintainer
60 LISPF = org.el \
61 org-agenda.el \
62 org-archive.el \
63 org-bbdb.el \
64 org-bibtex.el \
65 org-clock.el \
66 org-colview.el \
67 org-colview-xemacs.el \
68 org-compat.el \
69 org-exp.el \
70 org-export-latex.el \
71 org-faces.el \
72 org-gnus.el \
73 org-id.el \
74 org-info.el \
75 org-jsinfo.el \
76 org-irc.el \
77 org-mac-message.el \
78 org-macs.el \
79 org-mew.el \
80 org-mhe.el \
81 org-mouse.el \
82 org-publish.el \
83 org-remember.el \
84 org-rmail.el \
85 org-table.el \
86 org-vm.el \
87 org-wl.el
89 LISPFILES0 = $(LISPF:%=lisp/%)
90 LISPFILES = $(LISPFILES0) lisp/org-install.el
91 ELCFILES0 = $(LISPFILES0:.el=.elc)
92 ELCFILES = $(LISPFILES:.el=.elc)
93 DOCFILES = doc/org.texi doc/org.pdf doc/org doc/dir
94 CARDFILES = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
95 TEXIFILES = doc/org.texi
96 INFOFILES = doc/org
99 .SUFFIXES: .el .elc .texi
100 SHELL = /bin/sh
102 # Additional distribution files
103 DISTFILES_extra= Makefile ChangeLog request-assign-future.txt contrib
104 DISTFILES_xemacs= xemacs/noutline.el xemacs/ps-print-invisible.el xemacs/README
106 default: $(ELCFILES)
108 all: $(ELCFILES) $(INFOFILES)
110 compile: $(ELCFILES0)
112 install: install-lisp
114 doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf
117 make pdf && open doc/org.pdf
120 make card && gv doc/orgcard.ps
122 install-lisp: $(LISPFILES) $(ELCFILES)
123 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
124 $(CP) $(LISPFILES) $(lispdir)
125 $(CP) $(ELCFILES) $(lispdir)
127 install-info: $(INFOFILES)
128 if [ ! -d $(infodir) ]; then $(MKDIR) $(infodir); else true; fi ;
129 $(CP) $(INFOFILES) $(infodir)
131 install-noutline: xemacs/noutline.elc
132 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
133 $(CP) xemacs/noutline.el xemacs/noutline.elc $(lispdir)
135 autoloads: lisp/org-install.el
137 lisp/org-install.el: $(LISPFILES0) Makefile
138 $(BATCH) --eval "(require 'autoload)" \
139 --eval '(find-file "org-install.el")' \
140 --eval '(erase-buffer)' \
141 --eval '(mapc (lambda (x) (generate-file-autoloads (symbol-name x))) (quote ($(LISPFILES0))))' \
142 --eval '(insert "\n(provide (quote org-install))\n")' \
143 --eval '(save-buffer)'
144 mv org-install.el lisp
146 xemacs/noutline.elc: xemacs/noutline.el
148 doc/org: doc/org.texi
149 (cd doc; $(MAKEINFO) --no-split org.texi -o org)
151 doc/org.pdf: doc/org.texi
152 (cd doc; $(TEXI2PDF) org.texi)
154 doc/org.html: doc/org.texi
155 (cd doc; $(TEXI2HTML) --no-split -o org.html org.texi)
157 doc/orgcard.dvi: doc/orgcard.tex
158 (cd doc; tex orgcard.tex)
160 doc/orgcard.pdf: doc/orgcard.dvi
161 dvips -q -f -t landscape doc/orgcard.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard.pdf -c .setpdfwrite -
163 doc/orgcard.ps: doc/orgcard.dvi
164 dvips -t landscape -o doc/orgcard.ps doc/orgcard.dvi
166 doc/orgcard_letter.dvi: doc/orgcard.tex
167 perl -pe 's/letterpaper=0/letterpaper=1/' doc/orgcard.tex > doc/orgcard_letter.tex
168 (cd doc; tex orgcard_letter.tex)
170 doc/orgcard_letter.pdf: doc/orgcard_letter.dvi
171 dvips -q -f -t landscape doc/orgcard_letter.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard_letter.pdf -c .setpdfwrite -
173 doc/orgcard_letter.ps: doc/orgcard_letter.dvi
174 dvips -t landscape -o doc/orgcard_letter.ps doc/orgcard_letter.dvi
176 # Below here are special targets for maintenance only
178 updateweb:
179 ssh cdominik@caprisun.dreamhost.com 'pull-worg-org.sh && publish-worg-org.sh'
181 html: doc/org.html
183 html_manual: doc/org.texi
184 rm -rf doc/manual
185 mkdir doc/manual
186 $(TEXI2HTML) -o doc/manual doc/org.texi
188 info: doc/org
190 pdf: doc/org.pdf
192 card: doc/orgcard.pdf doc/orgcard.ps doc/orgcard_letter.pdf doc/orgcard_letter.ps
194 distfile:
195 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
196 touch doc/org.texi doc/orgcard.tex # force update
197 make info
198 make doc
199 make lisp/org-install.el
200 rm -rf org-$(TAG) org-$(TAG).zip
201 $(MKDIR) org-$(TAG)
202 $(MKDIR) org-$(TAG)/xemacs
203 $(MKDIR) org-$(TAG)/doc
204 $(MKDIR) org-$(TAG)/lisp
205 cp -r $(LISPFILES) org-$(TAG)/lisp
206 cp -r $(DOCFILES) $(CARDFILES) org-$(TAG)/doc
207 cp -r $(DISTFILES_extra) org-$(TAG)/
208 cp -r README_DIST org-$(TAG)/README
209 cp -r ORGWEBPAGE/Changes.org org-$(TAG)/
210 cp -r $(DISTFILES_xemacs) org-$(TAG)/xemacs/
211 zip -r org-$(TAG).zip org-$(TAG)
212 gtar zcvf org-$(TAG).tar.gz org-$(TAG)
214 release:
215 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
216 make distfile
217 make doc
218 UTILITIES/gplmanual.pl
219 make html_manual
220 rm -rf RELEASEDIR
221 $(MKDIR) RELEASEDIR
222 cp org-$(TAG).zip org-$(TAG).tar.gz RELEASEDIR
223 cp doc/org.pdf doc/orgcard.pdf doc/org.texi doc/org.html RELEASEDIR
224 cp RELEASEDIR/org-$(TAG).zip RELEASEDIR/org.zip
225 cp RELEASEDIR/org-$(TAG).tar.gz RELEASEDIR/org.tar.gz
227 upload_release:
228 (cd RELEASEDIR; lftp -f ../../org-mode-proprietary/ftp_upload_release_legito)
230 upload_manual:
231 lftp -f ../org-mode-proprietary/ftp_upload_manual_legito
233 relup0:
234 make release
235 make upload_release
237 relup:
238 make release
239 make upload_release
240 make upload_manual
243 grep -e '(debug)' lisp/*el
245 cleanelc:
246 rm -f $(ELCFILES)
247 cleandoc:
248 (cd doc; rm -f org.pdf org org.html orgcard.pdf orgcard.ps)
249 (cd doc; rm -f *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.pg *.pgs)
250 (cd doc; rm -f *.toc *.tp *.tps *.vr *.vrs *.log *.html *.ps)
251 (cd doc; rm -f orgcard_letter.tex orgcard_letter.pdf)
252 (cd doc; rm -rf manual)
253 clean:
254 make cleanelc
255 make cleandoc
256 rm -f *~ */*~ */*/*~
257 rm -rf RELEASEDIR
258 rm -f lisp/org-install.el
260 .el.elc:
261 $(ELC) $<
264 push:
265 git-push git+ssh://repo.or.cz/srv/git/org-mode.git master
267 pushtag:
268 git-tag -m "Adding tag" -a $(TAG)
269 git-push git+ssh://repo.or.cz/srv/git/org-mode.git $(TAG)
271 pushreleasetag:
272 git-tag -m "Adding release tag" -a release_$(TAG)
273 git-push git+ssh://repo.or.cz/srv/git/org-mode.git release_$(TAG)
275 dummy:
276 echo ${prefix}
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-id.elc: lisp/org.elc
294 lisp/org-info.elc: lisp/org.elc
295 lisp/org-jsinfo.elc: lisp/org.elc lisp/org-exp.elc
296 lisp/org-irc.elc: lisp/org.elc
297 lisp/org-mac-message.elc: lisp/org.elc
298 lisp/org-macs.elc:
299 lisp/org-mew.elc: lisp/org.elc
300 lisp/org-mhe.elc: lisp/org.elc
301 lisp/org-mouse.elc: lisp/org.elc
302 lisp/org-publish.elc:
303 lisp/org-remember.elc: lisp/org.elc
304 lisp/org-rmail.elc: lisp/org.elc
305 lisp/org-table.elc: lisp/org.elc
306 lisp/org-vm.elc: lisp/org.elc
307 lisp/org-wl.elc: lisp/org.elc