Return to vmgen.1 CVS log

Up to [gforth] / gforth / doc

bugfix (paper format)
added doc/vmgen.1 (contributed by Eric Schwartz)

    1: .de TQ
    2: .br
    3: .ns
    4: .IP "\fB\\$1\fI\\$2" 9
    5: ..
    6: .TH Vmgen 1 "March 25, 2003" \" -*- nroff -*-
    7: .SH NAME
    8: vmgen \- a virtual machine generator
    9: .SH SYNOPSIS
   10: 
   11: \fCvmgen\fR [-h | -v] INPUTFILE
   12: 
   13: .SH DESCRIPTION
   14: 
   15: \fBvmgen\fR Vmgen is a tool for writing efficient interpreters.  It takes a
   16: simple virtual machine description and generates efficient C code for
   17: dealing with the virtual machine code in various ways (in particular,
   18: executing it).  For more details, consult the info documentation,
   19: which can be read with 'info vmgen'.
   20: 
   21: .SH OPTIONS
   22: 
   23: .BI "\-\-help"
   24: .TQ "\-h"
   25: Lists the available options, including some not described here (see
   26: also the manual).
   27: .TP
   28: .BI "\-\-version"
   29: .TQ "\-v"
   30: Print version and exit
   31: .TP
   32: 
   33: .BI INPUTFILE
   34:  INPUTFILE is the VM instruction description file, which usually
   35: ends in `.vmg'.  The output filenames are made by taking the basename
   36: of `inputfile' (i.e., the output files will be created in the current
   37: working directory) and replacing `.vmg' with `-vm.i', `-disasm.i',
   38: `-gen.i', `-labels.i', `-profile.i', and `-peephole.i'.  E.g., `vmgen
   39: hack/foo.vmg' will create `foo-vm.i', `foo-disasm.i', `foo-gen.i',
   40: `foo-labels.i', `foo-profile.i' and `foo-peephole.i'.
   41: 
   42: .SH SEE ALSO
   43: The Vmgen manual - available in hypertext (Info, HTML) and printable
   44: (TeX, PS, ASCII) forms.
   45: 
   46: Vmgen is part of Gforth.  More information on Gforth (e.g., pointers
   47: to new versions, to the manual on the WWW and to papers about Gforth)
   48: is available through \fChttp://www.complang.tuwien.ac.at/projects/forth.html\fR.
   49: 
   50: .SH AUTHORS
   51: \fBGforth\fR was written by Anton Ertl, Bernd Paysan, Jens Wilke and
   52: others.