diff options
Diffstat (limited to 'docs/luarocks_install.md')
-rw-r--r-- | docs/luarocks_install.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/luarocks_install.md b/docs/luarocks_install.md new file mode 100644 index 00000000..f3eddbd6 --- /dev/null +++ b/docs/luarocks_install.md | |||
@@ -0,0 +1,37 @@ | |||
1 | # luarocks install | ||
2 | |||
3 | Install a rock. | ||
4 | |||
5 | ## Usage | ||
6 | |||
7 | `luarocks install [--keep] [--only-deps] {<rock> | <name> [<version>]}` | ||
8 | |||
9 | Argument may be the name of a rock to be fetched from a server, with optional | ||
10 | version, or the direct URL or filename of a rockspec. In case of more than one | ||
11 | rock matching the request, the `install` command favors binary rocks. | ||
12 | |||
13 | Unless `--keep` is passed, other versions of the rock are removed after | ||
14 | installing the new one. | ||
15 | |||
16 | If `--only-deps` is passed, the rock itself is not installed, but its | ||
17 | dependencies are. | ||
18 | |||
19 | ## Examples | ||
20 | |||
21 | Installing a rock: | ||
22 | |||
23 | ``` | ||
24 | luarocks install luasocket | ||
25 | ``` | ||
26 | |||
27 | Installing a specific version of a rock: | ||
28 | |||
29 | ``` | ||
30 | luarocks install luasocket 3.0rc1 | ||
31 | ``` | ||
32 | |||
33 | Installing a rock ignoring its dependencies: | ||
34 | |||
35 | ``` | ||
36 | luarocks install busted --deps-mode=none | ||
37 | ``` | ||