components/antlr/files/antlr.1
author Vladimir Marek <Vladimir.Marek@oracle.com>
Wed, 28 May 2014 10:46:33 +0200
changeset 1926 d37b02d5beee
parent 1035 ffa1c1456e97
permissions -rw-r--r--
15290783 SUNBT6333830 Perl should use setenv(3c) and unsetenv(3c) calls
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1035
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     1
'\" t
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     2
.TH antlr 1 "23 Oct 2012"
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     3
.SH NAME
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     4
antlr \- (AN)other (T)ool for (L)anguage (R)ecognition 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     5
.SH SYNOPSIS
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     6
.B antlr
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     7
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     8
.B \-o 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     9
.I outputDir
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    10
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    11
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    12
.B \-glib 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    13
.I superGrammar
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    14
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    15
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    16
.B \-debug
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    17
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    18
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    19
.B \-html
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    20
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    21
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    22
.B \-diagnostic
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    23
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    24
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    25
.B \-trace
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    26
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    27
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    28
.B \-traceParser
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    29
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    30
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    31
.B \-traceLexer
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    32
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    33
[
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    34
.B \-traceTreeParser
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    35
]
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    36
.SH DESCRIPTION
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    37
antlr (AN)other (T)ool for (L)anguage (R)ecognition - formerly known 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    38
as PCCTS - is a language tool that provides a framework for constructing 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    39
recognizers, compilers, and translators from grammatical descriptions 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    40
containing actions in the following languages: Java, C++, C# or Python.
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    41
For additional information on using antlr, browse the complete HTML 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    42
documentation at:
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    43
.IP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    44
.B file:/usr/share/doc/antlr-2.7.7/index.html 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    45
.LP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    46
.SH OPTIONS
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    47
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    48
.BI \-o " outputDir"
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    49
Specify output directory where all output generated. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    50
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    51
.BI \-glib " superGrammar"
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    52
Specify location of supergrammar file. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    53
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    54
.B \-debug
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    55
Launch the ParseView debugger upon parser invocation. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    56
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    57
.B \-html
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    58
Generate an html file from your grammar (minus actions). 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    59
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    60
.B \-diagnostic
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    61
Generate a textfile with diagnostics. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    62
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    63
.B \-trace
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    64
Have all rules call traceIn/traceOut. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    65
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    66
.B \-traceParser
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    67
Have parser rules call traceIn/traceOut. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    68
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    69
.B \-traceLexer
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    70
Have lexer rules call traceIn/traceOut. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    71
.TP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    72
.B \-traceTreeParser
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    73
Have tree parser rules call traceIn/traceOut. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    74
.SH FILES
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    75
/usr/share/antlr-2.7.7/antlr.jar
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    76
.IP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    77
antlr jar file
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    78
.LP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    79
/usr/share/doc/antlr-2.7.7/index.html 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    80
.IP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    81
antlr API documentation generated with javadoc. 
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    82
.LP
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    83
.SH SEE ALSO
ffa1c1456e97 7204867 Move antlr from the FOSS consolidation into Userland
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    84
\fBjava\fR(1), http://www.antlr2.org/