aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_pack.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/luarocks_pack.md')
-rw-r--r--docs/luarocks_pack.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/luarocks_pack.md b/docs/luarocks_pack.md
new file mode 100644
index 00000000..7721ba34
--- /dev/null
+++ b/docs/luarocks_pack.md
@@ -0,0 +1,31 @@
1# luarocks pack
2
3Create a rock, packing sources or binaries.
4
5## Usage
6
7`luarocks pack {<rockspec> | <name> [<version>]}`
8
9Argument may be a rockspec file, for creating a source rock, or the name of an
10installed package, for creating a binary rock. In the latter case, the package
11version may be given as a second argument.
12
13## Examples
14
15```
16luarocks pack luafilesystem 1.4.0
17```
18
19Assuming you have LuaFileSystem 1.4.0 installed in your local tree, this
20creates in the current directory a file called
21`luafilesystem-1.4.0-1.linux-x86.rock` (filename will of course vary according
22to the platform), using the binary that is already installed.
23
24```
25luarocks pack copas-1.1.1-1.rockspec
26```
27
28Assuming you have `copas-1.1.1-1.rockspec` in the current directory, this
29creates (also in the current directory) a file called
30`copas-1.1.1-1.src.rock`, fetching sources as specified in the rockspec.
31