'\" t
.\"     Title: ml-ulex
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-07-31
.\"    Manual: \ \&
.\"    Source: SML/NJ
.\"  Language: English
.\"
.TH "ML\-ULEX" "1" "2023-07-31" "SML/NJ" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ml-ulex \- a Unicode\-compatible lexical analyser generator for Standard ML
.SH "SYNOPSIS"
.sp
\fBml\-ulex\fP [\fIOPTIONS\fP] \fIfile\fP
.SH "DESCRIPTION"
.sp
\fBML\-Ulex\fP is a lexer generator that supports Unicode characters (in UTF\-8 representation) and
an extended form of regular expressions.
.SH "OPTIONS"
.sp
\fB\-32\fP
.RS 4
run the 32\-bit version of the program (currently the default).
.RE
.sp
\fB\-64\fP
.RS 4
run the 64\-bit version of the program.  This option only applies to
the \fBx86\-64\fP (aka \fBamd64\fP) architecture.
.RE
.sp
\fB\-\-dot\fP
.RS 4
generate DOT output (\c
.URL "http://www.graphviz.org" "" ")."
The generated file will be named \f(CRfile.dot\fP,
where \f(CRfile\fP is the input file.
.RE
.sp
\fB\-\-match\fP
.RS 4
enter interactive matching mode.  This will allow interactive testing of the machine; presently,
only the \f(CRINITIAL\fP start state is available for testing
(see the \c
.URL "http://www.smlnj.org/doc/ml\-lpt/manual.pdf" "User Guide" ""
for details on start states).
.RE
.sp
\fB\-\-ml\-lex\-mode\fP
.RS 4
operate in \fBml\-lex\fP compatibility mode.
.RE
.sp
\fB\-\-table\-based\fP
.RS 4
generate a table\-based lexer.
.RE
.sp
\fB\-\-fn\-based\fP
.RS 4
generate a lexer that represents states as functions and transitions as tail calls.
.RE
.sp
\fB\-\-minimize\fP
.RS 4
generate a minimal machine.  Note that this is slow, and is almost never necessary.
.RE
.sp
\fB\-\-strict\-sml\fP
.RS 4
generate strict SML (\fIi.e.\fP, do not use SML/NJ extensions).  This flag
is useful if you want to use the output with a different SML system.
.RE
.SH "AUTHOR"
.sp
\fBML\-Ulex\fP was written by Aaron Turon.
.SH "SEE\-ALSO"
.sp
ml\-antlr(1), ml\-yacc(1)
.sp
The \c
.URL "https://www.smlnj.org/doc/ml\-lpt/manual.pdf" "\fISML/NJ Language Processing Tools: User Guide\fP" "."
.sp
\fBRegular\-expression derivatives reexamined\fP by Scott Owens, John Reppy, and Aaron Turon.
\fIJournal of Functional Programming\fP, 19(2):173\-190, 2009.
.SH "COPYING"
.sp
Copyright \(co 2020 The Fellowship of SML/NJ
.sp
This is free software; see the source for copying  conditions.   There  is  NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.