xref: /openbsd/usr.bin/lex/README (revision a58c1ecb)
1*a58c1ecbSteduThis is flex, the fast lexical analyzer generator.
2*a58c1ecbStedu
3*a58c1ecbSteduflex is a tool for generating scanners: programs which recognize
4*a58c1ecbStedulexical patterns in text.
5*a58c1ecbStedu
6*a58c1ecbSteduMore information about flex as well as the latest official release of
7*a58c1ecbSteduflex can be found at:
8*a58c1ecbStedu
9*a58c1ecbSteduhttp://flex.sourceforge.net/
10*a58c1ecbStedu
11*a58c1ecbSteduBug reports should be submitted using the SourceForge Bug Tracker for
12*a58c1ecbSteduflex at:
13*a58c1ecbStedu
14*a58c1ecbSteduhttp://sourceforge.net/tracker/?group_id=97492&atid=618177
15*a58c1ecbStedu
16*a58c1ecbSteduThe flex codebase is kept in git at:
17*a58c1ecbStedu
18*a58c1ecbSteduhttps://github.com/westes/flex
19*a58c1ecbStedu
20*a58c1ecbSteduThere are several mailing lists available as well:
21*a58c1ecbStedu
22*a58c1ecbSteduflex-announce@lists.sourceforge.net - where posts will be made
23*a58c1ecbSteduannouncing new releases of flex.
24*a58c1ecbStedu
25*a58c1ecbSteduflex-help@lists.sourceforge.net - where you can post questions about
26*a58c1ecbSteduusing flex
27*a58c1ecbStedu
28*a58c1ecbSteduflex-devel@lists.sourceforge.net - where you can discuss development of
29*a58c1ecbSteduflex itself
30*a58c1ecbStedu
31*a58c1ecbSteduFind information on subscribing to the mailing lists at:
32*a58c1ecbStedu
33*a58c1ecbSteduhttp://sourceforge.net/mail/?group_id=97492
34*a58c1ecbStedu
35*a58c1ecbSteduThe flex distribution contains the following files which may be of interest:
36*a58c1ecbStedu
37*a58c1ecbSteduREADME - This file.
38*a58c1ecbStedu
39*a58c1ecbSteduNEWS - current version number and list of user-visible changes.
40*a58c1ecbStedu
41*a58c1ecbSteduINSTALL - basic installation information.
42*a58c1ecbStedu
43*a58c1ecbSteduABOUT-NLS - description of internationalization support in flex.
44*a58c1ecbStedu
45*a58c1ecbSteduCOPYING - flex's copyright and license.
46*a58c1ecbStedu
47*a58c1ecbStedudoc/ - user documentation.
48*a58c1ecbStedu
49*a58c1ecbSteduexamples/ - containing examples of some possible flex scanners and a
50*a58c1ecbStedufew other things. See the file examples/README for more details.
51*a58c1ecbStedu
52*a58c1ecbSteduTODO - outstanding bug reports, desired features, etc.
53*a58c1ecbStedu
54*a58c1ecbStedutests/ - regression tests. See TESTS/README for details.
55*a58c1ecbStedu
56*a58c1ecbStedupo/ - internationalization support files.
57*a58c1ecbStedu
58*a58c1ecbSteduYou need the following tools to build flex from the maintainer's
59*a58c1ecbStedurepository:
60*a58c1ecbStedu
61*a58c1ecbSteducompiler suite - flex is built with gcc
62*a58c1ecbStedubash, or a good Bourne-style shell
63*a58c1ecbStedum4 - m4 -p needs to work; GNU m4 and a few others are suitable
64*a58c1ecbSteduGNU bison;  to generate parse.c from parse.y
65*a58c1ecbSteduautoconf 2.69; for handling the build system
66*a58c1ecbSteduautomake 1.12.2; for Makefile generation
67*a58c1ecbStedugettext 0.18; fori18n support
68*a58c1ecbSteduhelp2man 1.36; to generate the flex man page
69*a58c1ecbStedutar, gzip, etc.; for packaging of the source distribution
70*a58c1ecbSteduGNU texinfo 498;  to build and test the flex manual
71*a58c1ecbSteduGNU indent 2.8; for indenting the flex source the way we want it done
72*a58c1ecbStedu
73*a58c1ecbSteduOnce you have all the necessary tools installed, life becomes
74*a58c1ecbStedusimple. To prepare the flex tree for building, run the script:
75*a58c1ecbStedu
76*a58c1ecbStedu$ ./autogen.sh
77*a58c1ecbStedu
78*a58c1ecbSteduin the top level of the flex source tree.
79*a58c1ecbSteduThis script calls the various tools needed to get flex ready for the
80*a58c1ecbSteduGNU-style configure script to be able to work.
81*a58c1ecbStedu
82*a58c1ecbSteduFrom this point on, building flex follows the usual configure, make,
83*a58c1ecbStedumake install routine.
84*a58c1ecbStedu
85*a58c1ecbSteduThis file is part of flex.
86*a58c1ecbStedu
87*a58c1ecbSteduThis code is derived from software contributed to Berkeley by
88*a58c1ecbSteduVern Paxson.
89*a58c1ecbStedu
90*a58c1ecbSteduThe United States Government has rights in this work pursuant
91*a58c1ecbSteduto contract no. DE-AC03-76SF00098 between the United States
92*a58c1ecbSteduDepartment of Energy and the University of California.
93*a58c1ecbStedu
94*a58c1ecbSteduRedistribution and use in source and binary forms, with or without
95*a58c1ecbStedumodification, are permitted provided that the following conditions
96*a58c1ecbSteduare met:
97*a58c1ecbStedu
98*a58c1ecbStedu1. Redistributions of source code must retain the above copyright
99*a58c1ecbStedu   notice, this list of conditions and the following disclaimer.
100*a58c1ecbStedu2. Redistributions in binary form must reproduce the above copyright
101*a58c1ecbStedu   notice, this list of conditions and the following disclaimer in the
102*a58c1ecbStedu   documentation and/or other materials provided with the distribution.
103*a58c1ecbStedu
104*a58c1ecbSteduNeither the name of the University nor the names of its contributors
105*a58c1ecbStedumay be used to endorse or promote products derived from this software
106*a58c1ecbSteduwithout specific prior written permission.
107*a58c1ecbStedu
108*a58c1ecbSteduTHIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
109*a58c1ecbSteduIMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
110*a58c1ecbSteduWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
111*a58c1ecbSteduPURPOSE.
112*a58c1ecbStedu
113*a58c1ecbStedu
114