home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume14 / flex / part01 / README < prev    next >
Encoding:
Text File  |  1988-05-02  |  3.3 KB  |  136 lines
  1. This is the initial release of flex, a replacement for the lex(1)
  2. tool.  As the copyright indicates, this distribution can be freely
  3. redistributed.
  4.  
  5. Some notes on the distribution:
  6.  
  7.     Yes, there are some niggling lex features which are not available which
  8.     seem like they'd be easy to add.  They're not, or if they are then the
  9.     straight-forward implementation of them would slow down the scanner.
  10.     Unfortunately I am unable to do any further work on flex other than bug
  11.     fixes, so if there's something you've just gotta have, you'd better
  12.     be willing to dive into the code.  I'll be happy to give (fairly
  13.     high-level) advice on how to proceed.
  14.  
  15.     The compressed tables have been tested pretty thoroughly in the past,
  16.     though may be suffering from bit-rot.  The fast/full tables have been
  17.     recently implemented and are more likely to have bugs.
  18.  
  19.     For a System V machine, add the #define "SV".  Not guaranteed to do
  20.     the full job, but a step in the right direction.
  21.  
  22.     Flex has been successfully ported to Sun Unix and 4.3BSD Vax Unix.
  23.  
  24.  
  25. The flex distribution consists of the following files:
  26.  
  27.     README        This message
  28.  
  29.     Changes        Differences between this release and the beta-test
  30.  
  31.     Makefile
  32.     flexdef.h
  33.     parse.y
  34.     scan.l
  35.     ccl.c
  36.     dfa.c        flex sources
  37.     ecs.c
  38.     main.c
  39.     misc.c
  40.     nfa.c
  41.     sym.c
  42.     tblcmp.c
  43.     yylex.c
  44.  
  45.     scan.c.dist    pre-flex'd version of scan.l
  46.  
  47.     flex.skel
  48.     flex.fastskel
  49.     flexskelcom.h    skeleton scanner sources
  50.     flexskeldef.h
  51.     fastskeldef.h
  52.  
  53.     flex.1        manual entry
  54.  
  55.     Timings        a brief note comparing timings of flex vs. lex
  56.  
  57. [  The following section is only true if you got the files from FTP
  58.     to LBL, directly, and not from the more widely-distributed
  59.     comp.sources.unix publication.  --Rich $alz
  60. The files are packaged as a compressed shell archive, which in turn
  61. contains seven shell archives.  Create a directory where you want flex
  62. to live, cd there, and use
  63.  
  64.     uncompress flex.shar.Z
  65.     sh flex.shar
  66.  
  67.     sh flex.shar.1
  68.     sh flex.shar.2
  69.     sh flex.shar.3
  70.     sh flex.shar.4
  71.     sh flex.shar.5
  72.     sh flex.shar.6
  73.     sh flex.shar.7
  74.  
  75. to extract them.
  76. ]
  77.  
  78. Either move {flexskelcom.h,flexskeldef.h,fastskeldef.h} into /usr/include
  79. or edit {flex.skel,flex.fastskel,flexskeldef.h,fastskeldef.h,scan.c.dist}
  80. and wire in the full pathname of where you are going to keep the include files.
  81.  
  82. Decide where you want to keep {flex.skel,flex.fastskel} (suggestion:
  83. /usr/local/lib) and move it there.  Edit "Makefile" and change the
  84. definitions of SKELETON_FILE and F_SKELETON_FILE to reflect the full
  85. pathnames of {flex.skel,flex.fastskel}.
  86.  
  87. To make flex for the first time, use:
  88.  
  89.     make first_flex
  90.  
  91. which uses a pre-generated copy of the scanner whose source is in flex.
  92.  
  93. Assuming it builds successfully, you can test it using
  94.  
  95.     make test
  96.  
  97. The "diff" should not show any differences.
  98.  
  99. If you're feeling adventurous, rebuild scan.c using various
  100. combinations of FLEX_FLAGS, each time trying "make test" when
  101. you're done.  To rebuild it, do
  102.  
  103.     rm scan.c
  104.     make FLEX_FLAGS="..."
  105.  
  106. where "..." is one of:
  107.  
  108.     -ist -c
  109.     -ist -ce
  110.     -ist -cm
  111.     -ist -cfe
  112.     -ist -cFe
  113.  
  114. and testing using:
  115.  
  116.     make FLEX_FLAGS="..." test
  117.  
  118.  
  119. Format the manual entry using
  120.  
  121.     nroff -man flex.1
  122.  
  123.  
  124. Please send problems and feedback to:
  125.  
  126.     vern@lbl-{csam,rtsg}.arpa  or  ucbvax!lbl-csam.arpa!vern
  127.  
  128.     Vern Paxson
  129.     Real Time Systems Group
  130.     Bldg. 46A
  131.     Lawrence Berkeley Laboratory
  132.     1 Cyclotron Rd.
  133.     Berkeley, CA 94720
  134.  
  135.     (415) 486-6411
  136.