[Wxlua-commit] wxLua/modules/lua/doc contents.html,NONE,1.1 logo.gif,NONE,1.1 lua.1,NONE,1.1 lua.htm

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/wxlua/wxLua/modules/lua/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14733/wxLua/modules/lua/doc

Added Files:
	contents.html logo.gif lua.1 lua.html luac.1 luac.html 
	manual.html readme.html 
Log Message:
moved files to the modules directory structure

--- NEW FILE: luac.html ---
<!-- luac.man,v 1.25 2002/12/13 11:45:12 lhf Exp -->
<HTML>
<HEAD>
<TITLE>LUAC man page</TITLE>
</HEAD>

<BODY BGCOLOR="#FFFFFF">

<H1>NAME</H1>
luac - Lua compiler
<H1>SYNOPSIS</H1>
luac
[
options
] [
filenames
]
<H1>DESCRIPTION</H1>
luac
is the Lua compiler.
It translates programs written in the Lua programming language
into binary files that can be latter loaded and executed.

The main advantages of precompiling chunks are:
faster loading,
protecting source code from user changes,
and
off-line syntax checking.

Pre-compiling does not imply faster execution
because in Lua chunks are always compiled into bytecodes before being executed.
luac
simply allows those bytecodes to be saved in a file for later execution.

luac
produces a single output file containing the bytecodes
for all source files given.
By default,
the output file is named
luac.out,
but you can change this with the
-o
option.

The binary files created by
luac
are portable to all architectures with the same word size.
This means that
binary files created on a 32-bit platform (such as Intel)
can be read without change in another 32-bit platform (such as Sparc),
even if the byte order (``endianness'') is different.
On the other hand,
binary files created on a 16-bit platform cannot be read in a 32-bit platform,
nor vice-versa.

In the command line,
you can mix
text files containing Lua source and
binary files containing precompiled chunks.
This is useful to combine several precompiled chunks,
even from different (but compatible) platforms,
into a single precompiled chunk.

You can use
"-"
to indicate the standard input as a source file
and
"--"
to signal the end of options
(that is,
all remaining arguments will be treated as files even if they start with
"-").

The internal format of the binary files produced by
luac
is likely to change when a new version of Lua is released.
So,
save the source files of all Lua programs that you precompile.

<H1>OPTIONS</H1>
Options must be separate.

-l
produce a listing of the compiled bytecode for Lua's virtual machine.
Listing bytecodes is useful to learn about Lua's virtual machine.
If no files are given, then
luac
loads
luac.out
and lists its contents.

-o "file"
output to
file,
instead of the default
luac.out.
The output file may be a source file because
all files are loaded before the output file is written.
Be careful not to overwrite precious files.

-p
load files but do not generate any output file.
Used mainly for syntax checking and for testing precompiled chunks:
corrupted files will probably generate errors when loaded.
Lua always performs a thorough integrity test on precompiled chunks.
Bytecode that passes this test is completely safe,
in the sense that it will not break the interpreter.
However,
there is no guarantee that such code does anything sensible.
(None can be given, because the halting problem is unsolvable.)
If no files are given, then
luac
loads
luac.out
and tests its contents.
No messages are displayed if the file passes the integrity test.

-s
strip debug information before writing the output file.
This saves some space in very large chunks,
but if errors occur when running these chunks,
then the error messages may not contain the full information they usually do
(line numbers and names of locals are lost).

-v
show version information.
<H1>FILES</H1>

luac.out
default output file
<H1>SEE ALSO</H1>
lua(1)
 
<A HREF="http://www.lua.org/">http://www.lua.org/</A>
<H1>DIAGNOSTICS</H1>
Error messages should be self explanatory.
<H1>AUTHORS</H1>
L. H. de Figueiredo,
R. Ierusalimschy and
W. Celes
(<A HREF="mailto:lua...@te...">lua AT tecgraf.puc-rio.br</A>)

</BODY>
</HTML>

--- NEW FILE: luac.1 ---
.\" luac.man,v 1.25 2002/12/13 11:45:12 lhf Exp
.TH LUAC 1 "2002/12/13 11:45:12"
.SH NAME
luac \- Lua compiler
.SH SYNOPSIS
.B luac
[
.I options
] [
.I filenames
]
.SH DESCRIPTION
.B luac
is the Lua compiler.
It translates programs written in the Lua programming language
into binary files that can be latter loaded and executed.
.LP
The main advantages of precompiling chunks are:
faster loading,
protecting source code from user changes,
and
off-line syntax checking.
.LP
Pre-compiling does not imply faster execution
because in Lua chunks are always compiled into bytecodes before being executed.
.B luac
simply allows those bytecodes to be saved in a file for later execution.
.LP
.B luac
produces a single output file containing the bytecodes
for all source files given.
By default,
the output file is named
.BR luac.out ,
but you can change this with the
.B \-o
option.
.LP
The binary files created by
.B luac
are portable to all architectures with the same word size.
This means that
binary files created on a 32-bit platform (such as Intel)
can be read without change in another 32-bit platform (such as Sparc),
even if the byte order (``endianness'') is different.
On the other hand,
binary files created on a 16-bit platform cannot be read in a 32-bit platform,
nor vice-versa.
.LP
In the command line,
you can mix
text files containing Lua source and
binary files containing precompiled chunks.
This is useful to combine several precompiled chunks,
even from different (but compatible) platforms,
into a single precompiled chunk.
.LP
You can use
.B "\-"
to indicate the standard input as a source file
and
.B "\--"
to signal the end of options
(that is,
all remaining arguments will be treated as files even if they start with
.BR "\-" ).
.LP
The internal format of the binary files produced by
.B luac
is likely to change when a new version of Lua is released.
So,
save the source files of all Lua programs that you precompile.
.LP
.SH OPTIONS
Options must be separate.
.TP
.B \-l
produce a listing of the compiled bytecode for Lua's virtual machine.
Listing bytecodes is useful to learn about Lua's virtual machine.
If no files are given, then
.B luac
loads
.B luac.out
and lists its contents.
.TP
.BI \-o " file"
output to
.IR file ,
instead of the default
.BR luac.out .
The output file may be a source file because
all files are loaded before the output file is written.
Be careful not to overwrite precious files.
.TP
.B \-p
load files but do not generate any output file.
Used mainly for syntax checking and for testing precompiled chunks:
corrupted files will probably generate errors when loaded.
Lua always performs a thorough integrity test on precompiled chunks.
Bytecode that passes this test is completely safe,
in the sense that it will not break the interpreter.
However,
there is no guarantee that such code does anything sensible.
(None can be given, because the halting problem is unsolvable.)
If no files are given, then
.B luac
loads
.B luac.out
and tests its contents.
No messages are displayed if the file passes the integrity test.
.TP
.B \-s
strip debug information before writing the output file.
This saves some space in very large chunks,
but if errors occur when running these chunks,
then the error messages may not contain the full information they usually do
(line numbers and names of locals are lost).
.TP
.B \-v
show version information.
.SH FILES
.TP 15
.B luac.out
default output file
.SH "SEE ALSO"
.BR lua (1)
.br
http://www.lua.org/
.SH DIAGNOSTICS
Error messages should be self explanatory.
.SH AUTHORS
L. H. de Figueiredo,
R. Ierusalimschy and
W. Celes
(lu...@te...)
.\" EOF

--- NEW FILE: contents.html ---
<HTML>
<HEAD>
<TITLE>Lua: 5.0 reference manual - contents</TITLE>
</HEAD>

<BODY BGCOLOR="#FFFFFF">

<HR>
<H1>
<A HREF="http://www.lua.org/home.html"><IMG SRC="logo.gif" ALT="Lua" BORDER=0></A>
Reference manual for Lua 5.0
</H1>

<A HREF="manual.html">Lua 5.0 Reference Manual</A>
[
<A HREF="manual.html">top</A>
|
<A HREF="http://www.lua.org/ftp/refman-5.0.ps.gz">ps</A>
|
<A HREF="http://www.lua.org/ftp/refman-5.0.pdf">pdf</A>
]
<P>

<A HREF="http://www.lua.org/copyright.html">Copyright</A>
&copy; 2003 Tecgraf, PUC-Rio. All rights reserved.
<HR>

<UL>
<LI><A HREF="manual.html#1">1 - Introduction</A>
<LI><A HREF="manual.html#2">2 - The Language</A>
<UL>
<LI><A HREF="manual.html#2.1">2.1 - Lexical Conventions</A>
<LI><A HREF="manual.html#2.2">2.2 - Values and Types</A>
<UL>
<LI><A HREF="manual.html#2.2.1">2.2.1 - Coercion</A>
</UL>
<LI><A HREF="manual.html#2.3">2.3 - Variables</A>
<LI><A HREF="manual.html#2.4">2.4 - Statements</A>
<UL>
<LI><A HREF="manual.html#2.4.1">2.4.1 - Chunks</A>
<LI><A HREF="manual.html#2.4.2">2.4.2 - Blocks</A>
<LI><A HREF="manual.html#2.4.3">2.4.3 - Assignment</A>
<LI><A HREF="manual.html#2.4.4">2.4.4 - Control Structures</A>
<LI><A HREF="manual.html#2.4.5">2.4.5 - For Statement</A>
<LI><A HREF="manual.html#2.4.6">2.4.6 - Function Calls as Statements</A>
<LI><A HREF="manual.html#2.4.7">2.4.7 - Local Declarations</A>
</UL>
<LI><A HREF="manual.html#2.5">2.5 - Expressions</A>
<UL>
<LI><A HREF="manual.html#2.5.1">2.5.1 - Arithmetic Operators</A>
<LI><A HREF="manual.html#2.5.2">2.5.2 - Relational Operators</A>
<LI><A HREF="manual.html#2.5.3">2.5.3 - Logical Operators</A>
<LI><A HREF="manual.html#2.5.4">2.5.4 - Concatenation</A>
<LI><A HREF="manual.html#2.5.5">2.5.5 - Precedence</A>
<LI><A HREF="manual.html#2.5.6">2.5.6 - Table Constructors</A>
<LI><A HREF="manual.html#2.5.7">2.5.7 - Function Calls</A>
<LI><A HREF="manual.html#2.5.8">2.5.8 - Function Definitions</A>
</UL>
</UL>
<UL>
<LI><A HREF="manual.html#2.6">2.6 - Visibility Rules</A>
<LI><A HREF="manual.html#2.7">2.7 - Error Handling</A>
<LI><A HREF="manual.html#2.8">2.8 - Metatables</A>
<LI><A HREF="manual.html#2.9">2.9 - Garbage Collection</A>
<UL>
<LI><A HREF="manual.html#2.9.1">2.9.1 - Garbage-Collection Metamethods</A>
<LI><A HREF="manual.html#2.9.2">2.9.2 - Weak Tables</A>
</UL>
<LI><A HREF="manual.html#2.10">2.10 - Coroutines</A>
</UL>
<LI><A HREF="manual.html#3">3 - The Application Program Interface</A>
<UL>
<LI><A HREF="manual.html#3.1">3.1 - States</A>
<LI><A HREF="manual.html#3.2">3.2 - The Stack and Indices</A>
<LI><A HREF="manual.html#3.3">3.3 - Stack Manipulation</A>
<LI><A HREF="manual.html#3.4">3.4 - Querying the Stack</A>
<LI><A HREF="manual.html#3.5">3.5 - Getting Values from the Stack</A>
<LI><A HREF="manual.html#3.6">3.6 - Pushing Values onto the Stack</A>
<LI><A HREF="manual.html#3.7">3.7 - Controlling Garbage Collection</A>
<LI><A HREF="manual.html#3.8">3.8 - Userdata</A>
<LI><A HREF="manual.html#3.9">3.9 - Metatables</A>
<LI><A HREF="manual.html#3.10">3.10 - Loading Lua Chunks</A>
<LI><A HREF="manual.html#3.11">3.11 - Manipulating Tables</A>
<LI><A HREF="manual.html#3.12">3.12 - Manipulating Environments</A>
<LI><A HREF="manual.html#3.13">3.13 - Using Tables as Arrays</A>
<LI><A HREF="manual.html#3.14">3.14 - Calling Functions</A>
<LI><A HREF="manual.html#3.15">3.15 - Protected Calls</A>
<LI><A HREF="manual.html#3.16">3.16 - Defining C Functions</A>
<LI><A HREF="manual.html#3.17">3.17 - Defining C Closures</A>
<LI><A HREF="manual.html#3.18">3.18 - Registry</A>
<LI><A HREF="manual.html#3.19">3.19 - Error Handling in C</A>
<LI><A HREF="manual.html#3.20">3.20 - Threads</A>
</UL>
<LI><A HREF="manual.html#4">4 - The Debug Interface</A>
<UL>
<LI><A HREF="manual.html#4.1">4.1 - Stack and Function Information</A>
<LI><A HREF="manual.html#4.2">4.2 - Manipulating Local Variables and Upvalues</A>
<LI><A HREF="manual.html#4.3">4.3 - Hooks</A>
</UL>
<LI><A HREF="manual.html#5">5 - Standard Libraries</A>
<UL>
<LI><A HREF="manual.html#5.1">5.1 - Basic Functions</A>
<LI><A HREF="manual.html#5.2">5.2 - Coroutine Manipulation</A>
<LI><A HREF="manual.html#5.3">5.3 - String Manipulation</A>
<LI><A HREF="manual.html#5.4">5.4 - Table Manipulation</A>
<LI><A HREF="manual.html#5.5">5.5 - Mathematical Functions</A>
<LI><A HREF="manual.html#5.6">5.6 - Input and Output Facilities</A>
<LI><A HREF="manual.html#5.7">5.7 - Operating System Facilities</A>
<LI><A HREF="manual.html#5.8">5.8 - The Reflexive Debug Interface</A>
</UL>
<LI><A HREF="manual.html#6">6 - Lua Stand-alone</A>
<LI><A HREF="manual.html#BNF">The Complete Syntax of Lua</A>
</UL>

<HR>
<SMALL>
Last update:
Wed May  7 18:34:34 EST 2003
</SMALL>

</BODY>
</HTML>

--- NEW FILE: lua.html ---
<!-- lua.man,v 1.8 2003/04/02 00:05:20 lhf Exp -->
<HTML>
<HEAD>
<TITLE>LUA man page</TITLE>
</HEAD>

<BODY BGCOLOR="#FFFFFF">

<H1>NAME</H1>
lua - Lua interpreter
<H1>SYNOPSIS</H1>
lua
[
options
]
[
script
[
args
]
]
<H1>DESCRIPTION</H1>
lua
is the stand-alone Lua interpreter.
It loads and executes Lua programs,
either in textual source form or
in precompiled binary form.
(Precompiled binaries are output by
luac,
the Lua compiler.)
lua
can be used as a batch interpreter and also interactively.

The given
options
(see below)
are executed and then
the Lua program in file
script
is loaded and executed.
The given
args
are available to
script
as strings in a global table named
arg.
If these arguments contain spaces or other characters special to the shell,
then they should be quoted
(but note that the quotes will be removed by the shell).
The arguments in
arg
start at 0,
which contains the string
`script'.
The index of the last argument is stored in
"arg.n".
The arguments given in the command line before
script,
including the name of the interpreter,
are available in negative indices in
arg.

At the very start,
before even handling the command line,
lua
executes the contents of the environment variable
LUA_INIT,
if it is defined.
If the value of
LUA_INIT
is of the form
`@filename',
then
filename
is executed.
Otherwise, the string is assumed to be a Lua statement and is executed.

Options start with
-
and are described below.
You can use
"--"
to signal the end of options.

If no arguments are given,
then
"-v -i"
is assumed when the standard input is a terminal;
otherwise,
"-"
is assumed.

In interactive mode,
lua
prompts the user,
reads lines from the standard input,
and executes them as they are read.
If a line does not contain a complete statement,
then a secondary prompt is displayed and
lines are read until a complete statement is formed or
a syntax error is found.
So, one way to interrupt the reading of an incomplete statement is
to force a syntax error:
adding a
`;' 
in the middle of a statement is a sure way of forcing a syntax error
(except inside multiline strings and comments; these must be closed explicitly).
If a line starts with
`=',
then
lua
displays the values of all the expressions in the remainder of the
line. The expressions must be separated by commas.
The primary prompt is the value of the global variable
_PROMPT,
if this value is a string;
otherwise, the default prompt is used.
Similarly, the secondary prompt is the value of the global variable
_PROMPT2.
So,
to change the prompts,
set the corresponding variable to a string of your choice.
You can do that after calling the interpreter
or on the command line with
"_PROMPT" "=\'lua: \'",
for example.
(Note the need for quotes, because the string contains a space.)
The default prompts are ``&gt; '' and ``&gt;&gt; ''.
<H1>OPTIONS</H1>

-
load and execute the standard input as a file,
that is,
not interactively,
even when the standard input is a terminal.

-e "stat"
execute statement
stat.
You need to quote
stat 
if it contains spaces, quotes,
or other characters special to the shell.

-i
enter interactive mode after
script
is executed.

-l "file"
call
require( file)
before executing
script.
Typically used to load libraries
(hence the letter
l).

-v
show version information.
<H1>SEE ALSO</H1>
luac(1)
 
<A HREF="http://www.lua.org/">http://www.lua.org/</A>
<H1>DIAGNOSTICS</H1>
Error messages should be self explanatory.
<H1>AUTHORS</H1>
R. Ierusalimschy,
L. H. de Figueiredo,
and
W. Celes
(<A HREF="mailto:lua...@te...">lua AT tecgraf.puc-rio.br</A>)

</BODY>
</HTML>

--- NEW FILE: readme.html ---
<HTML>
<HEAD>
<TITLE>Lua documentation</TITLE>
</HEAD>

<BODY BGCOLOR="#FFFFFF">

<HR>
<H1>
<A HREF="http://www.lua.org/"><IMG SRC="logo.gif" ALT="Lua" BORDER=0></A>
Documentation
</H1>

<UL>
<LI><A HREF="http://www.lua.org/">Official web site</A>
<LI><A HREF="contents.html">Reference manual</A>
<LI><A HREF="lua.html">lua man page</A>
<LI><A HREF="luac.html">luac man page</A>
<LI><A HREF="../README">lua/README</A>
<LI><A HREF="../src/README">lua/src/README</A>
<LI><A HREF="../src/lib/README">lua/src/lib/README</A>
<LI><A HREF="../src/lua/README">lua/src/lua/README</A>
<LI><A HREF="../src/luac/README">lua/src/luac/README</A>
<LI><A HREF="../etc/README">lua/etc/README</A>
<LI><A HREF="../test/README">lua/test/README</A>
</UL>

<HR>
<SMALL>
Last update:
Thu Mar 11 23:08:56 BRT 2004
</SMALL>

</BODY>
</HTML>

--- NEW FILE: lua.1 ---
.\" lua.man,v 1.8 2003/04/02 00:05:20 lhf Exp
.TH LUA 1 "2003/04/02 00:05:20"
.SH NAME
lua \- Lua interpreter
.SH SYNOPSIS
.B lua
[
.I options
]
[
.I script
[
.I args
]
]
.SH DESCRIPTION
.B lua
is the stand-alone Lua interpreter.
It loads and executes Lua programs,
either in textual source form or
in precompiled binary form.
(Precompiled binaries are output by
.BR luac ,
the Lua compiler.)
.B lua
can be used as a batch interpreter and also interactively.
.LP
The given
.I options
(see below)
are executed and then
the Lua program in file
.I script
is loaded and executed.
The given
.I args
are available to
.I script
as strings in a global table named
.BR arg .
If these arguments contain spaces or other characters special to the shell,
then they should be quoted
(but note that the quotes will be removed by the shell).
The arguments in
.B arg
start at 0,
which contains the string
.RI ` script '.
The index of the last argument is stored in
.BR "arg.n" .
The arguments given in the command line before
.IR script ,
including the name of the interpreter,
are available in negative indices in
.BR arg .
.LP
At the very start,
before even handling the command line,
.B lua
executes the contents of the environment variable
.BR LUA_INIT ,
if it is defined.
If the value of
.B LUA_INIT
is of the form
.RI `@ filename ',
then
.I filename
is executed.
Otherwise, the string is assumed to be a Lua statement and is executed.
.LP
Options start with
.B \-
and are described below.
You can use
.B "\--"
to signal the end of options.
.LP
If no arguments are given,
then
.B "\-v \-i"
is assumed when the standard input is a terminal;
otherwise,
.B "\-"
is assumed.
.LP
In interactive mode,
.B lua
prompts the user,
reads lines from the standard input,
and executes them as they are read.
If a line does not contain a complete statement,
then a secondary prompt is displayed and
lines are read until a complete statement is formed or
a syntax error is found.
So, one way to interrupt the reading of an incomplete statement is
to force a syntax error:
adding a
.B `;' 
in the middle of a statement is a sure way of forcing a syntax error
(except inside multiline strings and comments; these must be closed explicitly).
If a line starts with
.BR `=' ,
then
.B lua
displays the values of all the expressions in the remainder of the
line. The expressions must be separated by commas.
The primary prompt is the value of the global variable
.BR _PROMPT ,
if this value is a string;
otherwise, the default prompt is used.
Similarly, the secondary prompt is the value of the global variable
.BR _PROMPT2 .
So,
to change the prompts,
set the corresponding variable to a string of your choice.
You can do that after calling the interpreter
or on the command line with
.BR "_PROMPT" "=\'lua: \'" ,
for example.
(Note the need for quotes, because the string contains a space.)
The default prompts are ``> '' and ``>> ''.
.SH OPTIONS
.TP
.B \-
load and execute the standard input as a file,
that is,
not interactively,
even when the standard input is a terminal.
.TP
.BI \-e " stat"
execute statement
.IR stat .
You need to quote
.I stat 
if it contains spaces, quotes,
or other characters special to the shell.
.TP
.B \-i
enter interactive mode after
.I script
is executed.
.TP
.BI \-l " file"
call
.BI require( file )
before executing
.IR script.
Typically used to load libraries
(hence the letter
.IR l ).
.TP
.B \-v
show version information.
.SH "SEE ALSO"
.BR luac (1)
.br
http://www.lua.org/
.SH DIAGNOSTICS
Error messages should be self explanatory.
.SH AUTHORS
R. Ierusalimschy,
L. H. de Figueiredo,
and
W. Celes
(lu...@te...)
.\" EOF

--- NEW FILE: logo.gif ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: manual.html ---
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>

<head>
<TITLE>Lua: 5.0 reference manual</TITLE>
</head>

<body BGCOLOR="#FFFFFF">

<hr>
<h1>
<A HREF="http://www.lua.org/home.html"><IMG SRC="logo.gif" ALT="Lua" BORDER=0></A>
Lua 5.0 Reference Manual
</h1>

by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes
<p>
<small>
<a HREF="http://www.lua.org/copyright.html">Copyright</a>
[...4573 lines suppressed...]
	fieldsep ::= `<b>,</b>&acute; | `<b>;</b>&acute;

<p>	binop ::= `<b>+</b>&acute; | `<b>-</b>&acute; | `<b>*</b>&acute; | `<b>/</b>&acute; | `<b>^</b>&acute; | `<b>..</b>&acute; | `<b>&#060;</b>&acute; | `<b>&#060;=</b>&acute; | `<b>></b>&acute; | `<b>>=</b>&acute; | `<b>==</b>&acute; | `<b>~=</b>&acute; | <b>and</b> | <b>or</b>

<p>	unop ::= `<b>-</b>&acute; | <b>not</b>

<p></pre>

<p>

<p>

<HR>
<SMALL>
Last update:
Tue Nov 25 16:08:37 BRST 2003
</SMALL>

</BODY>
</HTML>

[Wxlua-commit] wxLua/modules/lua/doc contents.html,NONE,1.1 logo.gif,NONE,1.1 lua.1,NONE,1.1 lua.htm

[Wxlua-commit] wxLua/modules/lua/doc contents.html,NONE,1.1 logo.gif,NONE,1.1 lua.1,NONE,1.1 lua.html,NONE,1.1 luac.1,NONE,1.1 luac.html,NONE,1.1 manual.html,NONE,1.1 readme.html,NONE,1.1