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

   1 .\"     $NetBSD: lua.1,v 1.3 2015/02/02 14:03:05 lneto Exp $
   2 .\"
   3 .TH LUA 1 "Date: 2014/12/10 15:55:45 "
   4 .SH NAME
   5 lua \- Lua interpreter
   6 .SH SYNOPSIS
   7 .B lua
   8 [
   9 .I options
  10 ]
  11 [
  12 .I script
  13 [
  14 .I args
  15 ]
  16 ]
  17 .SH DESCRIPTION
  18 .B lua
  19 is the standalone Lua interpreter.
  20 It loads and executes Lua programs,
  21 either in textual source form or
  22 in precompiled binary form.
  23 (Precompiled binaries are output by
  24 .BR luac ,
  25 the Lua compiler.)
  26 .B lua
  27 can be used as a batch interpreter and also interactively.
  28 .LP
  29 The given
  30 .I options
  31 are handled in order and then
  32 the Lua program in file
  33 .I script
  34 is loaded and executed.
  35 The given
  36 .I args
  37 are available to
  38 .I script
  39 as strings in a global table named
  40 .BR arg .
  41 If no options or arguments are given,
  42 then
  43 .B "\-v \-i"
  44 is assumed when the standard input is a terminal;
  45 otherwise,
  46 .B "\-"
  47 is assumed.
  48 .LP
  49 In interactive mode,
  50 .B lua
  51 prompts the user,
  52 reads lines from the standard input,
  53 and executes them as they are read.
  54 If the line contains an expression or list of expressions,
  55 then the line is evaluated and the results are printed.
  56 If a line does not contain a complete statement,
  57 then a secondary prompt is displayed and
  58 lines are read until a complete statement is formed or
  59 a syntax error is found.
  60 .LP
  61 At the very start,
  62 before even handling the command line,
  63 .B lua
  64 checks the contents of the environment variables
  65 .B LUA_INIT_5_3
  66 or
  67 .BR LUA_INIT ,
  68 in that order.
  69 If the contents is of the form
  70 .RI '@ filename ',
  71 then
  72 .I filename
  73 is executed.
  74 Otherwise, the string is assumed to be a Lua statement and is executed.
  75 .SH OPTIONS
  76 .TP
  77 .BI \-e " stat"
  78 execute statement
  79 .IR stat .
  80 .TP
  81 .B \-i
  82 enter interactive mode after executing
  83 .IR script .
  84 .TP
  85 .BI \-l " name"
  86 execute the equivalent of
  87 .IB name =require(' name ')
  88 before executing
  89 .IR script .
  90 .TP
  91 .B \-v
  92 show version information.
  93 .TP
  94 .B \-E
  95 ignore environment variables.
  96 .TP
  97 .B \-\-
  98 stop handling options.
  99 .TP
 100 .B \-
 101 stop handling options and execute the standard input as a file.
 102 .SH "SEE ALSO"
 103 .BR luac (1)
 104 .br
 105 The documentation at lua.org,
 106 especially section 7 of the reference manual.
 107 .SH DIAGNOSTICS
 108 Error messages should be self explanatory.
 109 .SH AUTHORS
 110 R. Ierusalimschy,
 111 L. H. de Figueiredo,
 112 W. Celes
 113 .\" EOF