etc/README

   1 This directory contains some useful files and code.
   2 Unlike the code in ../src, everything here is in the public domain.
   3
   4 bin2c.c
   5         This program converts files to byte arrays that are automatically run
   6         with lua_dobuffer. This allows C programs to include all necessary Lua
   7         code, even in precompiled form. Even if the code is included in source
   8         form, bin2c is useful because it avoids the hassle of having to quote
   9         special characters in C strings.
  10         Example of usage: Run bin2c file1 file2 ... > init.h. Then, in your
  11         C program, just do #include "init.h" anywhere in the *body* of a
  12         function. This will be equivalent to calling
  13                 lua_dofile(L,"file1"); lua_dofile(L,"file2"); ...
  14         Note that the Lua state is called "L". If you use a different name,
  15         say "mystate", just #define L mystate before you #include "init.h".
  16
  17 compat.lua
  18         A compatibility module for Lua 4.0 functions.
  19
  20 doall.lua
  21         Emulate the command line behaviour of Lua 4.0
  22
  23 lua.ico
  24         A Lua icon for Windows.
  25         Drawn by hand by Markus Gritsch <gritsch@iue.tuwien.ac.at>.
  26
  27 lua.magic
  28         Data for teaching file(1) about Lua precompiled chunks.
  29
  30 lua.xpm
  31         The same icon as lua.ico, but in XPM format.
  32         It was converted with ImageMagick by Andy Tai <andy@exp.com>.
  33
  34 luser_number.h
  35         Number type configuration for Lua core.
  36
  37 luser_tests.h
  38         Self-test configuration for Lua core.
  39
  40 min.c
  41         A minimal Lua interpreter.
  42         Good for learning and for starting your own.
  43
  44 noparser.c
  45         Linking with noparser.o avoids loading the parsing modules in lualib.a.
  46         Do "make luab" to build a sample Lua intepreter that does not parse
  47         Lua programs, only loads precompiled programs.
  48
  49 saconfig.c
  50         Configuration for Lua interpreter.
  51
  52 trace.c
  53         A simple execution tracer.
  54         An example of how to use the debug hooks in C.