Tree
- Tree:
f39018538b88bd4d5235e0a8cdd0d21eeed03ea9
- Date:
- Message:
- man3: add a function's indicators The patch addes function's indicators to a short description. Lua 5.1 Reference Manual in "3.7 – Functions and Types" [1] describes function's indicators and how to read this notation: Each function has an indicator like this: `[-o, +p, x]`. The first field, `o`, is how many elements the function pops from the stack. The second field, `p`, is how many elements the function pushes onto the stack. (Any function always pushes its results after popping its arguments.) A field in the form `x|y` means the function can push (or pop) `x` or `y` elements, depending on the situation; an interrogation mark '?' means that we cannot know how many elements the function pops/pushes by looking only at its arguments (e.g., they may depend on what is on the stack). The third field, `x`, tells whether the function may throw errors: '-' means the function never throws any error; 'm' means the function may throw an error only due to not enough memory; 'e' means the function may throw other kinds of errors; 'v' means the function may throw an error on purpose. 1. http://www.lua.org/manual/5.1/manual.html#3.7
.github/ | |
CHANGELOG.md | commits | blame |
Makefile | commits | blame |
README.md | commits | blame |
man3/ | |
style.css | commits | blame |
README.md
## Lua C API manual pages is a set of manual pages that covers Lua 5.1 C API described in Lua 5.1 Reference Manual. It includes: - [3.7 – Functions and Types](http://www.lua.org/manual/5.1/manual.html#3.7) - [3.8 – The Debug Interface](http://www.lua.org/manual/5.1/manual.html#3.8) - [4.1 – Functions and Types](http://www.lua.org/manual/5.1/manual.html#4.1) ### Installation ```sh $ apt install -y mandoc make $ make check $ make install $ makewhatis ``` ### See also - [C++ 98/11/14 manual pages for Linux/MacOS](https://github.com/aitjcize/cppman) - [Formatted C++20 stdlib man pages (cppreference)](https://github.com/jeaye/stdman) - [x86 and amd64 instruction reference manual pages](https://github.com/ttmo-O/x86-manpages)