diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua.1 | 163 | ||||
| -rw-r--r-- | doc/lua.html | 172 | ||||
| -rw-r--r-- | doc/luac.1 | 136 | ||||
| -rw-r--r-- | doc/luac.html | 145 | ||||
| -rw-r--r-- | doc/readme.html | 40 |
5 files changed, 0 insertions, 656 deletions
diff --git a/doc/lua.1 b/doc/lua.1 deleted file mode 100644 index 24809cc..0000000 --- a/doc/lua.1 +++ /dev/null @@ -1,163 +0,0 @@ -.\" $Id: lua.man,v 1.11 2006/01/06 16:03:34 lhf Exp $ -.TH LUA 1 "$Date: 2006/01/06 16:03:34 $" -.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 -(but in this case you have to be careful with quotes -if the prompt string contains a space; otherwise you may confuse the shell.) -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 " name" -call -.BI require(' name ') -before executing -.IR script . -Typically used to load libraries. -.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 -.\" EOF diff --git a/doc/lua.html b/doc/lua.html deleted file mode 100644 index 1d435ab..0000000 --- a/doc/lua.html +++ /dev/null @@ -1,172 +0,0 @@ -<!-- $Id: lua.man,v 1.11 2006/01/06 16:03:34 lhf Exp $ --> -<HTML> -<HEAD> -<TITLE>LUA man page</TITLE> -<LINK REL="stylesheet" TYPE="text/css" HREF="lua.css"> -</HEAD> - -<BODY BGCOLOR="#FFFFFF"> - -<H2>NAME</H2> -lua - Lua interpreter -<H2>SYNOPSIS</H2> -<B>lua</B> -[ -<I>options</I> -] -[ -<I>script</I> -[ -<I>args</I> -] -] -<H2>DESCRIPTION</H2> -<B>lua</B> -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 -<B>luac</B>, -the Lua compiler.) -<B>lua</B> -can be used as a batch interpreter and also interactively. -<P> -The given -<I>options</I> -(see below) -are executed and then -the Lua program in file -<I>script</I> -is loaded and executed. -The given -<I>args</I> -are available to -<I>script</I> -as strings in a global table named -<B>arg</B>. -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</B> -start at 0, -which contains the string -'<I>script</I>'. -The index of the last argument is stored in -<B>arg.n</B>. -The arguments given in the command line before -<I>script</I>, -including the name of the interpreter, -are available in negative indices in -<B>arg</B>. -<P> -At the very start, -before even handling the command line, -<B>lua</B> -executes the contents of the environment variable -<B>LUA_INIT</B>, -if it is defined. -If the value of -<B>LUA_INIT</B> -is of the form -'@<I>filename</I>', -then -<I>filename</I> -is executed. -Otherwise, the string is assumed to be a Lua statement and is executed. -<P> -Options start with -<B>'-'</B> -and are described below. -You can use -<B>'--'</B> -to signal the end of options. -<P> -If no arguments are given, -then -<B>"-v -i"</B> -is assumed when the standard input is a terminal; -otherwise, -<B>"-"</B> -is assumed. -<P> -In interactive mode, -<B>lua</B> -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>';'</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 -<B>'='</B>, -then -<B>lua</B> -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 -<B>_PROMPT</B>, -if this value is a string; -otherwise, the default prompt is used. -Similarly, the secondary prompt is the value of the global variable -<B>_PROMPT2</B>. -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 -(but in this case you have to be careful with quotes -if the prompt string contains a space; otherwise you may confuse the shell.) -The default prompts are "> " and ">> ". -<H2>OPTIONS</H2> -<P> -<B>-</B> -load and execute the standard input as a file, -that is, -not interactively, -even when the standard input is a terminal. -<P> -<B>-e </B><I>stat</I> -execute statement -<I>stat</I>. -You need to quote -<I>stat </I> -if it contains spaces, quotes, -or other characters special to the shell. -<P> -<B>-i</B> -enter interactive mode after -<I>script</I> -is executed. -<P> -<B>-l </B><I>name</I> -call -<B>require</B>('<I>name</I>') -before executing -<I>script</I>. -Typically used to load libraries. -<P> -<B>-v</B> -show version information. -<H2>SEE ALSO</H2> -<B>luac</B>(1) -<BR> -<A HREF="http://www.lua.org/">http://www.lua.org/</A> -<H2>DIAGNOSTICS</H2> -Error messages should be self explanatory. -<H2>AUTHORS</H2> -R. Ierusalimschy, -L. H. de Figueiredo, -and -W. Celes -<!-- EOF --> -</BODY> -</HTML> diff --git a/doc/luac.1 b/doc/luac.1 deleted file mode 100644 index d814678..0000000 --- a/doc/luac.1 +++ /dev/null @@ -1,136 +0,0 @@ -.\" $Id: luac.man,v 1.28 2006/01/06 16:03:34 lhf Exp $ -.TH LUAC 1 "$Date: 2006/01/06 16:03:34 $" -.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 later loaded and executed. -.LP -The main advantages of precompiling chunks are: -faster loading, -protecting source code from accidental 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 -Pre-compiled chunks are not necessarily smaller than the corresponding source. -The main goal in pre-compiling is faster loading. -.LP -The binary files created by -.B luac -are portable only among architectures with the same word size and byte order. -.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 -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 . -(You can use -.B "'\-'" -for standard output, -but not on platforms that open standard output in text mode.) -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 a stripped chunk, -then the error messages may not contain the full information they usually do. -For instance, -line numbers and names of local variables 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 -.\" EOF diff --git a/doc/luac.html b/doc/luac.html deleted file mode 100644 index 179ffe8..0000000 --- a/doc/luac.html +++ /dev/null @@ -1,145 +0,0 @@ -<!-- $Id: luac.man,v 1.28 2006/01/06 16:03:34 lhf Exp $ --> -<HTML> -<HEAD> -<TITLE>LUAC man page</TITLE> -<LINK REL="stylesheet" TYPE="text/css" HREF="lua.css"> -</HEAD> - -<BODY BGCOLOR="#FFFFFF"> - -<H2>NAME</H2> -luac - Lua compiler -<H2>SYNOPSIS</H2> -<B>luac</B> -[ -<I>options</I> -] [ -<I>filenames</I> -] -<H2>DESCRIPTION</H2> -<B>luac</B> -is the Lua compiler. -It translates programs written in the Lua programming language -into binary files that can be later loaded and executed. -<P> -The main advantages of precompiling chunks are: -faster loading, -protecting source code from accidental user changes, -and -off-line syntax checking. -<P> -Precompiling does not imply faster execution -because in Lua chunks are always compiled into bytecodes before being executed. -<B>luac</B> -simply allows those bytecodes to be saved in a file for later execution. -<P> -Precompiled chunks are not necessarily smaller than the corresponding source. -The main goal in precompiling is faster loading. -<P> -The binary files created by -<B>luac</B> -are portable only among architectures with the same word size and byte order. -<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> -In the command line, -you can mix -text files containing Lua source and -binary files containing precompiled chunks. -This is useful because several precompiled chunks, -even from different (but compatible) platforms, -can be combined into a single precompiled chunk. -<P> -You can use -<B>'-'</B> -to indicate the standard input as a source file -and -<B>'--'</B> -to signal the end of options -(that is, -all remaining arguments will be treated as files even if they start with -<B>'-'</B>). -<P> -The internal format of the binary files produced by -<B>luac</B> -is likely to change when a new version of Lua is released. -So, -save the source files of all Lua programs that you precompile. -<P> -<H2>OPTIONS</H2> -Options must be separate. -<P> -<B>-l</B> -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</B> -loads -<B>luac.out</B> -and lists its contents. -<P> -<B>-o </B><I>file</I> -output to -<I>file</I>, -instead of the default -<B>luac.out</B>. -(You can use -<B>'-'</B> -for standard output, -but not on platforms that open standard output in text mode.) -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> -<B>-p</B> -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</B> -loads -<B>luac.out</B> -and tests its contents. -No messages are displayed if the file passes the integrity test. -<P> -<B>-s</B> -strip debug information before writing the output file. -This saves some space in very large chunks, -but if errors occur when running a stripped chunk, -then the error messages may not contain the full information they usually do. -For instance, -line numbers and names of local variables are lost. -<P> -<B>-v</B> -show version information. -<H2>FILES</H2> -<P> -<B>luac.out</B> -default output file -<H2>SEE ALSO</H2> -<B>lua</B>(1) -<BR> -<A HREF="http://www.lua.org/">http://www.lua.org/</A> -<H2>DIAGNOSTICS</H2> -Error messages should be self explanatory. -<H2>AUTHORS</H2> -L. H. de Figueiredo, -R. Ierusalimschy and -W. Celes -<!-- EOF --> -</BODY> -</HTML> diff --git a/doc/readme.html b/doc/readme.html deleted file mode 100644 index 3ed6a81..0000000 --- a/doc/readme.html +++ /dev/null @@ -1,40 +0,0 @@ -<HTML> -<HEAD> -<TITLE>Lua documentation</TITLE> -<LINK REL="stylesheet" TYPE="text/css" HREF="lua.css"> -</HEAD> - -<BODY> - -<HR> -<H1> -<A HREF="http://www.lua.org/"><IMG SRC="logo.gif" ALT="Lua" BORDER=0></A> -Documentation -</H1> - -This is the documentation included in the source distribution of Lua 5.1.5. - -<UL> -<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="../etc/README">lua/etc/README</A> -<LI><A HREF="../test/README">lua/test/README</A> -</UL> - -Lua's -<A HREF="http://www.lua.org/">official web site</A> -contains updated documentation, -especially the -<A HREF="http://www.lua.org/manual/5.1/">reference manual</A>. -<P> - -<HR> -<SMALL> -Last update: -Fri Feb 3 09:44:42 BRST 2012 -</SMALL> - -</BODY> -</HTML> |