org-export: Consider colons as a safe character for targets
[org-mode.git] / Makefile
1 # Makefile - for the org-mode distribution
2 # GNU make is required
3 #
4 # This file is not part of GNU Emacs
5
6 # set up environment
7  include mk/default.mk  # defaults, customizable via "local.mk"
8 -include local.mk       # optional local customization, use default.mk as template
9
10 # default target is "all" unless overridden in local.mk
11 all::
12
13 # Describe valid make targets for org-mode.
14 .PHONY: targets help helpall
15 targets:        help
16 help helpall::
17         $(info )
18         $(info Getting Help)
19         $(info ============)
20         $(info )
21         $(info make help           - show brief help)
22         $(info make targets        - ditto)
23         $(info make helpall        - show extended help)
24         $(info )
25         $(info Build and Check)
26         $(info ===============)
27         $(info make                - build Org ELisp and all documentation)
28         $(info make all            - ditto)
29         $(info make compile        - build Org ELisp files)
30         $(info make single         - build Org ELisp files, single Emacs per source)
31         $(info make autoloads      - create org-loaddefs.el to load Org in-place)
32         $(info make test           - build Org ELisp files and run test suite)
33 helpall::
34         $(info make test-dirty     - check without building first)
35         $(info make compile-dirty  - build only stale Org ELisp files)
36         $(info )
37         $(info Compatibility)
38         $(info =============)
39         $(info make oldorg         - what the old make did: compile autoloads info)
40         $(info )
41         $(info Cleaning)
42         $(info ========)
43         $(info make clean          - remove built Org ELisp files and documentation)
44         $(info make cleanall       - remove everything that can be built and all remnants)
45         $(info make clean-install  - remove previous Org installation)
46         $(info )
47         $(info Configuration Check)
48         $(info ===================)
49 help helpall::
50         $(info make config         - check main configuration)
51 helpall::
52         $(info make config-version - check Org version)
53         $(info make config-test    - check test configuration)
54         $(info make config-exe     - check executables configuration)
55         $(info make config-cmd     - check command configuration)
56         $(info make config-all     - check all configuration)
57         $(info )
58         $(info Documentation)
59         $(info =============)
60 help helpall::
61         $(info make doc            - build all documentation)
62 helpall::
63         $(info make docs           - ditto)
64 help helpall::
65         $(info make info           - build Info documentation)
66 helpall::
67         $(info make html           - build HTML documentation)
68         $(info make pdf            - build PDF documentation)
69         $(info make card           - build reference cards)
70         $(info make refcard        - ditto)
71 help helpall::
72         $(info )
73         $(info Installation)
74         $(info ============)
75         $(info make install        - build and install Org)
76 helpall::
77         $(info make install-etc    - build and install files in /etc)
78         $(info make install-lisp   - build and install Org Elisp files)
79         $(info make install-info   - build and install Info documentation)
80         $(info )
81         $(info Convenience)
82         $(info ===========)
83         $(info make up0            - pull from upstream)
84         $(info make up1            - pull from upstream, build and check)
85         $(info make up2            - pull from upstream, build, check and install)
86         $(info make update         - pull from upstream and build)
87         $(info make update2        - pull from upstream, build and install)
88         $(info make uncompiled     - combine cleanlisp and autoloads)
89         $(info make local.mk       - create new local.mk as template for adaptation)
90 help helpall::
91         $(info )
92         $(info Full documentation on Worg)
93         $(info ==========================)
94         $(info http://orgmode.org/worg/dev/org-build-system.html)
95         @echo ""
96
97  include mk/targets.mk  # toplevel make machinery