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