Cleanup various endianess issues in assembler backend.
[luajit-2.0.git] / etc / luajit.1
blob57080bceef4e981be8685e522667461ec8765a91
1 .TH luajit 1 "" "" "LuaJIT documentation"
2 .SH NAME
3 luajit \- Just-In-Time Compiler for the Lua Language
4 \fB
5 .SH SYNOPSIS
6 .B luajit
7 [\fIoptions\fR]... [\fIscript\fR [\fIargs\fR]...]
8 .SH "WEB SITE"
9 .IR http://luajit.org
10 .SH DESCRIPTION
11 .PP
12 This is the command-line program to run Lua programs with \fBLuaJIT\fR.
13 .PP
14 \fBLuaJIT\fR is a just-in-time (JIT) compiler for the Lua language.
15 The virtual machine (VM) is based on a fast interpreter combined with
16 a trace compiler. It can significantly improve the performance of Lua programs.
17 .PP
18 \fBLuaJIT\fR is API\- and ABI-compatible with the VM of the standard
19 Lua\ 5.1 interpreter. When embedding the VM into an application,
20 the built library can be used as a drop-in replacement.
21 .SH OPTIONS
22 .TP
23 .BI "\-e " chunk
24 Run the given chunk of Lua code.
25 .TP
26 .BI "\-l " library
27 Load the named library, just like \fBrequire("\fR\fIlibrary\fR\fB")\fR.
28 .TP
29 .BI "\-b " ...
30 Save or list bytecode. Run without arguments to get help on options.
31 .TP
32 .BI "\-j " command
33 Perform LuaJIT control command (optional space after \fB\-j\fR).
34 .TP
35 .BI "\-O" [opt]
36 Control LuaJIT optimizations.
37 .TP
38 .B "\-i"
39 Run in interactive mode.
40 .TP
41 .B "\-v"
42 Show \fBLuaJIT\fR version.
43 .TP
44 .B "\-\-"
45 Stop processing options.
46 .TP
47 .B "\-"
48 Read script from stdin instead.
49 .PP
50 After all options are processed, the given \fIscript\fR is run.
51 The arguments are passed in the global \fIarg\fR table.
52 .PP
53 Interactive mode is only entered, if no \fIscript\fR and no \fB\-e\fR
54 option is given. Interactive mode can be left with EOF (\fICtrl\-Z\fB).
55 .SH EXAMPLES
56 .TP
57 luajit hello.lua world
59 Prints "Hello world", assuming \fIhello.lua\fR contains:
60 .br
61   print("Hello", arg[1])
62 .TP
63 luajit \-e "local x=0; for i=1,1e9 do x=x+i end; print(x)"
65 Calculates the sum of the numbers from 1 to 1000000000.
66 .br
67 And finishes in a reasonable amount of time, too.
68 .TP
69 luajit \-jv \-e "for i=1,10 do for j=1,10 do for k=1,100 do end end end"
71 Runs some nested loops and shows the resulting traces.
72 .SH COPYRIGHT
73 .PP
74 \fBLuaJIT\fR is Copyright \(co 2005-2011 Mike Pall.
75 .br
76 \fBLuaJIT\fR is open source software, released under the MIT license.
77 .SH SEE ALSO
78 .PP
79 More details in the provided HTML docs or at:
80 .IR http://luajit.org
81 .br
82 More about the Lua language can be found at:
83 .IR http://lua.org/docs.html
84 .PP
85 lua(1)