Add documentation to new functions in org-gnus.el.
[org-mode.git] / Makefile
blob63737e527d41998c4ef6f50ad7acff6488202ba0
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)/share/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 # Name of the program to install info files
56 INSTALL_INFO=install-info
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-attach.el \
66 org-archive.el \
67 org-bbdb.el \
68 org-bibtex.el \
69 org-clock.el \
70 org-colview.el \
71 org-colview-xemacs.el \
72 org-compat.el \
73 org-exp.el \
74 org-export-latex.el \
75 org-faces.el \
76 org-gnus.el \
77 org-id.el \
78 org-info.el \
79 org-jsinfo.el \
80 org-irc.el \
81 org-list.el \
82 org-mac-message.el \
83 org-macs.el \
84 org-mew.el \
85 org-mhe.el \
86 org-mouse.el \
87 org-publish.el \
88 org-plot.el \
89 org-remember.el \
90 org-rmail.el \
91 org-table.el \
92 org-vm.el \
93 org-wl.el
95 LISPFILES0 = $(LISPF:%=lisp/%)
96 LISPFILES = $(LISPFILES0) lisp/org-install.el
97 ELCFILES0 = $(LISPFILES0:.el=.elc)
98 ELCFILES = $(LISPFILES:.el=.elc)
99 DOCFILES = doc/org.texi doc/org.pdf doc/org doc/dir
100 CARDFILES = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
101 TEXIFILES = doc/org.texi
102 INFOFILES = doc/org
105 .SUFFIXES: .el .elc .texi
106 SHELL = /bin/sh
108 # Additional distribution files
109 DISTFILES_extra= Makefile ChangeLog request-assign-future.txt contrib
110 DISTFILES_xemacs= xemacs/noutline.el xemacs/ps-print-invisible.el xemacs/README
112 default: $(ELCFILES)
114 all: $(ELCFILES) $(INFOFILES)
116 compile: $(ELCFILES0)
118 install: install-lisp
120 doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf
123 make pdf && open doc/org.pdf
126 make card && gv doc/orgcard.ps
128 install-lisp: $(LISPFILES) $(ELCFILES)
129 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
130 $(CP) $(LISPFILES) $(lispdir)
131 $(CP) $(ELCFILES) $(lispdir)
133 install-info: $(INFOFILES)
134 if [ ! -d $(infodir) ]; then $(MKDIR) $(infodir); else true; fi ;
135 $(CP) $(INFOFILES) $(infodir)
136 $(INSTALL_INFO) --info-file=$(INFOFILES) --info-dir=$(infodir)
138 install-noutline: xemacs/noutline.elc
139 if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
140 $(CP) xemacs/noutline.el xemacs/noutline.elc $(lispdir)
142 autoloads: lisp/org-install.el
144 lisp/org-install.el: $(LISPFILES0) Makefile
145 $(BATCH) --eval "(require 'autoload)" \
146 --eval '(find-file "org-install.el")' \
147 --eval '(erase-buffer)' \
148 --eval '(mapc (lambda (x) (generate-file-autoloads (symbol-name x))) (quote ($(LISPFILES0))))' \
149 --eval '(insert "\n(provide (quote org-install))\n")' \
150 --eval '(save-buffer)'
151 mv org-install.el lisp
153 xemacs/noutline.elc: xemacs/noutline.el
155 doc/org: doc/org.texi
156 (cd doc; $(MAKEINFO) --no-split org.texi -o org)
158 doc/org.pdf: doc/org.texi
159 (cd doc; $(TEXI2PDF) org.texi)
161 doc/org.html: doc/org.texi
162 (cd doc; $(TEXI2HTML) --no-split -o org.html org.texi)
164 doc/orgcard.dvi: doc/orgcard.tex
165 (cd doc; tex orgcard.tex)
167 doc/orgcard.pdf: doc/orgcard.dvi
168 dvips -q -f -t landscape doc/orgcard.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard.pdf -c .setpdfwrite -
170 doc/orgcard.ps: doc/orgcard.dvi
171 dvips -t landscape -o doc/orgcard.ps doc/orgcard.dvi
173 doc/orgcard_letter.dvi: doc/orgcard.tex
174 perl -pe 's/letterpaper=0/letterpaper=1/' doc/orgcard.tex > doc/orgcard_letter.tex
175 (cd doc; tex orgcard_letter.tex)
177 doc/orgcard_letter.pdf: doc/orgcard_letter.dvi
178 dvips -q -f -t landscape doc/orgcard_letter.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=doc/orgcard_letter.pdf -c .setpdfwrite -
180 doc/orgcard_letter.ps: doc/orgcard_letter.dvi
181 dvips -t landscape -o doc/orgcard_letter.ps doc/orgcard_letter.dvi
183 # Below here are special targets for maintenance only
185 updateweb:
186 ssh cdominik@caprisun.dreamhost.com 'pull-worg-org.sh && publish-worg-org.sh'
188 html: doc/org.html
190 html_manual: doc/org.texi
191 rm -rf doc/manual
192 mkdir doc/manual
193 $(TEXI2HTML) -o doc/manual doc/org.texi
195 info: doc/org
197 pdf: doc/org.pdf
199 card: doc/orgcard.pdf doc/orgcard.ps doc/orgcard_letter.pdf doc/orgcard_letter.ps
201 distfile:
202 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
203 touch doc/org.texi doc/orgcard.tex # force update
204 make cleancontrib
205 make info
206 make doc
207 make lisp/org-install.el
208 rm -rf org-$(TAG) org-$(TAG).zip
209 $(MKDIR) org-$(TAG)
210 $(MKDIR) org-$(TAG)/xemacs
211 $(MKDIR) org-$(TAG)/doc
212 $(MKDIR) org-$(TAG)/lisp
213 cp -r $(LISPFILES) org-$(TAG)/lisp
214 cp -r $(DOCFILES) $(CARDFILES) org-$(TAG)/doc
215 cp -r $(DISTFILES_extra) org-$(TAG)/
216 cp -r README_DIST org-$(TAG)/README
217 cp -r ORGWEBPAGE/Changes.org org-$(TAG)/
218 cp -r $(DISTFILES_xemacs) org-$(TAG)/xemacs/
219 zip -r org-$(TAG).zip org-$(TAG)
220 gtar zcvf org-$(TAG).tar.gz org-$(TAG)
222 release:
223 @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
224 make distfile
225 make doc
226 UTILITIES/gplmanual.pl
227 make html_manual
228 rm -rf RELEASEDIR
229 $(MKDIR) RELEASEDIR
230 cp org-$(TAG).zip org-$(TAG).tar.gz RELEASEDIR
231 cp doc/org.pdf doc/orgcard.pdf doc/org.texi doc/org.html RELEASEDIR
232 cp RELEASEDIR/org-$(TAG).zip RELEASEDIR/org.zip
233 cp RELEASEDIR/org-$(TAG).tar.gz RELEASEDIR/org.tar.gz
235 upload_release:
236 (cd RELEASEDIR; lftp -f ../../org-mode-proprietary/ftp_upload_release_legito)
238 upload_manual:
239 lftp -f ../org-mode-proprietary/ftp_upload_manual_legito
241 relup0:
242 make release
243 make upload_release
245 relup:
246 make release
247 make upload_release
248 make upload_manual
251 grep -e '(debug)' lisp/*el
253 cleancontrib:
254 find contrib -name \*~ -exec rm {} \;
256 cleanelc:
257 rm -f $(ELCFILES)
258 cleandoc:
259 (cd doc; rm -f org.pdf org org.html orgcard.pdf orgcard.ps)
260 (cd doc; rm -f *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.pg *.pgs)
261 (cd doc; rm -f *.toc *.tp *.tps *.vr *.vrs *.log *.html *.ps)
262 (cd doc; rm -f orgcard_letter.tex orgcard_letter.pdf)
263 (cd doc; rm -rf manual)
265 cleanrel:
266 rm -rf RELEASEDIR
267 rm -rf org-6.*
268 rm -f org-6*zip org-6*tar.gz
270 clean:
271 make cleanelc
272 make cleandoc
273 make cleanrel
274 rm -f *~ */*~ */*/*~
276 cleanall:
277 make clean
278 rm -f lisp/org-install.el
280 .el.elc:
281 $(ELC) $<
284 push:
285 git-push git+ssh://repo.or.cz/srv/git/org-mode.git master
287 pushtag:
288 git-tag -m "Adding tag" -a $(TAG)
289 git-push git+ssh://repo.or.cz/srv/git/org-mode.git $(TAG)
291 pushreleasetag:
292 git-tag -m "Adding release tag" -a release_$(TAG)
293 git-push git+ssh://repo.or.cz/srv/git/org-mode.git release_$(TAG)
295 dummy:
296 echo ${prefix}
298 # Dependencies
300 lisp/org.elc: lisp/org-macs.elc lisp/org-compat.elc lisp/org-faces.elc
301 lisp/org-agenda.elc: lisp/org.elc
302 lisp/org-attach.elc: lisp/org.elc lisp/org-id.elc
303 lisp/org-archive.elc: lisp/org.elc
304 lisp/org-bbdb.elc: lisp/org.elc
305 lisp/org-bibtex.elc: lisp/org.elc
306 lisp/org-clock.elc: lisp/org.elc
307 lisp/org-colview.elc: lisp/org.elc
308 lisp/org-colview-xemacs.elc: lisp/org.elc
309 lisp/org-compat.elc: lisp/org-macs.elc
310 lisp/org-exp.elc: lisp/org.elc lisp/org-agenda.elc
311 lisp/org-export-latex.elc: lisp/org.elc lisp/org-exp.elc
312 lisp/org-faces.elc: lisp/org-macs.elc lisp/org-compat.elc
313 lisp/org-gnus.elc: lisp/org.elc
314 lisp/org-id.elc: lisp/org.elc
315 lisp/org-info.elc: lisp/org.elc
316 lisp/org-irc.elc: lisp/org.elc
317 lisp/org-jsinfo.elc: lisp/org.elc lisp/org-exp.elc
318 lisp/org-list.elc: lisp/org-macs.elc lisp/org-compat.elc
319 lisp/org-mac-message.elc: lisp/org.elc
320 lisp/org-macs.elc:
321 lisp/org-mew.elc: lisp/org.elc
322 lisp/org-mhe.elc: lisp/org.elc
323 lisp/org-mouse.elc: lisp/org.elc
324 lisp/org-plot.elc: lisp/org.elc lisp/org-exp.elc lisp/org-table.elc
325 lisp/org-publish.elc:
326 lisp/org-remember.elc: lisp/org.elc
327 lisp/org-rmail.elc: lisp/org.elc
328 lisp/org-table.elc: lisp/org.elc
329 lisp/org-vm.elc: lisp/org.elc
330 lisp/org-wl.elc: lisp/org.elc