aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_show.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/luarocks_show.md')
-rw-r--r--docs/luarocks_show.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/luarocks_show.md b/docs/luarocks_show.md
new file mode 100644
index 00000000..353935c5
--- /dev/null
+++ b/docs/luarocks_show.md
@@ -0,0 +1,25 @@
1# luarocks show
2
3Shows information about an installed rock.
4
5## Usage
6
7`luarocks show <name> [<version>]`
8
9`<name>` is an installed package name.
10Without any flags, show all module information.
11With these flags, return only the desired information:
12
13* `--home` - home page of project
14* `--modules` - all modules provided by this package as used by `require()`
15* `--deps` - packages this package depends on, including indirect dependencies
16* `--rockspec` - the full path of the rockspec file
17* `--mversion` - the package version
18* `--rock-tree` - local tree where rock is installed
19* `--rock-dir` - data directory of the installed rock
20
21## Example
22
23```
24luarocks show luasocket
25```