summaryrefslogtreecommitdiff
path: root/etc/README
diff options
context:
space:
mode:
authorLua Team <team@lua.org>2003-04-11 12:00:00 +0000
committerrepogen <>2003-04-11 12:00:00 +0000
commitf0e4e22f5c119865eb5a8d3844a40df2d5980b3b (patch)
treec4df063a747e9c99f8aba1678588a030993780a9 /etc/README
parent1981b7c90eb09e956e969cda5c473be4560af573 (diff)
downloadlua-github-5.0.tar.gz
Lua 5.05.0
Diffstat (limited to 'etc/README')
-rw-r--r--etc/README59
1 files changed, 35 insertions, 24 deletions
diff --git a/etc/README b/etc/README
index eaae1c3d..c838a7fe 100644
--- a/etc/README
+++ b/etc/README
@@ -1,43 +1,54 @@
-This directory contains some code that might be useful.
+This directory contains some useful files and code.
+Unlike the code in ../src, everything here is in the public domain.
bin2c.c
- This program converts files to byte arrays that are automatically
- run with lua_dobuffer. This allows C programs to include all necessary
- Lua code, even in precompiled form. Even if the code is included in
- source form, bin2c is useful because it avoids the hassle of having to
- quote special characters in C strings.
- Example of usage: Run bin2c file1 file2 ... > init.h. Then, in your C
- program, just do #include "init.h" anywhere in the *body* of a
+ This program converts files to byte arrays that are automatically run
+ with lua_dobuffer. This allows C programs to include all necessary Lua
+ code, even in precompiled form. Even if the code is included in source
+ form, bin2c is useful because it avoids the hassle of having to quote
+ special characters in C strings.
+ Example of usage: Run bin2c file1 file2 ... > init.h. Then, in your
+ C program, just do #include "init.h" anywhere in the *body* of a
function. This will be equivalent to calling
lua_dofile(L,"file1"); lua_dofile(L,"file2"); ...
Note that the Lua state is called "L". If you use a different name,
- say "mystate", just #define L mystate before #include "init.h".
+ say "mystate", just #define L mystate before you #include "init.h".
-def.lua
- A Lua script for creating .DEF for Windows DLLs.
- Just do "make def" to create lua.def.
+compat.lua
+ A compatibility module for Lua 4.0 functions.
-min.c
- A minimal Lua interpreter.
+doall.lua
+ Emulate the command line behaviour of Lua 4.0
lua.ico
A Lua icon for Windows.
- It was drawn by hand by Markus Gritsch <gritsch@iue.tuwien.ac.at>.
+ Drawn by hand by Markus Gritsch <gritsch@iue.tuwien.ac.at>.
+
+lua.magic
+ Data for teaching file(1) about Lua precompiled chunks.
lua.xpm
The same icon as lua.ico, but in XPM format.
It was converted with ImageMagick by Andy Tai <andy@exp.com>.
-lua.magic
- Data for teaching file(1) about Lua precompiled chunks.
+luser_number.h
+ Number type configuration for Lua core.
+
+luser_tests.h
+ Self-test configuration for Lua core.
+
+min.c
+ A minimal Lua interpreter.
+ Good for learning and for starting your own.
-stdcall.lua
- A Lua script for changing the calling convention to __stdcall.
- Do "make stdcall" and new modules will be created in stdcall/.
+noparser.c
+ Linking with noparser.o avoids loading the parsing modules in lualib.a.
+ Do "make luab" to build a sample Lua intepreter that does not parse
+ Lua programs, only loads precompiled programs.
-setfallback.lua
- A Lua implementation of fallbacks on top of tag methods.
- You only need this module if you have Lua code that uses setfallback.
+saconfig.c
+ Configuration for Lua interpreter.
trace.c
- A simple execution tracer. An example of how to use the debugging hooks.
+ A simple execution tracer.
+ An example of how to use the debug hooks in C.