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

   1 .\"     $NetBSD: luac.1,v 1.2 2014/07/19 18:38:33 lneto Exp $
   2 .\"
   3 .\" $Id: luac.1,v 1.2 2014/07/19 18:38:33 lneto Exp $
   4 .TH LUAC 1 "$Date: 2014/07/19 18:38:33 $"
   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 containing precompiled chunks
  19 that can be later loaded and executed.
  20 .LP
  21 The main advantages of precompiling chunks are:
  22 faster loading,
  23 protecting source code from accidental user changes,
  24 and
  25 off-line syntax checking.
  26 Precompiling 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 Precompiled chunks are not necessarily smaller than the corresponding source.
  31 The main goal in precompiling is faster loading.
  32 .LP
  33 In the command line,
  34 you can mix
  35 text files containing Lua source and
  36 binary files containing precompiled chunks.
  37 .B luac
  38 produces a single output file containing the combined bytecodes
  39 for all files given.
  40 Executing the combined file is equivalent to executing the given files.
  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 Precompiled chunks are
  49 .I not
  50 portable across different architectures.
  51 Moreover,
  52 the internal format of precompiled chunks
  53 is likely to change when a new version of Lua is released.
  54 Make sure you save the source files of all Lua programs that you precompile.
  55 .LP
  56 .SH OPTIONS
  57 .TP
  58 .B \-l
  59 produce a listing of the compiled bytecode for Lua's virtual machine.
  60 Listing bytecodes is useful to learn about Lua's virtual machine.
  61 If no files are given, then
  62 .B luac
  63 loads
  64 .B luac.out
  65 and lists its contents.
  66 Use
  67 .B \-l \-l
  68 for a full listing.
  69 .TP
  70 .BI \-o " file"
  71 output to
  72 .IR file ,
  73 instead of the default
  74 .BR luac.out .
  75 (You can use
  76 .B "'\-'"
  77 for standard output,
  78 but not on platforms that open standard output in text mode.)
  79 The output file may be one of the given files because
  80 all files are loaded before the output file is written.
  81 Be careful not to overwrite precious files.
  82 .TP
  83 .B \-p
  84 load files but do not generate any output file.
  85 Used mainly for syntax checking and for testing precompiled chunks:
  86 corrupted files will probably generate errors when loaded.
  87 If no files are given, then
  88 .B luac
  89 loads
  90 .B luac.out
  91 and tests its contents.
  92 No messages are displayed if the file loads without errors.
  93 .TP
  94 .B \-s
  95 strip debug information before writing the output file.
  96 This saves some space in very large chunks,
  97 but if errors occur when running a stripped chunk,
  98 then the error messages may not contain the full information they usually do.
  99 In particular,
 100 line numbers and names of local variables are lost.
 101 .TP
 102 .B \-v
 103 show version information.
 104 .TP
 105 .B \-\-
 106 stop handling options.
 107 .TP
 108 .B \-
 109 stop handling options and process standard input.
 110 .SH "SEE ALSO"
 111 .BR lua (1)
 112 .br
 113 The documentation at lua.org.
 114 .SH DIAGNOSTICS
 115 Error messages should be self explanatory.
 116 .SH AUTHORS
 117 R. Ierusalimschy,
 118 L. H. de Figueiredo,
 119 W. Celes
 120 .\" EOF