| 1 | .TH ANIC "1" "January 2010" "ANI Toolchain" "ANI"
|
| 2 | .SH NAME
|
| 3 | \fBanic\fR \- ANI programming language compiler
|
| 4 | .SH SYNOPSIS
|
| 5 | .B anic
|
| 6 | \fIsourceFile\fR... [-] [-o \fIoutputFile\fR] [-p \fIoptimizationLevel\fR] [-s] [-v] [-e] [-h]
|
| 7 | .SH DESCRIPTION
|
| 8 | .PP
|
| 9 | Compile, assemble, and link ANI programs into standalone binaries.
|
| 10 | .SH OPTIONS
|
| 11 | .PP
|
| 12 | .TP
|
| 13 | \fB\-\fR
|
| 14 | read standard input as if it were a source file
|
| 15 | .TP
|
| 16 | \fB\-o \fR\fIfilename\fR
|
| 17 | output the resulting binary to \fR\fIfilename\fR
|
| 18 | .IP
|
| 19 | If this option is not specified, the default is \fIa.out\fR.
|
| 20 | .TP
|
| 21 | \fB\-p \fR\fIn\fR
|
| 22 | use level \fR\fIn\fR code optimizations during compilation
|
| 23 | .IP
|
| 24 | The valid range is \fB0\fR to \fB3\fR inclusive, with larger numbers specifying increasingly more powerful (but also more time-consuming) optimizations.
|
| 25 | If this option is not specified, the default is \fI1\fR.
|
| 26 | .TP
|
| 27 | \fB\-s\fR
|
| 28 | silent mode; print nothing, not even compilation errors
|
| 29 | .IP
|
| 30 | Cannot be used with \fB\-v\fR.
|
| 31 | .TP
|
| 32 | \fB\-v\fR
|
| 33 | verbose output; print additional information about the compilation process on the standard output
|
| 34 | .IP
|
| 35 | The additional information includes lexical tokens, parsing transitions, symbol trees, typing information, and resource allocation.
|
| 36 | .IP
|
| 37 | It is highly recommended to pipe the output of this option to a file or stream viewer, as it can be quite lengthy, even for small source programs.
|
| 38 | .IP
|
| 39 | For example,
|
| 40 | .IP
|
| 41 | \fBanic \fR\fIprogram.ani\fR\fB \-v | less\fR
|
| 42 | .IP
|
| 43 | will make viewing the verbose ouput much more manageable.
|
| 44 | .IP
|
| 45 | Cannot be used with \fB\-s\fR.
|
| 46 | .TP
|
| 47 | \fB\-e\fR
|
| 48 | pedantic error handling; do not to give up on compilation even when encountering confusing or large volumes of errors
|
| 49 | .IP
|
| 50 | Cannot be used with \fB\-s\fR.
|
| 51 | .TP
|
| 52 | \fB\-h\fR
|
| 53 | program help; display this man page
|
| 54 | .IP
|
| 55 | Must be the only argument.
|
| 56 | .SH EXAMPLES
|
| 57 | .TP
|
| 58 | \fBanic \fR\fIprogram.ani\fR
|
| 59 | Compile, assemble, and link the ANI program in source file
|
| 60 | .br
|
| 61 | \fIprogram.ani\fR and output the resulting binary to \fIa.out\fR.
|
| 62 | .TP
|
| 63 | \fBanic \fR\fIprogram.ani\fR\fB \-o \fR\fIprogram\fR
|
| 64 | Compile, assemble, and link the ANI program in source file
|
| 65 | .br
|
| 66 | \fIprogram.ani\fR and output the resulting binary to \fIprogram\fR.
|
| 67 | .TP
|
| 68 | \fBanic \- \-o \fR\fIprogram\fR
|
| 69 | Same as above, except read program source from standard input.
|
| 70 | .TP
|
| 71 | \fBanic \fR\fIprogram.ani\fR\fB \-v\fR
|
| 72 | Compile \fIprogram.ani\fR to \fIa.out\fR and additionally dump verbose compilation details to standard output.
|
| 73 | .TP
|
| 74 | \fBanic \fR\fIprogram.ani\fR\fB \-p \fR\fI3\fr\fB \-e \-o \fR\fIprogram\fR
|
| 75 | Compile \fIprogram.ani\fR to \fIprogram\fR using level \fI3\fR optimizations and no limits on the amount of errors printed.
|
| 76 | .SH AUTHOR
|
| 77 | Written by Kajetan "Adrian" Biedrzycki.
|
| 78 | .SH "REPORTING BUGS"
|
| 79 | Report bugs to <ani\-compiler>.
|
| 80 | .SH COPYRIGHT
|
| 81 | Copyright (c) 2010 Kajetan "Adrian" Biedrzycki.
|
| 82 | .PP
|
| 83 | Licensed under GPLv3+ (GNU GPL version 3 or later). See <> for details.
|
| 84 | .PP
|
| 85 | This is free software: you are free to change and redistribute it.
|
| 86 | There is NO WARRANTY, to the extent permitted by law.
|
| 87 | .SH "SEE ALSO"
|
| 88 | The full documentation for \fBanic\fR and the \fBANI\fR programming language is provided on the project home page at <>.
|