summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorManoj Srivastava <srivasta@golden-gryphon.com>2003-12-03 22:33:17 -0800
committerManoj Srivastava <srivasta@golden-gryphon.com>2003-12-03 22:33:17 -0800
commitc2b22e08bd48278f2cf125f054c9f6286e345ff0 (patch)
tree3c0ab722c83ef33913ad293af7d56ce2c4e1fcc9 /README
parentedc848712307fe5c881364e12e520e9fe58d9969 (diff)
Imported Upstream version 2.5.31
Diffstat (limited to 'README')
-rw-r--r--README87
1 files changed, 49 insertions, 38 deletions
diff --git a/README b/README
index 7a4224d..e78d49e 100644
--- a/README
+++ b/README
@@ -1,60 +1,71 @@
-This is release 2.5 of flex. See "version.h" for the exact patch-level.
+This is flex, the fast lexical analyzer generator.
-See the file "NEWS" to find out what is new in this Flex release.
+flex is a tool for generating scanners: programs which recognize
+lexical patterns in text.
-Read the file "INSTALL" for general installation directives. Peek near
-the beginning of the file "Makefile.in" for special DEFS values. On most
-systems, you can just run the "configure" script and type "make" to build
-flex; then "make check" to test whether it built correctly; and if it did,
-then "make install" to install it.
+More information about flex as well as the latest official release of
+flex can be found at:
-If you're feeling adventurous, you can also issue "make bigcheck" (be
-prepared to wait a while).
+http://lex.sourceforge.net/
+
+Of particular interest is the mailing list
+lex-announce@lists.sourceforge.net as that is where posts will be made
+announcing new releases of flex.
Note that flex is distributed under a copyright very similar to that of
-BSD Unix, and not under the GNU General Public License (GPL), except for
-the "configure" script, which is covered by the GPL.
+BSD Unix, and not under the GNU General Public License (GPL).
+
+This file is part of flex.
+
+This code is derived from software contributed to Berkeley by
+Vern Paxson.
+
+The United States Government has rights in this work pursuant
+to contract no. DE-AC03-76SF00098 between the United States
+Department of Energy and the University of California.
-Many thanks to the 2.5 beta-testers for finding bugs and helping test and
-increase portability: Stan Adermann, Scott David Daniels, Charles Elliott,
-Joe Gayda, Chris Meier, James Nordby, Terrence O'Kane, Karsten Pahnke,
-Francois Pinard, Pat Rankin, Andreas Scherer, Marc Wiese, Nathan Zelle.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
-Please send bug reports and feedback to: Vern Paxson (vern@ee.lbl.gov).
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+Neither the name of the University nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
-The flex distribution consists of the following files:
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.
- README This message
+Please send bug reports and feedback to lex-help@lists.sourceforge.net.
- NEWS Differences between the various releases
+The flex distribution contains the following files which may be of interest:
- INSTALL General installation information
+README - This file.
- COPYING flex's copyright
+NEWS - current version number and list of user-visible changes.
- conf.in, configure.in, configure, Makefile.in, install.sh,
- mkinstalldirs
- elements of the "autoconf" auto-configuration process
+INSTALL - basic installation information.
- flexdef.h, parse.y, scan.l, ccl.c, dfa.c, ecs.c, gen.c, main.c,
- misc.c, nfa.c, sym.c, tblcmp.c, yylex.c
- source files
+ABOUT-NLS - description of internationalization support in flex.
- version.h version of this flex release
+COPYING - flex's copyright and license.
- flex.skl flex scanner skeleton
- mkskel.sh script for converting flex.skl to C source file skel.c
- skel.c pre-converted C version of flex.skl
+doc/ - user documentation.
- libmain.c flex library (-lfl) sources
- libyywrap.c
+RoadMap - notes for developers.
- initscan.c pre-flex'd version of scan.l
+examples/ - containing examples of some possible flex scanners and a
+few other things. See the file examples/README for more details.
- FlexLexer.h header file for C++ lexer class
+TODO - outstanding bug reports, desired features, etc.
- flex.1 user documentation
+tests/ - regression tests. See TESTS/README for details.
- MISC/ a directory containing miscellaneous contributions.
- See MISC/README for details.
+po/ - internationalization support files.