pd.if.org Git - pccts/blob - README

   1
   2                            Welcome to PCCTS 1.33
   3
   4                               October 5, 1995
   5
   6
   7                           Parr Research Corporation
   8                                     with
   9                   Purdue University Electrical Engineering
  10                                     and
  11                        University of Minnesota, AHPCRC
  12
  13                                 Terence Parr
  14                                 Russell Quong
  15                                  Will Cohen
  16                                  Hank Dietz
  17
  18 [The "NOTES for new users" by Tom Moog is available now via web
  19  browser at http:www.mcs.net/~tmoog and via anonymous ftp at
  20  ftp.mcs.net/mcsnet.users/tmoog.]
  21
  22 [We've removed PCCTS.FUTURE from the distribution and added file SERVICES,
  23  which describes the services of Parr Research Corporation.]
  24
  25
  26                                 INSTALLATION
  27
  28      This document describes the installation of PCCTS 1.33 on UNIX
  29 and non-UNIX machines.  The UNIX installation is trivial while the
  30 non-UNIX folks have a bit more work to do as an install script
  31 explicitly for there machine will not exist--they will have to
  32 interpret the install script.
  33
  34      PCCTS 1.33 includes a number of different programs and examples
  35 in the software release package -- most of which like to live in their
  36 own directories.  The install script will build a standard hierarchy.
  37 Or, if you get the tar file off the ftp site, the hierarchy will be
  38 constructed automatically by tar.
  39
  40      The PCCTS executables (antlr, dlg) may be placed anywhere the user
  41 wishes but the install script places them in the bin directory created
  42 during installation.
  43
  44 1.0.  UNIX USERS
  45
  46 This section is for UNIX users and describes the most convenient
  47 installation procedure.
  48
  49 1.1.  FORMAT: pccts.tar
  50
  51 To begin installation, place the pccts.tar file into the directory
  52 where you want to place a pccts subdirectory.  Untar the file with
  53
  54      tar xvf pccts.tar
  55
  56 and cd into it.  To install PCCTS, simply type
  57
  58      make
  59
  60 which will build the standard PCCTS directory hierarchy (under the
  61 directory where you ran the install script) and build executable
  62 versions of antlr and dlg.
  63
  64 1.2.  FORMAT: pccts.bag
  65
  66      To begin installation, the user should create a directory (usually
  67 called pccts) where the PCCTS source subtree is to be created.  Place
  68 the pccts.bag file and the install script into this directory and cd
  69 into it.  To install PCCTS, simply type
  70
  71      sh install
  72
  73 which will build the standard PCCTS directory hierarchy (under the
  74 directory where you ran the install script), "unbag" all of the files
  75 and build executable versions of antlr and dlg.
  76
  77 If you do not have the 'sh' shell, you'll need the install.unbag.reqd
  78 file.
  79
  80 NOTE: If you are using the later SGI C++ compilers, use -woff 3262 to
  81 get rid of a bunch of noise by the compiler (warnings).
  82
  83
  84 2.0.  NON-UNIX USERS
  85
  86      ANTLR was written using portable (we hope), vanilla K&R-style C,
  87 ANSI C, and C++.  It has been successfully ported to a variety of
  88 environments.  We do not provide an installation script explicitly for
  89 non-Unix users.  You must interpret the install script and perform the
  90 analogous operations on your machine.  There is an install script,
  91 install.mpw, for Macintosh programmers.
  92
  93 IMPORTANT NOTE:  For PC users:  You must create the parser.dlg and
  94                  "touch" scan.c in antlr and dlg directories or the
  95                  makefiles will try to execute antlr and dlg, which
  96                  don't exist yet.  The first time, you want only to
  97                  compile the C files in order to obtain an executable
  98                  for antlr and dlg.  From this point, a change in
  99                  antlr.g or dlg_p.g will force antlr/dlg to regenerate
 100                  themselves.
 101
 102                  You must define symbol PC if you want things to work
 103                  out right for use on a DOS, OS/2, Windows machine.
 104                  This affects the config.h file, which you can change
 105                  as you wish.
 106
 107      For Mac programmers using MPW (Macintosh Programmer's Workshop),
 108 define symbol MPW to get the correct config.h stuff included.
 109
 110 3.0.  EMAIL VERSION RECIPIENTS
 111
 112      If you received PCCTS via email response from
 113 pccts@ecn.purdue.edu you have one additional installation step to
 114 perform over the ftp folks (and pccts.tar is unavailable).  You will
 115 have received a number of bite-size chunks of pccts which are small
 116 enough to be emailed (~1500 lines each).  You must reconstruct the
 117 PCCTS files before you can begin installation.  In order to rebuild an
 118 original file, you must have "one.c" which will take the chunks and
 119 pack them together.  If you are a non-UNIX type, you must have the
 120 "unbag.c" file which unbags the bags created by our mail archiver.
 121 UNIX folks use the shell to unbag as they would for shar files (this
 122 will be done automatically by the install script).
 123
 124      To install PCCTS, place all PCCTS mail messages into a pccts
 125 directory, remove the mail headers from one.c.  Then compile one.c
 126 with:
 127
 128      cc -o one one.c
 129
 130 and then type:
 131
 132      ./one f1 f2 ... fn
 133
 134 where f1..fn are the parts of PCCTS source sent as chunks (i.e. these
 135 files will be all the files you received NOT including one.c, unbag.c,
 136 README, install and the request acknowledge banner).  There is no need
 137 to remove mail headers from the chunk files and they may appear in any
 138 order.  The subject line of the mail will identify it as a chunk and a
 139 chunk of what file.  The "one" program should be used to put pccts.bag
 140 back together.  You are now in a position to begin normal PCCTS
 141 installation.  All files you receive should go into a pccts directory.
 142
 143      Note that all files which arrive in "chunks" must be put back
 144 together using "one".  Beware that you do not mix chunks from more
 145 than one original file.  For instance, do not specify all chunks that
 146 you collect from the PCCTS mailbot on the "one" command line unless
 147 you have requested only one original file that was split into multiple
 148 files.  Each chunk knows which original file it is a part of, where it
 149 goes in that file and how many total chunks are required to rebuild
 150 that original.
 151
 152 4.0.  WORD SIZE AND PC USERS
 153
 154      The config.h file now sets up the word size for your compiler
 155 automatically.
 156
 157
 158                                 TUTORIAL
 159
 160      The advanced tutorial should be placed in a directory at the
 161 same level as antlr, dlg, support etc...  Do a
 162
 163      sh advtut.bag
 164
 165 to unbag (or use the unbag program) and then type
 166
 167      make -s all
 168
 169 which will create executables called tut1-tut4.  Naturally, if you got
 170 the tutorials from the ftp site, the tar format of the tutorials can
 171 be obtained for easier installation.
 172
 173 Unfortunately, the tutorials have changed little since the 1.06
 174 release.  With luck, these will be enhanced and an AST tutorial will
 175 appear.
 176
 177                          MACHINE COMPATIBILITY
 178
 179 PCCTS is known to compile "out of the box" on the following machines
 180 and/or operating systems:  [didn't have time to retest on all these
 181 machines, but seems to be highly portable still].
 182
 183 o  DECSTATION 5000
 184
 185 o  SGI; use "-woff 3262" in your CFLAGS make variable
 186
 187 o  Sun SparcStation (cc, gcc, g++, Cfront, acc)
 188
 189 o  VAX C under VMS
 190
 191 o  Linux SLS 0.99, gcc/g++
 192
 193 o  386 PC, NetBSD 0.9, gcc 2.4.5
 194
 195 o  HP 9000/755, HP-UX 9.01, HP cc
 196
 197 o  486 PC, OS/2 2.1 (w/long filenames), IBM C Set++ 2.1
 198
 199 o  NeXTStep 3.2 running g++/gcc 2.6.3 (pentium-90)
 200
 201
 202                            INCOMPATIBILITIES
 203
 204 Please see the release notes.
 205
 206
 207                                 CREDITS
 208
 209 Please see the history.ps or history.txt.