summaryrefslogtreecommitdiff
path: root/doc/luac.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/luac.html')
-rw-r--r--doc/luac.html246
1 files changed, 158 insertions, 88 deletions
diff --git a/doc/luac.html b/doc/luac.html
index 7d43ff1d..1948e7ab 100644
--- a/doc/luac.html
+++ b/doc/luac.html
@@ -1,88 +1,158 @@
-<!-- manual page source format generated by RosettaMan, -->
-<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
-<HTML>
-<HEADER>
-<TITLE>luac manual page</TITLE>
-</HEADER>
-<BODY>
-<A HREF="#toc">Table of Contents</A><P>
-
-<A NAME="sect0" HREF="#toc0"><H2>NAME</H2></A>
-luac - Lua compiler<P>
-
-<A NAME="sect1" HREF="#toc1"><H2>SYNOPSIS</H2></A>
-luac [ -c | -u ] [ -d ] [ -l ] [ -p ] [ -q ] [ -v ] [ -o <I>outputfile</I> ] <I>sourcefile</I> ...<P>
-
-<A NAME="sect2" HREF="#toc2"><H2>DESCRIPTION</H2></A>
-luac is the Lua compiler. It translates programs written in the Lua programming language into binary files that can be loaded and executed with lua_dofile in C or dofile in Lua.<P>
-luac produces a single output file containing the bytecode for all named source files. By default, the output file is named luac.out, but you can change this with the -o option.<P>
-You can use &quot;-&quot; to indicate stdin as a source file.<P>
-luac can also load and list binary files.<P>
-
-<A NAME="sect3" HREF="#toc3"><H2>OPTIONS</H2></A>
-<dl>
-<dt>-c <dd> compile (this is the default).<P>
-</dd>
-</dl>
-<dl>
-<dt>-u <dd> undump.<P>
-</dd>
-</dl>
-<dl>
-<dt>-d <dd> turns debugging on.<P>
-</dd>
-</dl>
-<dl>
-<dt>-l <dd> produces a listing of the compiled bytecode for Lua's virtual machine. This is the default when undumping.<P>
-</dd>
-</dl>
-<dl>
-<dt>-p <dd> parses sources files but does not generate any output file.<P>
-</dd>
-</dl>
-<dl>
-<dt>-q <dd> quiet; procudes no listing. This is the default when compiling.<P>
-</dd>
-</dl>
-<dl>
-<dt>-v <dd> prints version information.<P>
-</dd>
-</dl>
-<dl>
-<dt>-o <I>outputfile</I><dd> Name the output file <I>output</I>, instead of the default luac.out. The output file cannot be a source file.<P>
-</dd>
-</dl>
-
-<A NAME="sect4" HREF="#toc4"><H2>FILES</H2></A>
-<dl>
-<dt>luac.out <dd> default output file<P>
-</dd>
-</dl>
-
-<A NAME="sect5" HREF="#toc5"><H2>SEE ALSO</H2></A>
-<A HREF="http://localhost/cgi-bin/man2html?lua?1">lua(1)</A><P>
-<I>Reference</I> <I>Manual</I> <I>of</I> <I>the</I> <I>Programming</I> <I>Language</I> <I>Lua</I><P>
-
-<A NAME="sect6" HREF="#toc6"><H2>DIAGNOSTICS</H2></A>
-Error messages should be self explanatory.<P>
-
-<A NAME="sect7" HREF="#toc7"><H2>BUGS</H2></A>
-Inherits any bugs from Lua, but Lua has no bugs...<P>
-
-<A NAME="sect8" HREF="#toc8"><H2>AUTHORS</H2></A>
-W. Celes, R. Ierusalimschy &amp; L. H. de Figueiredo (lua@tecgraf.puc-rio.br)<P>
-
-<HR><P>
-<A NAME="toc"><B>Table of Contents</B></A><P>
-<UL>
-<LI><A NAME="toc0" HREF="#sect0">NAME</A></LI>
-<LI><A NAME="toc1" HREF="#sect1">SYNOPSIS</A></LI>
-<LI><A NAME="toc2" HREF="#sect2">DESCRIPTION</A></LI>
-<LI><A NAME="toc3" HREF="#sect3">OPTIONS</A></LI>
-<LI><A NAME="toc4" HREF="#sect4">FILES</A></LI>
-<LI><A NAME="toc5" HREF="#sect5">SEE ALSO</A></LI>
-<LI><A NAME="toc6" HREF="#sect6">DIAGNOSTICS</A></LI>
-<LI><A NAME="toc7" HREF="#sect7">BUGS</A></LI>
-<LI><A NAME="toc8" HREF="#sect8">AUTHORS</A></LI>
-</UL>
-</BODY></HTML>
+<!-- $Id: luac.man,v 1.8 1998/06/13 16:54:15 lhf Exp $ -->
+<TITLE>LUAC 1 "06 February 1998"</TITLE>
+<H1>NAME</H1>
+luac - Lua compiler
+<H1>SYNOPSIS</H1>
+<B>luac</B>
+[
+<B>-c</B>
+|
+<B>-u</B>
+] [
+<B>-D</B>
+<I>name</I>
+] [
+<B>-d</B>
+] [
+<B>-l</B>
+] [
+<B>-O</B>
+] [
+<B>-o</B>
+<I>filename</I>
+] [
+<B>-p</B>
+] [
+<B>-q</B>
+] [
+<B>-v</B>
+] [
+<B>-V</B>
+]
+<I>sourcefile </I>...
+<H1>DESCRIPTION</H1>
+<B>luac</B>
+is the Lua compiler.
+It translates programs written in the Lua programming language
+into binary files that can be loaded and executed with
+<B>lua_dofile</B>
+in C or with
+<B>dofile</B>
+in Lua.
+<P>
+The main advantages of pre-compiling chunks are:
+faster loading,
+protecting source code from user changes,
+off-line syntax error detection.
+The binary files created by
+<B>luac</B>
+are portable to all known architectures.
+<P>
+<B>luac</B>
+produces a single output file containing the bytecodes
+for all source files given.
+By default,
+the output file is named
+<B>luac.out</B>,
+but you can change this with the
+<B>-o</B>
+option.
+<P>
+You can use
+<B>"-"</B>
+to indicate
+<I>stdin</I>
+as a source file.
+<P>
+<B>luac</B>
+can also load and list binary files with the
+<B>-u</B>
+option.
+<P>
+Binary files produced by differents runs of
+<B>luac</B>
+can be combined into one large file,
+using
+<B>cat</B>(1).
+The result is still a valid binary file,
+and can be loaded with a single call to
+<B>lua_dofile</B>
+or
+<B>dofile</B>.
+<P>
+<H1>OPTIONS</H1>
+<P>
+<B>-c</B>
+compile (this is the default).
+<P>
+<B>-u</B>
+undump, i.e., load and list the given binary files.
+If no files are given, then luac undumps
+<B>luac.out</B>.
+<P>
+<B>-D "</B><I>name"</I>
+predefine symbol
+<I>name</I>
+for conditional compilation.
+<P>
+<B>-d</B>
+turn debugging on.
+Individual chunks may
+still control the generation of debug information with
+$debug and $nodebug.
+<P>
+<B>-l</B>
+produce a listing of the compiled bytecode for Lua's virtual machine.
+This is the default when undumping.
+<P>
+<B>-O</B>
+optimize code.
+Debug information is removed,
+duplicate constants are coalesced.
+<P>
+<B>-o "</B><I>filename"</I>
+output to
+<I>filename</I>,
+instead of the default
+<B>luac.out</B>.
+The output file cannot be a source file.
+<P>
+<B>-p</B>
+parse sources files but does not generate any output file.
+Used mainly for syntax checking.
+<P>
+<B>-q</B>
+quiet; produces no listing.
+This is the default when compiling.
+<P>
+<B>-v</B>
+print version information.
+<P>
+<B>-V</B>
+verbose;
+print the names of the source files as they are processed.
+<H1>FILES</H1>
+<P>
+<B>luac.out</B>
+default output file
+<H1>"SEE ALSO"</H1>
+<B>lua</B>(1)
+<BR>
+<I>"Reference Manual of the Programming Language Lua"</I>
+<BR>
+<A HREF="http://www.tecgraf.puc-rio.br/lua/">http://www.tecgraf.puc-rio.br/lua/</A>
+<BR>
+"Lua: an extensible extension language",
+<I>Software: Practice &amp; Experience</I>
+<B>26</B>
+#6 (1996) 635-652.
+<H1>DIAGNOSTICS</H1>
+Error messages should be self explanatory.
+<H1>BUGS</H1>
+Inherits any bugs from Lua,
+but Lua has no bugs...
+<H1>AUTHORS</H1>
+L. H. de Figueiredo,
+R. Ierusalimschy and
+W. Celes
+<I>(<A HREF="mailto:lua@tecgraf.puc-rio.br">lua@tecgraf.puc-rio.br</A>)</I>