doc/man/man1/voodooc.1

   1 .TH voodooc 1 "" "" "User Commands"
   2 .SH NAME
   3 .B voodooc
   4 \- the Voodoo compiler
   5 .SH SYNOPSIS
   6 .B voodooc
   7 [\fIoptions\fR]
   8 <\fIinput file\fR>
   9 .SH DESCRIPTION
  10 Compiles a program in the Voodoo programming language.
  11 Various options can be used to specify the name of the output file
  12 and the target architecture and output file format.
  13
  14 If `-' is specified as an input file, \fBvoodooc\fR reads from
  15 standard input instead. In that case, the \fB-o\fR option is mandatory.
  16 .SH OPTIONS
  17 .TP
  18 \fB-a\fR, \fB--arch\fR, \fB--architecture\fR \fIarchitecture\fR
  19 Select target architecture. Use \fB-a help\fR to get a list of
  20 supported architectures.
  21 .TP
  22 \fB-f\fR, \fB--format\fR, \fB--output-format\fR \fIformat\fR
  23 Select output format. Use \fB-a \fIarchitecture\fB -f help\fR to get a list of
  24 supported output formats for \fIarchitecture\fR.
  25 .TP
  26 \fB--features\fR
  27 Lists the features supported by this implementation. The features
  28 are listed in the format <feature name><tab><version>, ordered
  29 by feature name. The program exits after printing the list of
  30 features; no compilation is performed.
  31 .TP
  32 \fB-h\fR, \fB--help\fR
  33 Display usage information and exit. No compilation will be performed.
  34 .TP
  35 \fB-o\fR, \fB--output\fR, \fB--output-file\fR \fIoutput file\fR
  36 Set output file name. The special name '-' causes voodooc to write
  37 to standard output.
  38 .TP
  39 \fB--version\fR
  40 Display version information and exit. No compilation will be performed.
  41 .SH EXAMPLES
  42 .TP
  43 Compile the file example.voo:
  44 .B voodooc example.voo
  45 .PP
  46 Compile the file example.voo to i386 assembly code for the NASM assembler,
  47 using example.asm as the output file name:
  48 .RS
  49 .B voodooc -a i386 -f nasm -o example.asm example.voo
  50 .RE
  51 .SH SEE ALSO
  52 \fBvoodooc\fR has a website at
  53 \fIhttp://voodoo-compiler.sourceforge.net/\fR