aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_build.md
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2025-01-05 21:40:39 -0300
committerHisham Muhammad <hisham@gobolinux.org>2025-01-05 21:40:39 -0300
commitf5c5db5a7378d97a6f261ffaa10c84e2005bfc4e (patch)
treec2f0cb86890fb90a85a7f091746543c7ff14ac5e /docs/luarocks_build.md
parent7fe5532c695711d23fd9d7e13a9e6235478171b6 (diff)
downloadluarocks-f5c5db5a7378d97a6f261ffaa10c84e2005bfc4e.tar.gz
luarocks-f5c5db5a7378d97a6f261ffaa10c84e2005bfc4e.tar.bz2
luarocks-f5c5db5a7378d97a6f261ffaa10c84e2005bfc4e.zip
docs: import Wiki docs into the main repo
Diffstat (limited to 'docs/luarocks_build.md')
-rw-r--r--docs/luarocks_build.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/luarocks_build.md b/docs/luarocks_build.md
new file mode 100644
index 00000000..75b7898d
--- /dev/null
+++ b/docs/luarocks_build.md
@@ -0,0 +1,22 @@
1# luarocks build
2
3Build/compile and install a rock.
4
5## Usage
6
7`luarocks build [--pack-binary-rock] {<rockspec> | <rock> | <name> [<version>]}`
8
9Builds and installs a rock, compiling its C parts if any. Argument may be a
10rockspec file, a source rock file or the name of a rock to be fetched from a
11repository, in which case a version may be passed as well. In case of more
12than one rock matching the request, the `build` command favors source rocks.
13
14If `--pack-binary-rock` is passed, the rock is not installed; instead, a
15`.rock` file with the contents of compilation is produced in the current
16directory.
17
18## Example
19
20```
21luarocks build luasocket
22```