diff options
Diffstat (limited to 'docs/luarocks_build.md')
-rw-r--r-- | docs/luarocks_build.md | 22 |
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 | |||
3 | Build/compile and install a rock. | ||
4 | |||
5 | ## Usage | ||
6 | |||
7 | `luarocks build [--pack-binary-rock] {<rockspec> | <rock> | <name> [<version>]}` | ||
8 | |||
9 | Builds and installs a rock, compiling its C parts if any. Argument may be a | ||
10 | rockspec file, a source rock file or the name of a rock to be fetched from a | ||
11 | repository, in which case a version may be passed as well. In case of more | ||
12 | than one rock matching the request, the `build` command favors source rocks. | ||
13 | |||
14 | If `--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 | ||
16 | directory. | ||
17 | |||
18 | ## Example | ||
19 | |||
20 | ``` | ||
21 | luarocks build luasocket | ||
22 | ``` | ||