summaryrefslogtreecommitdiff
path: root/src/luac/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/luac/README')
-rw-r--r--src/luac/README34
1 files changed, 14 insertions, 20 deletions
diff --git a/src/luac/README b/src/luac/README
index 9fba74bb..8d8bb491 100644
--- a/src/luac/README
+++ b/src/luac/README
@@ -1,28 +1,22 @@
+This is luac, the Lua compiler.
+There are man pages for it in both nroff and html in ../../doc.
+
luac translates Lua programs into binary files that can be loaded and executed
with lua_dofile in C or with dofile in Lua.
-The main advantages of pre-compiling chunks are: faster loading,
-protecting source code from user changes, off-line syntax error detection.
+The main advantages of pre-compiling chunks are: faster loading, protecting
+source code from user changes, and off-line syntax error detection.
luac can also be used to learn about the Lua virtual machine.
Here are the options that luac understands:
- -c compile (default)
- -d generate debugging information
- -D name predefine 'name' for conditional compilation
- -l list (default for -u)
- -n save numbers in native format (file may not be portable)
- -o file output file for -c (default is "luac.out")
- -O optimize
- -p parse only
- -q quiet (default for -c)
- -t test code integrity
- -u undump
- -U name undefine 'name' for conditional compilation
- -v show version information
- -V verbose
- - compile "stdin"
+ - process stdin
+ -l list
+ -o file output file (default is "luac.out")
+ -p parse only
+ -s strip debug information
+ -t test code integrity
+ -v show version information
-Finally, luac is an example of how to use the internals of Lua (politely).
-Also, luac does not need the runtime code and stubs.c makes sure it is not
+luac is also an example of how to use the internals of Lua (politely).
+Finally, luac does not need the runtime code, and stubs.c makes sure it is not
linked into luac. This file also shows how to avoid linking the parser.
-