ocamllex - The Objective Caml lexer generator
ocamllex [ -o output-file ] [ -ml ] filename.mll
OCAMLLEX(1) General Commands Manual OCAMLLEX(1)
NAME
ocamllex - The Objective Caml lexer generator
SYNOPSIS
ocamllex [ -o output-file ] [ -ml ] filename.mll
DESCRIPTION
The ocamllex(1) command generates Objective Caml lexers from a set of
regular expressions with associated semantic actions, in the style of
lex(1).
Running ocamllex(1) on the input file lexer.mll produces Caml code for
a lexical analyzer in file lexer.ml.
This file defines one lexing function per entry point in the lexer def-
inition. These functions have the same names as the entry points. Lex-
ing functions take as argument a lexer buffer, and return the semantic
attribute of the corresponding entry point.
Lexer buffers are an abstract data type implemented in the standard
library module Lexing. The functions Lexing.from_channel, Lex-
ing.from_string and Lexing.from_function create lexer buffers that read
from an input channel, a character string, or any reading function,
respectively.
When used in conjunction with a parser generated by ocamlyacc(1), the
semantic actions compute a value belonging to the type token defined by
the generated parsing module.
OPTIONS
The ocamllex(1) command recognizes the following options:
-ml Output code that does not use OCaml's built-in automata inter-
preter. Instead, the automaton is encoded by Caml functions.
This option is mainly useful for debugging ocamllex(1), using it
for production lexers is not recommended.
-o output-file
Specify the name of the output file produced by ocamllex(1).
The default is the input file name, with its extension replaced
by .ml.
-q Quiet mode. ocamllex(1) normally outputs informational messages
to standard output. They are suppressed if option -q is used.
-v or -version
Print version and exit.
-help or --help
Display a short usage summary and exit.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | runtime/ocaml |
+---------------+------------------+
|Stability | Volatile |
+---------------+------------------+
SEE ALSO
ocamlyacc(1).
The Objective Caml user's manual, chapter "Lexer and parser genera-
tors".
NOTES
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from http://caml.inria.fr/dis-
trib/ocaml-3.11/ocaml-3.11.2.tar.bz2
Further information about this software can be found on the open source
community website at http://www.ocaml.org.
OCAMLLEX(1)