Blame README

Packit f00812
This is flex, the fast lexical analyzer generator.
Packit f00812
Packit f00812
flex is a tool for generating scanners: programs which recognize
Packit f00812
lexical patterns in text.
Packit f00812
Packit f00812
More information about flex as well as the latest official release of
Packit f00812
flex can be found at:
Packit f00812
Packit f00812
http://flex.sourceforge.net/
Packit f00812
Packit f00812
The flex codebase is kept in git at:
Packit f00812
Packit f00812
https://github.com/westes/flex
Packit f00812
Packit f00812
Bugs and pull requests should be filed against flex using github's
Packit f00812
issue tracker and pull request facilities.
Packit f00812
Packit f00812
There are several mailing lists available as well:
Packit f00812
Packit f00812
flex-announce@lists.sourceforge.net - where posts will be made
Packit f00812
announcing new releases of flex.
Packit f00812
Packit f00812
flex-help@lists.sourceforge.net - where you can post questions about
Packit f00812
using flex
Packit f00812
Packit f00812
flex-devel@lists.sourceforge.net - where you can discuss development of
Packit f00812
flex itself
Packit f00812
Packit f00812
Find information on subscribing to the mailing lists at:
Packit f00812
Packit f00812
http://sourceforge.net/mail/?group_id=97492
Packit f00812
Packit f00812
The flex distribution contains the following files which may be of interest:
Packit f00812
Packit f00812
README - This file.
Packit f00812
NEWS - current version number and list of user-visible changes.
Packit f00812
INSTALL - basic installation information.
Packit f00812
ABOUT-NLS - description of internationalization support in flex.
Packit f00812
COPYING - flex's copyright and license.
Packit f00812
doc/ - user documentation.
Packit f00812
examples/ - containing examples of some possible flex scanners and a
Packit f00812
	few other things. See the file examples/README for more details.
Packit f00812
TODO - outstanding bug reports, desired features, etc.
Packit f00812
tests/ - regression tests. See TESTS/README for details.
Packit f00812
po/ - internationalization support files.
Packit f00812
Packit f00812
You need the following tools to build flex from the maintainer's
Packit f00812
repository:
Packit f00812
Packit f00812
compiler suite - flex is built with gcc
Packit f00812
bash, or a good Bourne-style shell
Packit f00812
m4 - m4 -p needs to work; GNU m4 and a few others are suitable
Packit f00812
GNU bison;  to generate parse.c from parse.y
Packit f00812
autoconf; for handling the build system
Packit f00812
automake; for Makefile generation
Packit f00812
gettext; for i18n support
Packit f00812
help2man; to generate the flex man page
Packit f00812
tar, gzip, etc.; for packaging of the source distribution
Packit f00812
Packit f00812
GNU texinfo; to build and test the flex manual. Note that if you want
Packit f00812
to build the dvi/ps/pdf versions of the documentation you will need
Packit f00812
texi2dvi and related programs, along with a sufficiently powerful
Packit f00812
implementation of \TeX to process them. See your operating system
Packit f00812
documentation for how to achieve this. The printable versions of the
Packit f00812
manual are not built unless specifically requested, but the targets
Packit f00812
are included by automake.
Packit f00812
Packit f00812
GNU indent; for indenting the flex source the way we want it done
Packit f00812
Packit f00812
In cases where the versions of the above tools matter, the file
Packit f00812
configure.ac will specify the minimum required versions.
Packit f00812
Packit f00812
Once you have all the necessary tools installed, life becomes
Packit f00812
simple. To prepare the flex tree for building, run the script:
Packit f00812
Packit f00812
$ ./autogen.sh
Packit f00812
Packit f00812
in the top level of the flex source tree.
Packit f00812
This script calls the various tools needed to get flex ready for the
Packit f00812
GNU-style configure script to be able to work.
Packit f00812
Packit f00812
From this point on, building flex follows the usual configure, make,
Packit f00812
make install routine.
Packit f00812
Packit f00812
This file is part of flex.
Packit f00812
Packit f00812
This code is derived from software contributed to Berkeley by
Packit f00812
Vern Paxson.
Packit f00812
Packit f00812
The United States Government has rights in this work pursuant
Packit f00812
to contract no. DE-AC03-76SF00098 between the United States
Packit f00812
Department of Energy and the University of California.
Packit f00812
Packit f00812
Redistribution and use in source and binary forms, with or without
Packit f00812
modification, are permitted provided that the following conditions
Packit f00812
are met:
Packit f00812
Packit f00812
1. Redistributions of source code must retain the above copyright
Packit f00812
   notice, this list of conditions and the following disclaimer.
Packit f00812
2. Redistributions in binary form must reproduce the above copyright
Packit f00812
   notice, this list of conditions and the following disclaimer in the
Packit f00812
   documentation and/or other materials provided with the distribution.
Packit f00812
Packit f00812
Neither the name of the University nor the names of its contributors
Packit f00812
may be used to endorse or promote products derived from this software
Packit f00812
without specific prior written permission.
Packit f00812
Packit f00812
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
Packit f00812
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
Packit f00812
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
Packit f00812
PURPOSE.
Packit f00812
Packit f00812