Merge pull request #11 from esorton/bugfix/add-constexpr-keyword-to-arduino-ctags
[arduino-ctags.git] / INSTALL.oth
blob8577c7e08d02fd30aae327e859e36c26a5642169
1 If you are attempting to install Exuberant Ctags on a Unix-like platform
2 (one that can at least run a Bourne shell script) see the file INSTALL.
4 Installation Notes
5 ==================
7 For non-Unix platforms, simple makefiles are provided:
9     descrip.mms   For VMS using either DEC C or VAX C
10     mk_bc3.mak    For MSDOS using Borland C/C++ 3.x
11     mk_bc5.mak    For Win32 using Borland C++ 5.5
12     mk_djg.mak    For MSDOS using DJGPP Gnu GCC (better to follow Unix install)
13     mk_manx.mak   For Amiga using Aztec/Manx C 5.0
14     mk_mingw.mak  For Win32 using MinGW
15     mk_mpw.mak    For Macintosh using MPW
16     mk_mvc.mak    For Win32 using Microsoft Visual C++
17     mk_os2.mak    For OS/2 using GCC (EMX)
18     mk_qdos.mak   For QDOS using C68
19     mk_riscos.mak For RISC OS using the GCC SDK <http://hard-mofo.dsvr.net>
20     mk_sas.mak    For Amiga using SAS/C
23 Special Notes
24 =============
26 DJGPP:
27 ------
29   It is better to follow the standard Unix install on DJGPP, but this requires
30   that you use BASH and requires a fairly complete installation of GJGPP
31   packages. You can use mk_djg.mak if you can't run configure.
33 Macintosh with MPW:
34 -------------------
36   To build Ctags on MPW you will have to have the Metrowerks compilers
37   or you will have to edit the makefiles yourself.
38   
39   Since the makefile for MPW is called mk_mpw.mak you will have to give
40   the command: `Make -f mk_mpw.mak CTags` and then select the output
41   and execute it. Alternatively you could rename this makefile to
42   CTags.make and issue the command `Build CTags`.
43   
44   If the build process goes wrong make sure the line endings for the
45   makefile are set to MacOS (CR instead of LF).
47   This version of Ctags only accepts and emits unix style paths. This was
48   done since it was easier to implement (few changes in main source files)
49   and since I ported Ctags to MPW to use with Pepper which also works with
50   unix style paths internally. Besides, since we're now moving to MacOS X
51   anyway, Mac programmers are getting used to unix style paths anyway.
52   
53   Example, suppose you have a project using PowerPlant which is located in
54   'HD20:tools:PowerPlant:' and you want a tags file for all powerplant
55   sources and your projects sources. Go to the root directory of your
56   project and type:
58     CTags -R . '/HD20/tools/PowerPlant/'
60   The '.' in this command means current directory. You will also have to
61   put quotes around the full unix style path since / has a special meaning
62   in MPW.
63   
64 RISC OS:
65 --------
67   Regex support on RISC OS is available when compiled to use the RISC OS port
68   of the GNU regex library, which can be obtained from:
70     <http://www.sbellon.de/software.html>
72   Using 'Set RexEx$Path <Obey$Dir>.' in the regex-0/12 directory will ensure
73   it can be found.