Document the new startup keyword to preview LaTeX fragments
[org-mode.git] / mk / default.mk
blobdcd29476a2a95f9f4c59df93b029538757270480
1 ##----------------------------------------------------------------------
2 ## NEVER EDIT THIS FILE, PUT ANY ADAPTATIONS INTO local.mk
3 ##-8<-------------------------------------------------------------------
4 ## CHECK AND ADAPT THE FOLLOWING DEFINITIONS
5 ##----------------------------------------------------------------------
7 # Name of your emacs binary
8 EMACS = emacs
10 # Where local software is found
11 prefix = /usr/share
13 # Where local lisp files go.
14 lispdir= $(prefix)/emacs/site-lisp/org
16 # Where local data files go.
17 datadir = $(prefix)/emacs/etc/org
19 # Where info files go.
20 infodir = $(prefix)/info
22 # Define if you only need info documentation, the default includes html and pdf
23 #ORG_MAKE_DOC = info # html pdf
25 # Define if you want to include some (or all) files from contrib/lisp
26 # just the filename please (no path prefix, no .el suffix), maybe with globbing
27 #ORG_ADD_CONTRIB = org-e-* org-md org-export # e.g. the new exporter
29 # Where to create temporary files for the testsuite
30 # respect TMPDIR if it is already defined in the environment
31 TMPDIR ?= /tmp
32 testdir = $(TMPDIR)/tmp-orgtest
34 # Configuration for testing
35 # add options before standard load-path
36 BTEST_PRE =
37 # add options after standard load path
38 BTEST_POST =
39 # -L <path-to>/ert # needed for Emacs23, Emacs24 has ert built in
40 # -L <path-to>/ess # needed for running R tests
41 # -L <path-to>/htmlize # need at least version 1.34 for source code formatting
42 BTEST_OB_LANGUAGES = awk C fortran maxima lilypond octave python sh
43 # R # requires ESS to be installed and configured
44 # extra packages to require for testing
45 BTEST_EXTRA =
46 # ess-site # load ESS for R tests
47 ##->8-------------------------------------------------------------------
48 ## YOU MAY NEED TO ADAPT THESE DEFINITIONS
49 ##----------------------------------------------------------------------
51 # How to run tests
52 req-ob-lang = --eval '(require '"'"'ob-$(ob-lang))'
53 req-extra = --eval '(require '"'"'$(req))'
54 BTEST = $(BATCH) \
55 $(BTEST_PRE) \
56 --eval '(add-to-list '"'"'load-path "./lisp")' \
57 --eval '(add-to-list '"'"'load-path "./testing")' \
58 $(BTEST_POST) \
59 -l org-loaddefs.el \
60 -l testing/org-test.el \
61 $(foreach ob-lang,$(BTEST_OB_LANGUAGES),$(req-ob-lang)) \
62 $(foreach req,$(BTEST_EXTRA),$(req-extra)) \
63 --eval '(setq org-confirm-babel-evaluate nil)' \
64 -f org-test-run-batch-tests
66 # Using emacs in batch mode.
67 # BATCH = $(EMACS) -batch -vanilla # XEmacs
68 BATCH = $(EMACS) -batch -Q
70 # Emacs must be started in toplevel directory
71 BATCHO = $(BATCH) \
72 --eval '(add-to-list '"'"'load-path "./lisp")'
74 # How to generate local.mk
75 MAKE_LOCAL_MK = $(BATCHO) \
76 --eval '(load "org-compat.el")' \
77 --eval '(load "../mk/org-fixup.el")' \
78 --eval '(org-make-local-mk)'
80 # Emacs must be started in lisp directory
81 BATCHL = $(BATCH) \
82 --eval '(add-to-list '"'"'load-path ".")'
84 # How to generate org-loaddefs.el
85 MAKE_ORG_INSTALL = $(BATCHL) \
86 --eval '(load "org-compat.el")' \
87 --eval '(load "../mk/org-fixup.el")' \
88 --eval '(org-make-org-loaddefs)'
90 # How to generate org-version.el
91 MAKE_ORG_VERSION = $(BATCHL) \
92 --eval '(load "org-compat.el")' \
93 --eval '(load "../mk/org-fixup.el")' \
94 --eval '(org-make-org-version "$(ORGVERSION)" "$(GITVERSION)" "$(datadir)")'
96 # How to byte-compile the whole source directory
97 ELCDIR = $(BATCHL) \
98 --eval '(batch-byte-recompile-directory 0)'
100 # How to byte-compile a single file
101 ELC = $(BATCHL) \
102 --eval '(batch-byte-compile)'
104 # How to make a pdf file from a texinfo file
105 TEXI2PDF = texi2pdf --batch --clean
107 # How to make a pdf file from a tex file
108 PDFTEX = pdftex
110 # How to create directories with leading path components
111 # MKDIR = mkdir -m 755 -p # try this if you have no install
112 MKDIR = install -m 755 -d
114 # How to create the info files from the texinfo file
115 MAKEINFO = makeinfo
117 # How to create the HTML file
118 TEXI2HTML = makeinfo --html --number-sections
120 # How to find files
121 FIND = find
123 # How to remove files
124 RM = rm -f
126 # How to remove files recursively
127 RMR = rm -fr
129 # How to copy the lisp files and elc files to their destination.
130 # CP = cp -p # try this if you have no install
131 CP = install -m 644 -p
133 # How to obtain administrative privileges
134 # leave blank if you don't need this
135 # SUDO =
136 SUDO = sudo
138 # Name of the program to install info files
139 # INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
140 INSTALL_INFO = install-info
142 # target method for 'compile'
143 ORGCM = dirall
144 # ORGCM = dirall # 1x slowdown compared to default compilation method
145 # ORGCM = single # 4x one Emacs process per compilation
146 # ORGCM = source # 5x ditto, but remove compiled file immediately
147 # ORGCM = slint1 # 3x possibly elicit more warnings
148 # ORGCM = slint2 # 7x possibly elicit even more warnings