diff options
Diffstat (limited to '3rdparty/lua/doc/readme.html')
-rw-r--r-- | 3rdparty/lua/doc/readme.html | 152 |
1 files changed, 63 insertions, 89 deletions
diff --git a/3rdparty/lua/doc/readme.html b/3rdparty/lua/doc/readme.html index 96a9386e2af..3bcefadfe9a 100644 --- a/3rdparty/lua/doc/readme.html +++ b/3rdparty/lua/doc/readme.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML> <HEAD> -<TITLE>Lua 5.3 readme</TITLE> +<TITLE>Lua 5.4 readme</TITLE> <LINK REL="stylesheet" TYPE="text/css" HREF="lua.css"> <META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1"> <STYLE TYPE="text/css"> @@ -29,8 +29,8 @@ tt, kbd, code { <BODY> <H1> -<A HREF="http://www.lua.org/"><IMG SRC="logo.gif" ALT="Lua"></A> -Welcome to Lua 5.3 +<A HREF="https://www.lua.org/"><IMG SRC="logo.gif" ALT="Lua"></A> +Welcome to Lua 5.4 </H1> <DIV CLASS="menubar"> @@ -47,29 +47,33 @@ Welcome to Lua 5.3 <H2><A NAME="about">About Lua</A></H2> <P> -Lua is a powerful, fast, lightweight, embeddable scripting language +Lua is a powerful, efficient, lightweight, embeddable scripting language developed by a -<A HREF="http://www.lua.org/authors.html">team</A> +<A HREF="https://www.lua.org/authors.html">team</A> at -<A HREF="http://www.puc-rio.br/">PUC-Rio</A>, +<A HREF="https://www.puc-rio.br/">PUC-Rio</A>, the Pontifical Catholic University of Rio de Janeiro in Brazil. Lua is <A HREF="#license">free software</A> -used in many products and projects around the world. +used in +<A HREF="https://www.lua.org/uses.html">many products and projects</A> +around the world. <P> Lua's -<A HREF="http://www.lua.org/">official web site</A> +<A HREF="https://www.lua.org/">official website</A> provides complete information about Lua, including an -<A HREF="http://www.lua.org/about.html">executive summary</A> +<A HREF="https://www.lua.org/about.html">executive summary</A>, +tips on +<A HREF="https://www.lua.org/start.html">getting started</A>, and updated -<A HREF="http://www.lua.org/docs.html">documentation</A>, +<A HREF="https://www.lua.org/docs.html">documentation</A>, especially the -<A HREF="http://www.lua.org/manual/5.3/">reference manual</A>, +<A HREF="https://www.lua.org/manual/5.4/">reference manual</A>, which may differ slightly from the <A HREF="contents.html">local copy</A> distributed in this package. @@ -77,7 +81,7 @@ distributed in this package. <H2><A NAME="install">Installing Lua</A></H2> <P> Lua is distributed in -<A HREF="http://www.lua.org/ftp/">source</A> +<A HREF="https://www.lua.org/ftp/">source</A> form. You need to build it before using it. Building Lua should be straightforward @@ -85,7 +89,8 @@ because Lua is implemented in pure ANSI C and compiles unmodified in all known platforms that have an ANSI C compiler. Lua also compiles unmodified as C++. -The instructions given below for building Lua are for Unix-like platforms. +The instructions given below for building Lua are for Unix-like platforms, +such as Linux and macOS. See also <A HREF="#other">instructions for other systems</A> and @@ -94,28 +99,28 @@ and <P> If you don't have the time or the inclination to compile Lua yourself, get a binary from -<A HREF="http://lua-users.org/wiki/LuaBinaries">LuaBinaries</A>. -Try also -<A HREF="http://luadist.org/">LuaDist</A>, -a multi-platform distribution of Lua that includes batteries. +<A HREF="https://luabinaries.sourceforge.net">LuaBinaries</A>. <H3>Building Lua</H3> <P> -In most Unix-like platforms, simply do "<KBD>make</KBD>" with a suitable target. +In most common Unix-like platforms, simply do "<KBD>make</KBD>". Here are the details. <OL> <LI> Open a terminal window and move to -the top-level directory, which is named <TT>lua-5.3.x</TT>. +the top-level directory, which is named <TT>lua-5.4.7</TT>. The <TT>Makefile</TT> there controls both the build process and the installation process. <P> <LI> - Do "<KBD>make</KBD>" and see if your platform is listed. + Do "<KBD>make</KBD>". The <TT>Makefile</TT> will guess your platform and build Lua for it. +<P> +<LI> + If the guess failed, do "<KBD>make help</KBD>" and see if your platform is listed. The platforms currently supported are: <P> <P CLASS="display"> - aix bsd c89 freebsd generic linux macosx mingw posix solaris + guess aix bsd c89 freebsd generic ios linux linux-readline macosx mingw posix solaris </P> <P> If your platform is listed, just do "<KBD>make xxx</KBD>", where xxx @@ -136,25 +141,27 @@ and liblua.a (the library). after building Lua. This will run the interpreter and print its version. </OL> <P> -If you're running Linux and get compilation errors, +If you're running Linux, try "<KBD>make linux-readline</KBD>" to build the interactive Lua interpreter with handy line-editing and history capabilities. +If you get compilation errors, make sure you have installed the <TT>readline</TT> development package (which is probably named <TT>libreadline-dev</TT> or <TT>readline-devel</TT>). If you get link errors after that, -then try "<KBD>make linux MYLIBS=-ltermcap</KBD>". +then try "<KBD>make linux-readline MYLIBS=-ltermcap</KBD>". <H3>Installing Lua</H3> <P> Once you have built Lua, you may want to install it in an official place in your system. In this case, do "<KBD>make install</KBD>". The official place and the way to install files are defined in the <TT>Makefile</TT>. You'll - probably need the right permissions to install files. + probably need the right permissions to install files, and so may need to do "<KBD>sudo make install</KBD>". <P> - To build and install Lua in one step, do "<KBD>make xxx install</KBD>", + To build and install Lua in one step, do "<KBD>make all install</KBD>", + or "<KBD>make xxx install</KBD>", where xxx is your platform name. <P> - To install Lua locally, do "<KBD>make local</KBD>". + To install Lua locally after building it, do "<KBD>make local</KBD>". This will create a directory <TT>install</TT> with subdirectories <TT>bin</TT>, <TT>include</TT>, <TT>lib</TT>, <TT>man</TT>, <TT>share</TT>, and install Lua as listed below. @@ -206,8 +213,8 @@ then try "<KBD>make linux MYLIBS=-ltermcap</KBD>". record the changes you've made. <P> - On the other hand, if you need to customize some Lua features, you'll need - to edit <TT>src/luaconf.h</TT> before building and installing Lua. + On the other hand, if you need to customize some Lua features, + edit <TT>src/luaconf.h</TT> before building and installing Lua. The edited file will be the one installed, and it will be used by any Lua clients that you build, to ensure consistency. Further customization is available to experts by editing the Lua sources. @@ -223,11 +230,8 @@ then try "<KBD>make linux MYLIBS=-ltermcap</KBD>". <DT> library: <DD> -lapi.c lcode.c lctype.c ldebug.c ldo.c ldump.c lfunc.c lgc.c llex.c -lmem.c lobject.c lopcodes.c lparser.c lstate.c lstring.c ltable.c -ltm.c lundump.c lvm.c lzio.c -lauxlib.c lbaselib.c lbitlib.c lcorolib.c ldblib.c liolib.c -lmathlib.c loslib.c lstrlib.c ltablib.c lutf8lib.c loadlib.c linit.c +lapi.c lcode.c lctype.c ldebug.c ldo.c ldump.c lfunc.c lgc.c llex.c lmem.c lobject.c lopcodes.c lparser.c lstate.c lstring.c ltable.c ltm.c lundump.c lvm.c lzio.c +lauxlib.c lbaselib.c lcorolib.c ldblib.c liolib.c lmathlib.c loadlib.c loslib.c lstrlib.c ltablib.c lutf8lib.c linit.c <DT> interpreter: <DD> @@ -239,9 +243,9 @@ compiler: </DL> <P> - To use Lua as a library in your own programs you'll need to know how to + To use Lua as a library in your own programs, you need to know how to create and use libraries with your compiler. Moreover, to dynamically load - C libraries for Lua you'll need to know how to create dynamic libraries + C libraries for Lua, you'll need to know how to create dynamic libraries and you'll need to make sure that the Lua API functions are accessible to those dynamic libraries — but <EM>don't</EM> link the Lua library into each dynamic library. For Unix, we recommend that the Lua library @@ -254,9 +258,9 @@ compiler: As mentioned above, you may edit <TT>src/luaconf.h</TT> to customize some features before building Lua. -<H2><A NAME="changes">Changes since Lua 5.2</A></H2> +<H2><A NAME="changes">Changes since Lua 5.3</A></H2> <P> -Here are the main changes introduced in Lua 5.3. +Here are the main changes introduced in Lua 5.4. The <A HREF="contents.html">reference manual</A> lists the @@ -264,59 +268,29 @@ lists the <H3>Main changes</H3> <UL> -<LI> integers (64-bit by default) -<LI> official support for 32-bit numbers -<LI> bitwise operators -<LI> basic utf-8 support -<LI> functions for packing and unpacking values - -</UL> - -Here are the other changes introduced in Lua 5.3: -<H3>Language</H3> -<UL> -<LI> userdata can have any Lua value as uservalue -<LI> floor division -<LI> more flexible rules for some metamethods -</UL> - -<H3>Libraries</H3> -<UL> -<LI> <CODE>ipairs</CODE> and the table library respect metamethods -<LI> strip option in <CODE>string.dump</CODE> -<LI> table library respects metamethods -<LI> new function <CODE>table.move</CODE> -<LI> new function <CODE>string.pack</CODE> -<LI> new function <CODE>string.unpack</CODE> -<LI> new function <CODE>string.packsize</CODE> -</UL> - -<H3>C API</H3> -<UL> -<LI> simpler API for continuation functions in C -<LI> <CODE>lua_gettable</CODE> and similar functions return type of resulted value -<LI> strip option in <CODE>lua_dump</CODE> -<LI> new function: <CODE>lua_geti</CODE> -<LI> new function: <CODE>lua_seti</CODE> -<LI> new function: <CODE>lua_isyieldable</CODE> -<LI> new function: <CODE>lua_numbertointeger</CODE> -<LI> new function: <CODE>lua_rotate</CODE> -<LI> new function: <CODE>lua_stringtonumber</CODE> -</UL> - -<H3>Lua standalone interpreter</H3> -<UL> -<LI> can be used as calculator; no need to prefix with '=' -<LI> <CODE>arg</CODE> table available to all code +<LI> new generational mode for garbage collection +<LI> to-be-closed variables +<LI> const variables +<LI> userdata can have multiple user values +<LI> new implementation for math.random +<LI> warning system +<LI> debug information about function arguments and returns +<LI> new semantics for the integer 'for' loop +<LI> optional 'init' argument to 'string.gmatch' +<LI> new functions 'lua_resetthread' and 'coroutine.close' +<LI> string-to-number coercions moved to the string library +<LI> allocation function allowed to fail when shrinking a memory block +<LI> new format '%p' in 'string.format' +<LI> utf8 library accepts codepoints up to 2^31 </UL> <H2><A NAME="license">License</A></H2> <P> -<A HREF="http://www.opensource.org/docs/definition.php"> -<IMG SRC="osi-certified-72x60.png" ALIGN="right" ALT="[osi certified]" STYLE="padding-left: 30px ;"> +<A HREF="https://opensource.org/osd"> +<IMG SRC="OSIApproved_100X125.png" ALIGN="right" ALT="[Open Source Initiative Approved License]" STYLE="padding-left: 1em" WIDTH=50> </A> Lua is free software distributed under the terms of the -<A HREF="http://www.opensource.org/licenses/mit-license.html">MIT license</A> +<A HREF="https://opensource.org/license/mit">MIT license</A> reproduced below; it may be used for any purpose, including commercial purposes, at absolutely no cost without having to ask us. @@ -324,11 +298,11 @@ at absolutely no cost without having to ask us. The only requirement is that if you do use Lua, then you should give us credit by including the appropriate copyright notice somewhere in your product or its documentation. -For details, see -<A HREF="http://www.lua.org/license.html">this</A>. +For details, see the +<A HREF="https://www.lua.org/license.html">license page</A>. <BLOCKQUOTE STYLE="padding-bottom: 0em"> -Copyright © 1994–2017 Lua.org, PUC-Rio. +Copyright © 1994–2024 Lua.org, PUC-Rio. <P> Permission is hereby granted, free of charge, to any person obtaining a copy @@ -355,10 +329,10 @@ THE SOFTWARE. <P CLASS="footer"> Last update: -Thu Dec 22 18:22:57 BRST 2016 +Wed May 8 21:56:16 UTC 2024 </P> <!-- -Last change: revised for Lua 5.3.4 +Last change: revised for Lua 5.4.7 --> </BODY> |