README 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. THE AMSTERDAM COMPILER KIT V6.0pre4
  2. ===================================
  3. © 1987-2005 Vrije Universiteit, Amsterdam
  4. 2010-08-08
  5. INTRODUCTION
  6. ============
  7. The Amsterdam Compiler Kit is a complete compiler toolchain consisting of
  8. front end compilers for a number of different languages, code generators,
  9. support libraries, and all the tools necessary to go from source code to
  10. executable on any of the platforms it supports.
  11. This is an early prerelease of the apocryphal version 6.0 release. Not a
  12. lot is supported, the build mechanism needs work, and a lot of things are
  13. probably broken. However, what's there should be sufficient to get things
  14. done and to evaluate how the full 6.0 release should work.
  15. SUPPORT
  16. =======
  17. Languages:
  18. ANSI C, Pascal, Modula 2. K&R is supported via the ANSI C compiler.
  19. Platforms:
  20. pc86 produces bootable floppy disk images for 8086 PCs
  21. linux386 produces ELF executables for PC Linux systems
  22. cpm produces i80 CP/M .COM files
  23. INSTALLATION
  24. ============
  25. The version 6.0 build mechanism has been completely rewritten and is based
  26. around the Prime Mover build tool (see http://primemover.sf.net for more
  27. information). Installation ought to be fairly straightforward.
  28. Requirements:
  29. - an ANSI C compiler. Currently, I'm afraid, it's hard-coded to use gcc.
  30. To change, try changing the variable definitions in first/c.pm. This also
  31. needs to be available as 'cc' from the shell.
  32. - about 20MB free in /tmp (or some other temporary directory).
  33. - about 6MB in the target directory.
  34. Instructions:
  35. - edit config.pm. There's a small section at the top containing some editable
  36. variables. Probably the only one you may want to edit is PREFIX, which
  37. changes where the ACK installs to.
  38. - Run:
  39. ./pm configure
  40. ...from the command line. This will write out a configuration file.
  41. - Run:
  42. ./pm
  43. ...from the command line. This will actually do the build. This takes
  44. about two minutes on my 1.6GHz Athlon Linux machine and about 30 on my
  45. 166MHz Pentium OpenBSD machine.
  46. - Run:
  47. ./pm install
  48. ...from the command line (possibly with sudo). This will install the built
  49. ACK into whatever directory you nominated in PREFIX.
  50. The ACK should now be ready to use.
  51. USAGE
  52. =====
  53. Currently I haven't sorted out all the documentation --- it's supplied in the
  54. distribution, but not all of it gets installed yet --- so here is a quickstart
  55. guide.
  56. The main command to use is 'ack'. This invokes the compiler and the linker.
  57. Some useful options include:
  58. -m<platform> build for the specified platform
  59. -o <file> specifies the output file
  60. -c produce a .o file
  61. -c.s produce a .s assembly file
  62. -O enable optimisation
  63. -ansi compile ANSI C (when using the C compiler)
  64. <file> build file
  65. ack figures out which language to use from the file extension:
  66. .c C (ANSI or K&R)
  67. .b Basic
  68. .mod Modula-2
  69. .ocm Occam 1
  70. .p Pascal
  71. .o object files
  72. .s assembly files
  73. For further information, see the man page (which actually does get
  74. installed, but is rather out of date).
  75. There are some (known working) example programs in the 'examples' directory.
  76. A sample command line is:
  77. ack -mlinux386 -O examples/paranoia.c
  78. GOTCHAS
  79. =======
  80. There are some things you should be aware of.
  81. - Look at plat/<PLATFORMNAME>/README for information about the two supported
  82. platforms.
  83. - The library support is fairly limited; for C, it's at roughly the ANSI C
  84. level, and for the other languages it's similar.
  85. - When compiling languages other than C, the ACK will usually look at the
  86. first character of the file. If it's a #, then the file will be run through
  87. the C preprocessor anyway.
  88. - BSD systems may need to up the number of file descriptors (e.g.
  89. 'ulimit -n 200') before the ACK will compile.
  90. - The ACK uses its own .o format. You won't be able to mix the ACK's object
  91. files and another compiler's.
  92. DISCLAIMER
  93. ==========
  94. The ACK is mature, well-tested software, but the environment in which it was
  95. developed for and tested under is rather different from that available on
  96. today's machines. There will probably be little in the way of logical bugs,
  97. but there may be many compilation and API bugs.
  98. If you wish to use the ACK, *please* join the mailing list. We are interested
  99. in any reports of success and particularly, failure. If it does fail for you,
  100. we would love to know why, in as much detail as possible. Bug fixes are even
  101. more welcome.
  102. The ACK is licensed under a BSD-like license. Please see the 'Copyright' file
  103. for the full text.
  104. You can find the mailing list on the project's web site:
  105. http://tack.sourceforge.net/
  106. Please enjoy.
  107. David Given (dtrg on Sourceforge)
  108. dg@cowlark.com
  109. 2010-08-08
  110. # $Source$
  111. # $State$
  112. # $Revision$