external/mit/lua/dist/doc/luac.1

   1 .\"     $NetBSD: luac.1,v 1.1.1.2 2012/03/15 00:08:21 alnsn Exp $
   2 .\"
   3 .\" $Id: luac.1,v 1.1.1.2 2012/03/15 00:08:21 alnsn Exp $
   4 .TH LUAC 1 "$Date: 2012/03/15 00:08:21 $"
   5 .SH NAME
   6 luac \- Lua compiler
   7 .SH SYNOPSIS
   8 .B luac
   9 [
  10 .I options
  11 ] [
  12 .I filenames
  13 ]
  14 .SH DESCRIPTION
  15 .B luac
  16 is the Lua compiler.
  17 It translates programs written in the Lua programming language
  18 into binary files that can be later loaded and executed.
  19 .LP
  20 The main advantages of precompiling chunks are:
  21 faster loading,
  22 protecting source code from accidental user changes,
  23 and
  24 off-line syntax checking.
  25 .LP
  26 Pre-compiling does not imply faster execution
  27 because in Lua chunks are always compiled into bytecodes before being executed.
  28 .B luac
  29 simply allows those bytecodes to be saved in a file for later execution.
  30 .LP
  31 Pre-compiled chunks are not necessarily smaller than the corresponding source.
  32 The main goal in pre-compiling is faster loading.
  33 .LP
  34 The binary files created by
  35 .B luac
  36 are portable only among architectures with the same word size and byte order.
  37 .LP
  38 .B luac
  39 produces a single output file containing the bytecodes
  40 for all source files given.
  41 By default,
  42 the output file is named
  43 .BR luac.out ,
  44 but you can change this with the
  45 .B \-o
  46 option.
  47 .LP
  48 In the command line,
  49 you can mix
  50 text files containing Lua source and
  51 binary files containing precompiled chunks.
  52 This is useful to combine several precompiled chunks,
  53 even from different (but compatible) platforms,
  54 into a single precompiled chunk.
  55 .LP
  56 You can use
  57 .B "'\-'"
  58 to indicate the standard input as a source file
  59 and
  60 .B "'\--'"
  61 to signal the end of options
  62 (that is,
  63 all remaining arguments will be treated as files even if they start with
  64 .BR "'\-'" ).
  65 .LP
  66 The internal format of the binary files produced by
  67 .B luac
  68 is likely to change when a new version of Lua is released.
  69 So,
  70 save the source files of all Lua programs that you precompile.
  71 .LP
  72 .SH OPTIONS
  73 Options must be separate.
  74 .TP
  75 .B \-l
  76 produce a listing of the compiled bytecode for Lua's virtual machine.
  77 Listing bytecodes is useful to learn about Lua's virtual machine.
  78 If no files are given, then
  79 .B luac
  80 loads
  81 .B luac.out
  82 and lists its contents.
  83 .TP
  84 .BI \-o " file"
  85 output to
  86 .IR file ,
  87 instead of the default
  88 .BR luac.out .
  89 (You can use
  90 .B "'\-'"
  91 for standard output,
  92 but not on platforms that open standard output in text mode.)
  93 The output file may be a source file because
  94 all files are loaded before the output file is written.
  95 Be careful not to overwrite precious files.
  96 .TP
  97 .B \-p
  98 load files but do not generate any output file.
  99 Used mainly for syntax checking and for testing precompiled chunks:
 100 corrupted files will probably generate errors when loaded.
 101 Lua always performs a thorough integrity test on precompiled chunks.
 102 Bytecode that passes this test is completely safe,
 103 in the sense that it will not break the interpreter.
 104 However,
 105 there is no guarantee that such code does anything sensible.
 106 (None can be given, because the halting problem is unsolvable.)
 107 If no files are given, then
 108 .B luac
 109 loads
 110 .B luac.out
 111 and tests its contents.
 112 No messages are displayed if the file passes the integrity test.
 113 .TP
 114 .B \-s
 115 strip debug information before writing the output file.
 116 This saves some space in very large chunks,
 117 but if errors occur when running a stripped chunk,
 118 then the error messages may not contain the full information they usually do.
 119 For instance,
 120 line numbers and names of local variables are lost.
 121 .TP
 122 .B \-v
 123 show version information.
 124 .SH FILES
 125 .TP 15
 126 .B luac.out
 127 default output file
 128 .SH "SEE ALSO"
 129 .BR lua (1)
 130 .br
 131 http://www.lua.org/
 132 .SH DIAGNOSTICS
 133 Error messages should be self explanatory.
 134 .SH AUTHORS
 135 L. H. de Figueiredo,
 136 R. Ierusalimschy and
 137 W. Celes
 138 .\" EOF