commit b7817ecea7378269d1302883d3b11f8b268527c1 from: Sergey Bronnikov date: Wed Jul 27 08:12:14 2022 UTC man3: add SEE ALSO sections commit - cf6807f3e9090928ccb387cf810c83f590c4841e commit + b7817ecea7378269d1302883d3b11f8b268527c1 blob - 47a2b4aa7659e0e616f052069fac4110af35d9de blob + cabc39b52102d0df14d3d088fd77fc49a5fbd018 --- CHANGELOG.md +++ CHANGELOG.md @@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http ### Added +- Add SEE ALSO sections with a reference to Lua 5.1 Reference Manual and cross + references to another manual pages. + ### Changed ### Fixed blob - db6bea646edfd2af59836c6a785878ebd48b0f43 blob + 3e5693ee3e83da58c32f8a75d5eaf8a232b8891f --- man3/luaL_Buffer.3 +++ man3/luaL_Buffer.3 @@ -44,6 +44,14 @@ After calling .Xr luaL_pushresult 3 the stack is back to its level when the buffer was initialized, plus the final string on its top. +.Sh SEE ALSO +.Xr luaL_pushresult 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_Buffer blob - 74b1dddad712b135a01b6bdb1bf0e648c74c2603 blob + 897bbc03baf4317e98657d69045f318301cb841c --- man3/luaL_Reg.3 +++ man3/luaL_Reg.3 @@ -32,6 +32,14 @@ and .Fa func are .Dv NULL . +.Sh SEE ALSO +.Xr luaL_register 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_Reg blob - 1ffc81544af516eeb9d2d7daf8e466f8c6aaafc5 blob + 93849f6b1a297eeb67367767207afb57541ef81c --- man3/luaL_addchar.3 +++ man3/luaL_addchar.3 @@ -15,6 +15,14 @@ adds the character to the buffer .Fa B .Pq see Xr luaL_Buffer 3 . +.Sh SEE ALSO +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_addchar blob - e2dbf00826733d3f1702340139b45c71a2da45ff blob + e597b34172f84781b9731650969afca6dae68a8c --- man3/luaL_addlstring.3 +++ man3/luaL_addlstring.3 @@ -18,6 +18,14 @@ to the buffer .Fa B .Pq see Xr luaL_Buffer 3 . The string may contain embedded zeros. +.Sh SEE ALSO +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_addlstring blob - f595f5e40db9d90428df334d125d60732b8e3de7 blob + e41a091b9088be7f6861cdb2ff34f1f1b344e1ee --- man3/luaL_addsize.3 +++ man3/luaL_addsize.3 @@ -17,6 +17,15 @@ a string of length .Fa n previously copied to the buffer area .Pq see Xr luaL_prepbuffer 3 . +.Sh SEE ALSO +.Xr luaL_Buffer 3 , +.Xr luaL_prepbuffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_addsize blob - 43f5cee75c5eae62b1fc56f6221350094f503f81 blob + 999c71a4ff688239b5e2f2ffcfa8b9688f840e16 --- man3/luaL_addstring.3 +++ man3/luaL_addstring.3 @@ -16,6 +16,14 @@ to the buffer .Fa B .Pq see Xr luaL_Buffer 3 . The string may not contain embedded zeros. +.Sh SEE ALSO +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_addstring blob - 91b5d1021153a251dd003caf377fc36129b90613 blob + 0b040d22da499660d0ebcf182e4c2ec6637f1488 --- man3/luaL_addvalue.3 +++ man3/luaL_addvalue.3 @@ -17,6 +17,14 @@ Pops the value. .Pp This is the only function on string buffers that can (and must) be called with an extra element on the stack, which is the value to be added to the buffer. +.Sh SEE ALSO +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_addvalue blob - c722ffa7264d2b328677852b720e434fa3a4cc4d blob + 4237c99f0e4a9fe0cfd061d68e79ccb996c0c1b3 --- man3/luaL_argcheck.3 +++ man3/luaL_argcheck.3 @@ -17,6 +17,13 @@ from the call stack: .Bd -literal -offset indent -compact bad argument # to () .Ed +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_argcheck blob - eaff0849a3788271fd1e811ae96b74277315381c blob + 6a6d8dfaf27a71437d4c6e19f12d9d4e70bce3ce --- man3/luaL_argerror.3 +++ man3/luaL_argerror.3 @@ -20,6 +20,13 @@ bad argument # to () This function never returns, but it is an idiom to use it in C functions as return .Em luaL_argerror(args) . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_argerror blob - 09446340f4d84a4ae9e8e8d08eafa3e636ad3ae6 blob + edbd16164471105d89735185ce4e36b2c84a223c --- man3/luaL_buffinit.3 +++ man3/luaL_buffinit.3 @@ -15,6 +15,14 @@ initializes a buffer This function does not allocate any space; the buffer must be declared as a variable .Pq see Xr luaL_Buffer 3 . +.Sh SEE ALSO +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_buffinit blob - 3c52a11398ae086542afbe1d19860f4e1d307436 blob + 6f661e2c62cb88dab44e0e451263c1ec031048f6 --- man3/luaL_callmeta.3 +++ man3/luaL_callmeta.3 @@ -19,6 +19,13 @@ In this case this function returns 1 and pushes onto t returned by the call. If there is no metatable or no metamethod, this function returns 0 (without pushing any value on the stack). +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_callmeta blob - 988e400d5cc6ef6b4e800b332a150e01609fbb04 blob + 8dffc35c8ded7799950a875178745fe13fe301c3 --- man3/luaL_checkany.3 +++ man3/luaL_checkany.3 @@ -15,6 +15,13 @@ checks whether the function has an argument of any typ at position .Fa narg . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkany blob - b7523cbb90822dfd3ffa5761a76d9eca083932c7 blob + 6a4b9afed8048024cda5dabb44c3dd8973f2be75 --- man3/luaL_checkint.3 +++ man3/luaL_checkint.3 @@ -14,6 +14,13 @@ checks whether the function argument .Fa narg is a number and returns this number cast to an .Em int . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkint blob - 6cbf3ec84e4ec8a90b72d86abd117f412077b89e blob + 21ad45eaf7affaf7cc0806a54b0bcc5cd624fe8d --- man3/luaL_checkinteger.3 +++ man3/luaL_checkinteger.3 @@ -15,6 +15,14 @@ checks whether the function argument is a number and returns this number cast to a .Xr lua_Integer 3 . +.Sh SEE ALSO +.Xr lua_Integer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkinteger blob - 8350e5cb48f17d817462516c16789efe0a9ca78b blob + 0b4cd7fdb194052e0bc4968fc8677964863c5ae3 --- man3/luaL_checklong.3 +++ man3/luaL_checklong.3 @@ -13,6 +13,13 @@ checks whether the function argument .Fa narg is a number and returns this number cast to a long. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checklong blob - 6da8f692662971a1918837918ebe214b8e1df0b6 blob + 5040092fc3021cb4385b83d151d92fa712590607 --- man3/luaL_checklstring.3 +++ man3/luaL_checklstring.3 @@ -22,6 +22,14 @@ with the string's length. This function uses .Xr lua_tolstring 3 to get its result, so all conversions and caveats of that function apply here. +.Sh SEE ALSO +.Xr lua_tolstring 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checklstring blob - 8e4c1a6e9fb9e6f15cf68d0f0c1b8ac46bdf232e blob + c25a3bb23182870b17535b0ba9106cc7233ac572 --- man3/luaL_checknumber.3 +++ man3/luaL_checknumber.3 @@ -14,6 +14,13 @@ number checks whether the function argument .Fa narg is a number and returns this number. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checknumber blob - e5ecfd0d971174723a3764a7595f5ae3ba02079a blob + f4bacdc50c14d2ba6011396b7f2c8d686b60881b --- man3/luaL_checkoption.3 +++ man3/luaL_checkoption.3 @@ -32,6 +32,13 @@ or if this argument is .Pp This is a useful function for mapping strings to C enums. (The usual convention in Lua libraries is to use strings instead of numbers to select options). +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkoption blob - 1a2a547ecb6771aa302154e3edbf659a9868129a blob + 14a16717d0886d773176b590d7cd7e52e2ccba3e --- man3/luaL_checkstack.3 +++ man3/luaL_checkstack.3 @@ -15,6 +15,13 @@ grows the stack size to elements, raising an error if the stack cannot grow to that size. .Fa msg is an additional text to go into the error message. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkstack blob - 3855c0d91859df124efb5d22ad8913896d71f8be blob + c413017352dab90d3c127838eabee19e02792f4d --- man3/luaL_checkstring.3 +++ man3/luaL_checkstring.3 @@ -17,6 +17,14 @@ is a string and returns this string. This function uses .Xr lua_tolstring 3 to get its result, so all conversions and caveats of that function apply here. +.Sh SEE ALSO +.Xr lua_tolstring 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkstring blob - ed603b7ecbb41888c7578ef70ee8a31fdc31d712 blob + 9c67b486ecdf37842e7523227ed87fe965e50224 --- man3/luaL_checktype.3 +++ man3/luaL_checktype.3 @@ -18,6 +18,14 @@ See .Xr lua_type 3 for the encoding of types for .Fa t . +.Sh SEE ALSO +.Xr lua_type 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checktype blob - 68b3e7e04dabf08e70ef4d06653c56c77c55ca4a blob + 057fc8cf7183dfdace357e99c981e4d1e294d023 --- man3/luaL_checkudata.3 +++ man3/luaL_checkudata.3 @@ -15,6 +15,14 @@ checks whether the function argument is a userdata of the type .Fa tname .Pq see Xr luaL_newmetatable 3 . +.Sh SEE ALSO +.Xr luaL_newmetatable 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_checkudata blob - 503648a2c74e51e4695a8896e8c9b3c26e9755f1 blob + 4f3d888dcf60d40b31dd63c33d1fc7b45f270046 --- man3/luaL_dofile.3 +++ man3/luaL_dofile.3 @@ -18,6 +18,13 @@ It is defined as the following macro: .Ed .Sh RETURN VALUES It returns 0 if there are no errors or 1 in case of errors. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_dofile blob - 7b40fbdc9de031f5b7773cb21cf3c98effd870fb blob + a42e449490730d4cf134d80b84522c32939aee6f --- man3/luaL_dostring.3 +++ man3/luaL_dostring.3 @@ -18,6 +18,13 @@ It is defined as the following macro: .Ed .Sh RETURN VALUES It returns 0 if there are no errors or 1 in case of errors. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_dostring blob - 56560dcd077699b10e4125c87325d8b1095fd582 blob + a8d6235b348bc25c6d45df76f00c3b66133fcb79 --- man3/luaL_error.3 +++ man3/luaL_error.3 @@ -21,6 +21,14 @@ where the error occurred, if this information is avail This function never returns, but it is an idiom to use it in C functions as return .Em luaL_error(args) . +.Sh SEE ALSO +.Xr lua_pushfstring 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_error blob - 72a0beb95bd92ee530b5b0ebd71aa88e8d352b39 blob + c53f356115705ea4e6c90c91ce52eb71223806cb --- man3/luaL_getmetafield.3 +++ man3/luaL_getmetafield.3 @@ -17,6 +17,13 @@ from the metatable of the object at index .Fa obj . If the object does not have a metatable, or if the metatable does not have this field, returns 0 and pushes nothing. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_getmetafield blob - 9377c209db9e5816711fa8c7a44216992ff74bd7 blob + 103a59f5e876f010ad13aead7f6f9790ec8a474c --- man3/luaL_getmetatable.3 +++ man3/luaL_getmetatable.3 @@ -14,6 +14,14 @@ pushes onto the stack the metatable associated with na .Fa tname in the registry .Pq see Xr luaL_newmetatable 3 . +.Sh SEE ALSO +.Xr luaL_newmetatable 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_getmetatable blob - 5645465edd2422ebca81c363538a1a86769fcdff blob + 32eca7f10c0dbc5503f285efd1b55029339b8794 --- man3/luaL_gsub.3 +++ man3/luaL_gsub.3 @@ -18,6 +18,13 @@ by replacing any occurrence of the string with the string .Fa r . Pushes the resulting string on the stack and returns it. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_gsub blob - 08b719c6aad4c12d79bd0286d604b7ea7ac5a461 blob + b7a0c452619f8f6586c76ccf5fc603c1feec6556 --- man3/luaL_loadbuffer.3 +++ man3/luaL_loadbuffer.3 @@ -23,6 +23,14 @@ This function returns the same results as .Fa name is the chunk name, used for debug information and error messages. +.Sh SEE ALSO +.Xr lua_load 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_loadbuffer blob - 25872e5f6ba44116c63133c5019c6871cfd25428 blob + 8255ed36136fba727ed9ba81caf358f7a973cb5e --- man3/luaL_loadfile.3 +++ man3/luaL_loadfile.3 @@ -30,6 +30,14 @@ This function returns the same results as but it has an extra error code .Dv LUA_ERRFILE if it cannot open/read the file. +.Sh SEE ALSO +.Xr lua_load 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_loadfile blob - c25a9ecd984c0e091bac4c015fd5d2d019e78947 blob + ff451dc263329b5b5604ea25727256173bc2d4b8 --- man3/luaL_loadstring.3 +++ man3/luaL_loadstring.3 @@ -22,6 +22,14 @@ This function returns the same results as Also as .Xr lua_load 3 , this function only loads the chunk; it does not run it. +.Sh SEE ALSO +.Xr lua_load 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_loadstring blob - 37e93831f9b7f5cb5cdfdbdf7764c030e93f5464 blob + 330549d7d024faae9a1e9640f6069ff8ae9029fa --- man3/luaL_newmetatable.3 +++ man3/luaL_newmetatable.3 @@ -20,6 +20,13 @@ and returns 1. In both cases pushes onto the stack the final value associated with .Fa tname in the registry. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_newmetatable blob - 4dd1f466285d90fc1b8c24a8ad492d6b19064bf0 blob + 04a3b3c9937587cb228bef85d67176283795616c --- man3/luaL_newstate.3 +++ man3/luaL_newstate.3 @@ -23,6 +23,15 @@ errors. Returns the new state, or .Dv NULL if there is a memory allocation error. +.Sh SEE ALSO +.Xr lua_atpanic 3 , +.Xr lua_newstate 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_newstate blob - d33b6507c92fb79e8fc46c80ad311f7da914bf3d blob + 1704cc31862ac1d8fbacfa41f77b98e144a47727 --- man3/luaL_openlibs.3 +++ man3/luaL_openlibs.3 @@ -11,6 +11,13 @@ .Sh DESCRIPTION .Fn luaL_openlibs opens all standard Lua libraries into the given state. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_openlibs blob - e3a303e86db5d1ca1eb47d29fdc56fe425087014 blob + 7c1e60aeb970394fb04aad723c05e2e6f3a90b86 --- man3/luaL_optint.3 +++ man3/luaL_optint.3 @@ -18,6 +18,13 @@ If this argument is absent or is returns .Fa d . Otherwise, raises an error. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optint blob - 87c20171097b59215ec79930df3cf9e02b5211f0 blob + 483cedaf7adfbea6b1f47f8ba73c6f768c2f478d --- man3/luaL_optinteger.3 +++ man3/luaL_optinteger.3 @@ -19,6 +19,14 @@ If this argument is absent or is returns .Fa d . Otherwise, raises an error. +.Sh SEE ALSO +.Xr lua_Integer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optinteger blob - db07bde3d256f87c0004a2345e83dd24ada35cac blob + 9b21ea94bd1d19a5962f05af1de252b84fee97da --- man3/luaL_optlong.3 +++ man3/luaL_optlong.3 @@ -16,6 +16,13 @@ If this argument is absent or is returns .Fa d . Otherwise, raises an error. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optlong blob - a9c62f981528064f2ce04b0f7962736cb46c4275 blob + b997fc0b2c84a399571b89acff33665f562097a8 --- man3/luaL_optlstring.3 +++ man3/luaL_optlstring.3 @@ -26,6 +26,13 @@ is not fills the position .Fa *l with the results's length. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optlstring blob - 6f0fcd0acfa5b8b041be991d75b4ee1c2a3ab7d9 blob + 1842cb75421391d1bd018fef7e5d8f251791de94 --- man3/luaL_optnumber.3 +++ man3/luaL_optnumber.3 @@ -18,6 +18,13 @@ If this argument is absent or is returns .Fa d . Otherwise, raises an error. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optnumber blob - a30097ce13b4899a82aa67d13f39be57af76df32 blob + 6b77d185adf263527ad5c5222e722accf29960d6 --- man3/luaL_optstring.3 +++ man3/luaL_optstring.3 @@ -18,6 +18,13 @@ If this argument is absent or is returns .Fa d . Otherwise, raises an error. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_optstring blob - 83f7c37ef8f65e83586617810df5b173b67e394e blob + 869dbeb92516ab51cc1ef574e0f0792ea1e109b8 --- man3/luaL_prepbuffer.3 +++ man3/luaL_prepbuffer.3 @@ -19,6 +19,15 @@ string to be added to buffer After copying the string into this space you must call .Xr luaL_addsize 3 with the size of the string to actually add it to the buffer. +.Sh SEE ALSO +.Xr luaL_addsize 3 , +.Xr luaL_Buffer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_prepbuffer blob - e17e502b05fbaf4a92c09a74a57d0383cc781765 blob + e656ecf49c77a5b394ebbd8a4e5a96615d0610a7 --- man3/luaL_pushresult.3 +++ man3/luaL_pushresult.3 @@ -13,6 +13,13 @@ finishes the use of buffer .Fa B leaving the final string on the top of the stack. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_pushresult blob - f81b09979c21654c606d30053dc3748d7b53728e blob + c87a17a20bf74d82738832058953584c9b2e983e --- man3/luaL_ref.3 +++ man3/luaL_ref.3 @@ -36,6 +36,14 @@ The constant .Dv LUA_NOREF is guaranteed to be different from any reference returned by .Nm luaL_ref . +.Sh SEE ALSO +.Xr luaL_unref 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_ref blob - b2759892e2d03cd53546f73f45662ac6fc1b9129 blob + a9f1855b08c8bd5c5144e5c7d21ab96c2ea56ad5 --- man3/luaL_register.3 +++ man3/luaL_register.3 @@ -38,6 +38,14 @@ or in variable reuses this table instead of creating a new one. .Pp In any case the function leaves the table on the top of the stack. +.Sh SEE ALSO +.Xr luaL_Reg 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_register blob - 3b51ce5d781a81ca21e82cc1a998a88ba6eceefd blob + de478df7dba5bd65c0441e57fbe1d50d1901b082 --- man3/luaL_typename.3 +++ man3/luaL_typename.3 @@ -11,6 +11,13 @@ .Sh DESCRIPTION .Fn luaL_typename returns the name of the type of the value at the given index. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_typename blob - b6fc49aba5648674dc2d38e99b336adb75a4398b blob + 03567dc44aa7e286c63dcd85b835e689da128386 --- man3/luaL_typerror.3 +++ man3/luaL_typerror.3 @@ -24,6 +24,14 @@ where location is produced by .Xr luaL_where 3 , func is the name of the current function, and rt is the type name of the actual argument. +.Sh SEE ALSO +.Xr luaL_where 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_typerror blob - 6b372aa63e0f308a8dd88cbd7a13d011de63929f blob + 796985f0656070f0138edbcefd7265172d88364e --- man3/luaL_unref.3 +++ man3/luaL_unref.3 @@ -25,6 +25,14 @@ or .Dv LUA_REFNIL , .Nm luaL_unref does nothing. +.Sh SEE ALSO +.Xr luaL_ref 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_unref blob - bd67a54bae88521fe0b818055bbcdc393852710e blob + 7a268acae8672ce544f0c19ec325d3e66ce20a2f --- man3/luaL_where.3 +++ man3/luaL_where.3 @@ -23,6 +23,13 @@ Level 0 is the running function, level 1 is the functi running function, etc. .Pp This function is used to build a prefix for error messages. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_where blob - 1f1c792b3458dbb015db05a3c6c96e71041b0857 blob + 13933cd6a10d047b432ef590346d3871c064d624 --- man3/lua_Alloc.3 +++ man3/lua_Alloc.3 @@ -87,6 +87,12 @@ if and only if it cannot fill the request. .Sh SEE ALSO .Xr lua_newstate 3 , .Xr luaL_newstate 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_Alloc blob - f7e204403447398594f825196dc9e8668e2abadb blob + caf0e76a893df3d52ca1d9e356e93977d1da9530 --- man3/lua_CFunction.3 +++ man3/lua_CFunction.3 @@ -49,6 +49,13 @@ static int foo (lua_State *L) { return 2; /* number of results */ } .Ed +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_CFunction blob - 9a5cb127e1a31b57d2da5dfafeb848fe7c8f7bf4 blob + 1295e643490574b8c8e1fba24c2994a19af785e9 --- man3/lua_Debug.3 +++ man3/lua_Debug.3 @@ -79,6 +79,15 @@ the empty string when no other option seems to apply). .It Sy nups : the number of upvalues of the function. .El +.Sh SEE ALSO +.Xr lua_getinfo 3 , +.Xr lua_getstack 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_Debug blob - 52329314cde3f1c7d6745445d220a8ff1576a9bc blob + f86db2cb387e94e4375e935fce02af076dc70d0a --- man3/lua_Hook.3 +++ man3/lua_Hook.3 @@ -35,6 +35,14 @@ call; in this case, it is useless to call While Lua is running a hook, it disables other calls to hooks. Therefore, if a hook calls back Lua to execute a function or a chunk, this execution occurs without any calls to hooks. +.Sh SEE ALSO +.Xr lua_getinfo 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_Hook blob - cd4acba849b8159b3bbe1e0cf8a108478adf75cc blob + f49d8db27cb7e7373f7b7d31e2316e8eaf5e7870 --- man3/lua_Integer.3 +++ man3/lua_Integer.3 @@ -14,6 +14,13 @@ By default it is a .Dv ptrdiff_t , which is usually the largest signed integral type the machine handles .Qq comfortably . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_Integer blob - 7920a6ce739f2c1cf22294e6004886a5c546fd14 blob + ea8f43ef4ac40b9430609da1ed8807a4b44da017 --- man3/lua_Number.3 +++ man3/lua_Number.3 @@ -14,6 +14,13 @@ By default, it is double, but that can be changed in .Pp Through the configuration file you can change Lua to operate with another type for numbers (e.g., float or long). +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Vt lua_Number blob - 143b980f23f79398e1b4bc062fa8711f02755f34 blob + e02f2dcea2807d938a591213c56e0d3ca33375af --- man3/lua_atpanic.3 +++ man3/lua_atpanic.3 @@ -20,6 +20,13 @@ Your panic function can avoid this exit by never retur jump). .Pp The panic function can access the error message at the top of the stack. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_atpanic blob - 29863d2009bf31a1d4b47d6dc25d3e2f4b607656 blob + f8f32c7655810914ee250b27513e838b5a8b4888 --- man3/lua_call.3 +++ man3/lua_call.3 @@ -55,6 +55,13 @@ lua_setfield(L, LUA_GLOBALSINDEX, "a"); /* set Note that the code above is "balanced": at its end, the stack is back to its original configuration. This is considered good programming practice. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_call blob - a80f4dc304bd5614024f107696bf2955d449d2ff blob + 8fe8b3ffd205f66f986b5c3ad45fe8d8008d290e --- man3/lua_checkstack.3 +++ man3/lua_checkstack.3 @@ -14,6 +14,13 @@ ensures that there are at least extra free stack slots It returns false if it cannot grow the stack to that size. This function never shrinks the stack; if the stack is already larger than the new size, it is left unchanged. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_checkstack blob - 2ee9d6bfc28bd9c9a1d5442e5d1e1acc87c81f17 blob + 43d1bb648bd3428647541b08f2fe546de517d8b9 --- man3/lua_close.3 +++ man3/lua_close.3 @@ -14,6 +14,13 @@ ensures that there are at least extra free stack slots It returns false if it cannot grow the stack to that size. This function never shrinks the stack; if the stack is already larger than the new size, it is left unchanged. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_close blob - 5ab4b2873cb55161fb4d91287b634ed3d892403a blob + c7d284ff8c07d87c03ce7a10635e76dbfb16a598 --- man3/lua_concat.3 +++ man3/lua_concat.3 @@ -24,6 +24,13 @@ is 1, the result is the single value on the stack (tha is, the function does nothing); if .Fa n is 0, the result is the empty string. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_concat blob - bb3f8111080ce7eefc33368585965b332b596a4c blob + b34af570cfe94bf90cd468a8dd26177c9dd7f2a5 --- man3/lua_cpcall.3 +++ man3/lua_cpcall.3 @@ -26,6 +26,14 @@ does not change the stack. All values returned by .Fa func are discarded. +.Sh SEE ALSO +.Xr lua_pcall 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_cpcall blob - 452f04c6c0e6a60fdaeef2a96539e048384c3f1e blob + 59d340427446afacc99be9ae907283636aaaa07c --- man3/lua_createtable.3 +++ man3/lua_createtable.3 @@ -20,6 +20,14 @@ This pre-allocation is useful when you know exactly ho will have. Otherwise you can use the function .Xr lua_newtable 3 . +.Sh SEE ALSO +.Xr lua_newtable 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_createtable blob - 83b2509feddcabcf5c4ac4de7827084dd1e335cd blob + 4c8349a1b835be6d393def9d920ef485700fafbf --- man3/lua_dump.3 +++ man3/lua_dump.3 @@ -25,6 +25,12 @@ The value returned is the error code returned by the l means no errors. .Sh SEE ALSO .Xr lua_Writer 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_dump blob - b401a516cf8552b0f2c7ce548bfb75fc019132ab blob + b95a856b7c53a7c399a406e54081f69815f450a4 --- man3/lua_equal.3 +++ man3/lua_equal.3 @@ -19,6 +19,13 @@ are equal, following the semantics of the Lua .Em == operator (that is, may call metamethods). Otherwise returns 0. Also returns 0 if any of the indices is non valid. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_equal blob - 4979142fb2aad6da301632ff84241cca01aa8d2a blob + 4280d878af688b2d681405306bb76eb29c15e2eb --- man3/lua_error.3 +++ man3/lua_error.3 @@ -17,6 +17,12 @@ the stack top. This function does a long jump, and therefore never returns. .Sh SEE ALSO .Xr luaL_error 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn luaL_error blob - 6528d33b296f96eeef4283020559cb046eb33bc1 blob + 3546f12f608065ff8603cd5698265bca6f7050ee --- man3/lua_gc.3 +++ man3/lua_gc.3 @@ -41,6 +41,13 @@ The function returns the previous value of the pause. sets data as the new value for the step multiplier of the collector. The function returns the previous value of the step multiplier. .El +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gc blob - f05c2db87f9b64e16c4c81184aa60b2e213193f5 blob + 7c348ff7bbdda8e9cb08d1c8e0f7c69b00989970 --- man3/lua_getallocf.3 +++ man3/lua_getallocf.3 @@ -22,6 +22,12 @@ the opaque pointer passed to .Xr lua_newstate 3 . .Sh SEE ALSO .Xr lua_newstate 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getallocf blob - 570fdab23de1c0077b959978a83860b2504fdc6d blob + e3bbc2efc6bbef3e6e80739e8241b99a431694e8 --- man3/lua_getfenv.3 +++ man3/lua_getfenv.3 @@ -11,6 +11,13 @@ .Sh DESCRIPTION .Fn lua_getfenv pushes onto the stack the environment table of the value at the given index. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getfenv blob - c159fe062940543df0ad7b7ead54ec16c3cca0d7 blob + 3727ded3cb58f444fdc3bfdf2885ba171863c1d9 --- man3/lua_getfield.3 +++ man3/lua_getfield.3 @@ -15,6 +15,13 @@ index. As in Lua, this function may trigger a metamethod for the .Qq index event. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getfield blob - e0d9015164a9153e79ce48a9a64f283946577f97 blob + f72a7c976c731b526a65422e05d4793f59519d06 --- man3/lua_getglobal.3 +++ man3/lua_getglobal.3 @@ -14,6 +14,13 @@ pushes onto the stack the value of the global name. It is defined as a macro: .Pp .Fd #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, s) +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getglobal blob - b111ce8ce6151b55e046e2fb8138bc4d6c633e15 blob + 9fc0d5e31247fafbb1b88cc6fee0538786b42890 --- man3/lua_gethook.3 +++ man3/lua_gethook.3 @@ -13,6 +13,13 @@ returns the current hook function. .Sh RETURN VALUES Returns the current hook function. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gethook blob - 31de633682ed1ce6ac142f797da11f45e487a9ec blob + d9429750b76735aa7e0b7c604b5c9c6916284b2a --- man3/lua_gethookcount.3 +++ man3/lua_gethookcount.3 @@ -13,6 +13,13 @@ returns the current hook count. .Sh RETURN VALUES Returns the current hook count. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gethookcount blob - 1d4f5c6d28eec5d6d1842c94ea1ebf7c2d7e00e9 blob + 26852c63f5120a59bfcf6c9ef0714cade336e977 --- man3/lua_gethookmask.3 +++ man3/lua_gethookmask.3 @@ -13,6 +13,13 @@ returns the current hook mask. .Sh RETURN VALUES Returns the current hook mask. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gethookmask blob - d4f4b1fa4deb1179abf688c7cbf4162a4b6d43b5 blob + 691c3701d9830a578b35a2178ee6cc75d4e9ac9d --- man3/lua_getinfo.3 +++ man3/lua_getinfo.3 @@ -55,6 +55,14 @@ can put a break point. Non-valid lines include empty lines and comments.) This function returns 0 on error (for instance, an invalid option in what). .El +.Sh SEE ALSO +.Xr lua_Hook 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getinfo blob - e2012462dcec63869dc5b6956183df08d7fdf466 blob + c1967bbd49d54c988710ba28f91df8b92c388d18 --- man3/lua_getlocal.3 +++ man3/lua_getlocal.3 @@ -31,6 +31,13 @@ Returns .Dv NULL .Pq and pushes nothing when the index is greater than the number of active local variables. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getlocal blob - 2e20092a66fa48cace5ec8ad9a7d3592c6c234be blob + d508132557f202c48017c1fdd342e23621189cd2 --- man3/lua_getmetatable.3 +++ man3/lua_getmetatable.3 @@ -16,6 +16,13 @@ If the .Fa index is not valid, or if the value does not have a metatable, the function returns 0 and pushes nothing on the stack. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getmetatable blob - 964e9e5c4e989eb6566424a97e780c7c423803c8 blob + 10ef22f1255cb90ec5bb69e68cdbf3df14b57511 --- man3/lua_getstack.3 +++ man3/lua_getstack.3 @@ -23,6 +23,14 @@ has called level When there are no errors, .Fn lua_getstack returns 1; when called with a level greater than the stack depth, it returns 0. +.Sh SEE ALSO +.Xr lua_Debug 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getstack blob - 0ced11364ee3305effa026d2c0ea2a651f421831 blob + 76a86364e1df4f17796a9fa8ec39234159659176 --- man3/lua_gettable.3 +++ man3/lua_gettable.3 @@ -19,6 +19,13 @@ place). As in Lua, this function may trigger a metamethod for the .Qq index event. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gettable blob - 4aa0a1ed2f5be18b40697cf341c9af1150dab25e blob + 8da859c48707a0e13baa8347da07e577b26b58c3 --- man3/lua_gettop.3 +++ man3/lua_gettop.3 @@ -15,6 +15,13 @@ Because indices start at 1, this result is equal to th the stack (and so 0 means an empty stack). .Sh RETURN VALUES Returns the index of the top element in the stack. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_gettop blob - bf8ae0af4345241d87ccf043c56a881b1475961b blob + 55de275046b8460a84d79e0828c3a2565a31e5c3 --- man3/lua_getupvalue.3 +++ man3/lua_getupvalue.3 @@ -29,6 +29,13 @@ Returns when the index is greater than the number of upvalues. For C functions, this function uses the empty string "" as a name for all upvalues. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_getupvalue blob - 419cba1339252cc92135be32653a6efcf94740c2 blob + 5d761df28d9aca518695b9342a62e4171af20f1e --- man3/lua_insert.3 +++ man3/lua_insert.3 @@ -15,6 +15,13 @@ moves the top element into the given valid index, shif above this index to open space. Cannot be called with a pseudo-index, because a pseudo-index is not an actual stack position. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_insert blob - be6cba9904a04d537dbac897a78fbc359531995a blob + ee7b02bd31bfb67cf34b1404db1caa4b6e1c2ee5 --- man3/lua_isboolean.3 +++ man3/lua_isboolean.3 @@ -15,6 +15,13 @@ otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index has type boolean, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isboolean blob - 48b7d5e609650166d2f123d101baa6c1f4d51309 blob + 6558385f59c2e319d5137aa9b429739fababb4c5 --- man3/lua_iscfunction.3 +++ man3/lua_iscfunction.3 @@ -15,6 +15,13 @@ otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a C function, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_iscfunction blob - 0edd460dcb39856ae71fa7a1bee644940b59ffbc blob + c96dc84923a533c383f0cbab5f874aa5db6f748f --- man3/lua_isfunction.3 +++ man3/lua_isfunction.3 @@ -15,6 +15,13 @@ Lua), and 0 otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a function (either C or Lua), and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isfunction blob - fc535298280ed20a4c1acfac96293c379aa9be2e blob + 00622693069d916eb84155cde6b1f2aa602da642 --- man3/lua_islightuserdata.3 +++ man3/lua_islightuserdata.3 @@ -15,6 +15,13 @@ otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a light userdata, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_islightuserdata blob - 3ff41648301f3574e562dde1388dea205c1d7743 blob + 8ece0c7f4242fdb5f7b6746be8edcc12a1a2ac6f --- man3/lua_isnil.3 +++ man3/lua_isnil.3 @@ -13,6 +13,13 @@ returns 1 if the value at the given acceptable index is nil, and 0 otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is nil, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isnil blob - c4c8c6cbe4f41241ff99e6f364a9003e8fea2d6a blob + 2337f07202173d7ad2ca3f92fdc3ee2ded48dac1 --- man3/lua_isnone.3 +++ man3/lua_isnone.3 @@ -14,6 +14,13 @@ returns 1 if the given acceptable index is not valid, .Sh RETURN VALUES Returns 1 if the given acceptable index is not valid (that is, it refers to an element outside the current stack), and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isnone blob - 99eb1298051961e9e4268a13156ccddd80693067 blob + 07cf95ac0ed2af47041a8ec40b7036f8e33dffd8 --- man3/lua_isnoneornil.3 +++ man3/lua_isnoneornil.3 @@ -16,6 +16,13 @@ index is nil, and 0 otherwise. Returns 1 if the given acceptable index is not valid (that is, it refers to an element outside the current stack) or if the value at this index is nil, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isnoneornil blob - 9700b9ecea1de2336c8bcccfcf3e6745f7328666 blob + 67375aaf54cf37314d50964b4a7183d5351c0c40 --- man3/lua_isnumber.3 +++ man3/lua_isnumber.3 @@ -15,6 +15,13 @@ convertible to a number, and 0 otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a number or a string convertible to a number, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isnumber blob - 2ec9b94b4273efed23aca6d762b002e40c05c7c4 blob + d2b8c264c0da360c10c4ca87028b044e085d514f --- man3/lua_isstring.3 +++ man3/lua_isstring.3 @@ -15,6 +15,13 @@ returns 1 if the value at the given acceptable index i .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a string or a number (which is always convertible to a string), and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isstring blob - c4d0e349e6b8951557227c7aa423affbd8266c0b blob + 7183c88fda82f3de2b6d6add509f8a0f827110e7 --- man3/lua_istable.3 +++ man3/lua_istable.3 @@ -13,6 +13,13 @@ .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a table, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_istable blob - 70a38df00c5022189a6b630f06c5f62823f5c3b5 blob + cbc0a288d97e5a2e357256fe92aafb29cb554b25 --- man3/lua_isthread.3 +++ man3/lua_isthread.3 @@ -15,6 +15,13 @@ otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a thread, and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isthread blob - 9d4832e1518e045347293137a70a357c7d1135dc blob + f6b066a7389e3fcb6a819a86f7d88860da0a81a2 --- man3/lua_isuserdata.3 +++ man3/lua_isuserdata.3 @@ -15,6 +15,13 @@ or light), and 0 otherwise. .Sh RETURN VALUES Returns 1 if the value at the given acceptable index is a userdata (either full or light), and 0 otherwise. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_isuserdata blob - beee0cece45b00daf6e63c9cab990d8ba6fd1ba4 blob + 21d651b70712462d3838e1f5116533fb8ce8b542 --- man3/lua_lessthan.3 +++ man3/lua_lessthan.3 @@ -19,6 +19,13 @@ is smaller than the value at acceptable index metamethods). Otherwise returns 0. Also returns 0 if any of the indices is non valid. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_lessthan blob - 975453a7d5caf3e5dda78e962918a9c14ceff4fa blob + 237d92fb3ad2cea9fa4dcbc34992d48b6fb6c50b --- man3/lua_load.3 +++ man3/lua_load.3 @@ -44,6 +44,15 @@ syntax error during pre-compilation; .It Dv LUA_ERRMEM : memory allocation error. .El +.Sh SEE ALSO +.Xr luac 1 , +.Xr lua_Reader 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_load blob - f28cffa260901b0ab2207f453c90d8e5dc28d680 blob + ab3781e7ff87589fa40aa65809b0423a4be3a187 --- man3/lua_newstate.3 +++ man3/lua_newstate.3 @@ -23,6 +23,13 @@ Returns .Dv NULL if cannot create the state .Pq due to lack of memory . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_newstate blob - b677acafe87ecc374cad67ebaecefbb4909050d9 blob + b6537ab9a19b6efd9f4c912e2dd661e01bb2bf21 --- man3/lua_newtable.3 +++ man3/lua_newtable.3 @@ -13,6 +13,13 @@ creates a new empty table and pushes it onto the stack. It is equivalent to .Em lua_createtable(L, 0, 0) . +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_newtable blob - 8f7cca432e2f4dbd77252d1e2fbbd09286d4efeb blob + bbde69cc60bf8e531ca58595056694a088114319 --- man3/lua_newthread.3 +++ man3/lua_newthread.3 @@ -25,6 +25,12 @@ returns a pointer to a that represents this new thread. .Sh SEE ALSO .Xr lua_State 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_newthread blob - c5f33c45ce21112c7c359070dac1d1652b224608 blob + 30e905ded2624b87f7cddf4b32450a842fdf0ef5 --- man3/lua_newuserdata.3 +++ man3/lua_newuserdata.3 @@ -24,6 +24,13 @@ A full userdata is only equal to itself (under raw equ When Lua collects a full userdata with a gc metamethod, Lua calls the metamethod and marks the userdata as finalized. When this userdata is collected again then Lua frees its corresponding memory. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_newuserdata blob - c3e419a17db0ebbb46a0f0d8603ac735025e71c6 blob + 4c65fdbd197e5248213707078628affa858e637a --- man3/lua_next.3 +++ man3/lua_next.3 @@ -38,6 +38,14 @@ Recall that .Xr lua_tolstring 3 changes the value at the given index; this confuses the next call to .Nm lua_next . +.Sh SEE ALSO +.Xr lua_tolstring 3 +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_next blob - 47b84de891b92795b60d6dba15a7142f411798b9 blob + f82aec52f12a48d83f9dab1aae2a3ba1abedcbd9 --- man3/lua_objlen.3 +++ man3/lua_objlen.3 @@ -16,6 +16,13 @@ of the value at the given acceptable index: for string length; for tables, this is the result of the length operator ('#'); for userdata, this is the size of the block of memory allocated for the userdata; for other values, it is 0. +.Sh SEE ALSO +.Rs +.%A Roberto Ierusalimschy +.%A Luiz Henrique de Figueiredo +.%A Waldemar Celes +.%T Lua 5.1 Reference Manual +.Re .Sh HISTORY The .Fn lua_objlen