diff options
Diffstat (limited to 'doc/luac.html')
| -rw-r--r-- | doc/luac.html | 63 |
1 files changed, 30 insertions, 33 deletions
diff --git a/doc/luac.html b/doc/luac.html index e083c2b3..3a71622e 100644 --- a/doc/luac.html +++ b/doc/luac.html @@ -1,4 +1,4 @@ -<!-- luac.man,v 1.20 2000/10/06 15:11:21 lhf Exp --> +<!-- luac.man,v 1.25 2002/12/13 11:45:12 lhf Exp --> <HTML> <HEAD> <TITLE>LUAC man page</TITLE> @@ -19,17 +19,13 @@ luac - Lua compiler <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. +into binary files that can be latter loaded and executed. <P> The main advantages of precompiling chunks are: faster loading, protecting source code from user changes, and -off-line syntax error detection. +off-line syntax checking. <P> Pre-compiling does not imply faster execution because in Lua chunks are always compiled into bytecodes before being executed. @@ -52,9 +48,10 @@ 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 (``endianess'') is different. +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. +binary files created on a 16-bit platform cannot be read in a 32-bit platform, +nor vice-versa. <P> In the command line, you can mix @@ -66,15 +63,17 @@ into a single precompiled chunk. <P> You can use <B>"-"</B> -to indicate -<I>stdin</I> -as a source file. +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> -may change when a new version of Lua is released. -We try to maintain compatibility even for binary files, -but it is not always possible. +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> @@ -95,26 +94,16 @@ output to <I>file</I>, instead of the default <B>luac.out</B>. -The output file can be a source file because +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 or testing precompiled chunks: +Used mainly for syntax checking and for testing precompiled chunks: corrupted files will probably generate errors when loaded. -For a thourough integrity test, -use -<B>-t</B>. -<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 these chunks, -then the error messages might not contain the full information they usually do. -<P> -<B>-t</B> -perform a thourough integrity test of precompiled chunks. -Code that passes this test is completely safe, +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. @@ -124,9 +113,17 @@ If no files are given, then 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 these chunks, +then the error messages may not contain the full information they usually do +(line numbers and names of locals are lost). <P> <B>-v</B> -print version information. +show version information. <H1>FILES</H1> <P> <B>luac.out</B> @@ -134,14 +131,14 @@ default output file <H1>SEE ALSO</H1> <B>lua</B>(1) <BR> -<A HREF="http://www.tecgraf.puc-rio.br/lua/">http://www.tecgraf.puc-rio.br/lua/</A> +<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@tecgraf.puc-rio.br">lua@tecgraf.puc-rio.br</A>) +(<A HREF="mailto:lua-NO-SPAM-THANKS@tecgraf.puc-rio.br">lua AT tecgraf.puc-rio.br</A>) <!-- EOF --> </BODY> </HTML> |