README 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. # $Source$
  2. # $State$
  3. Installing the ACK on a modern platform
  4. =======================================
  5. This document provides some very quick and dirty instructions for installing
  6. the ACK on a modern platform. It is not intended as a substitute for the
  7. real instructions, which can be found in doc/install.pr.
  8. Let me repeat myself:
  9. THE FULL INSTALLATION INSTRUCTIONS ARE IN doc/install.pr.
  10. The ACK is a very large and complex package and has received minimal
  11. maintenance for the best part of a decade. During that time, the Unix
  12. world has moved on, and many APIs have changed. It compiles cleanly on
  13. my, dtrg's, test machine, which is a Debian Ubuntu Linux system. Your
  14. mileage may vary.
  15. All disclaimers now done, now on to the good stuff:
  16. Building the ACK
  17. ----------------
  18. I'm assuming you're using Linux here, because that's what I use. If you
  19. don't use Linux, please let me know if you have any trouble and I'll update
  20. the instructions.
  21. 1. Configure the build.
  22. To do this, run the first/first script. You will be asked several
  23. questions.
  24. * What is the root of the ACK source tree?
  25. This is the directory that you have unpacked the distribution into.
  26. For example, /home/dg/src/Ack-5.6.
  27. * What is the root of the configuration tree?
  28. This is the directory that the build process will use for temporary
  29. files. You'll only need this during the compilation process; it can
  30. be removed afterwards.
  31. For example, /tmp/ack-conf
  32. * What is the root of the ACK binaries?
  33. This is the ACK's installation path; where the binaries will live.
  34. This needs to be writable during the build process --- if you want
  35. to install in /usr/local, you either have to make /usr/local
  36. writable or compile as root. Sorry!
  37. * What is your system type?
  38. Linux isn't on the list. Choose ANY.
  39. * Is this the system you are running on?
  40. Yes.
  41. * Are you satisfied?
  42. Yes.
  43. * What default machine do you wish to compile for?
  44. The ACK wants to know what architecture to target if you don't manually
  45. specify an architecture. Unfortunately, it can't generate runnable
  46. binaries for Linux or any other modern system (except possible Solaris
  47. on Sparc). I'd recommend you choose em44. This will produce portable
  48. binaries using the ACK's intermediate format, which you can run using
  49. the int interpreter.
  50. * What kind of Unix are you running?
  51. Linux is a mixture, but I pick SYS_5 and it works.
  52. * Do you wish to limit the installation?
  53. No. If you pick Yes, the script will ask detailed questions about
  54. exactly what you want to build. Modern systems are fast enough that
  55. we may as well build everything.
  56. * Which system call library do you wish to use on the VAX?
  57. I don't have a VAX; the only person I know who has one uses it to vacuum
  58. his carpets. I pick libsysV_2 with no ill effects.
  59. If the configuration script is happy, it will generate a script called
  60. INSTALL.
  61. 2. Do the compilation.
  62. The configuration script will recommend a command line. Execute this. On
  63. modern systems, the compilation doesn't take long.
  64. Check the output of the configuration script for "Failed" lines. On my
  65. system there are two:
  66. $ grep Failed INSTALL.out
  67. Failed for Intel 8080 download programs, see dl/Out
  68. Failed for Intel 8080 support
  69. You can ignore these. They aren't important.
  70. 3. Use the ACK.
  71. Ensure that the ACK's binary directory is on your path; this is /bin in
  72. the directory you specified during the configuration process. In my
  73. example, this is /usr/local/bin. The /man subdirectory should go on your
  74. manpath.
  75. To test your path, do: ack
  76. This should return silently.
  77. To test your manpath, do: man ack
  78. This will produce the documentation for the main compiler driver.
  79. If this works, you can remove the conf tree (/tmp/ack-conf in my example).
  80. Gotchas
  81. -------
  82. There are some things you should be aware of.
  83. * The ACK's archiver tool is called 'arch'. This conflicts on Linux platforms
  84. with a utility that displays the current architecture. If your compilation
  85. occasionally fails obscurely and displays something like 'i686', you are
  86. running afoul of this. As a workaround, rearrange your path so the ACK's
  87. bin directory comes first --- but do be aware that some Linux system
  88. tools may stop working.
  89. * By default, the ack tool will compile K&R C. Practically all C source these
  90. days is ANSI C --- use the -ansi switch to enable ANSI mode. No, the ACK is
  91. not C99 compatible.
  92. * Not all combinations of optimisation and architectures work. This is
  93. perfectly normal, but the combinations are not well documented. Everything
  94. supports -O.
  95. Disclaimer
  96. ----------
  97. The ACK is mature, well-tested software, but the environment in which it was
  98. developed for and tested under is rather different from that available on
  99. today's machines. There will probably be little in the way of logical bugs,
  100. but there may be many compilation and API bugs.
  101. If you wish to use the ACK, *please* join the mailing list. We are interested
  102. in any reports of success and particularly, failure. If it does fail for you,
  103. we would love to know why, in as much detail as possible. Bug fixes are even
  104. more welcome.
  105. The ACK is licensed under a BSD-like license. Please see the 'Copyright' file
  106. for the full text.
  107. You can find the mailing list on the project's web site:
  108. http://tack.sourceforge.net/
  109. Please enjoy.
  110. David Given (dtrg on Sourceforge)
  111. dg@cowlark.com
  112. 2005-06-24, 23:53
  113. # Revision history
  114. # $Log$
  115. # Revision 2.2 2005-06-24 23:20:41 dtrg
  116. # Added some new readmes at the top level.
  117. #