aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_search.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/luarocks_search.md')
-rw-r--r--docs/luarocks_search.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/luarocks_search.md b/docs/luarocks_search.md
new file mode 100644
index 00000000..70cea427
--- /dev/null
+++ b/docs/luarocks_search.md
@@ -0,0 +1,29 @@
1# luarocks search
2
3Query the LuaRocks servers.
4
5## Usage
6
7`luarocks search [--porcelain] [--source] [--binary] { <query> [<version>] | --all }`
8
9Lists files available on LuaRocks servers. `<query>` is a substring of a rock
10name to filter by. The search can be narrowed further narrowed down using a
11version. To list files for all rocks pass `--all`.
12
13If `--porcelain` is passed, machine-friendly output is produced.
14
15If `--source` is passed, only rockspecs and source rocks are shown.
16
17If `--binary` is passed, only binary and pure-Lua rocks are shown.
18
19Rocks not supporting version of Lua used by LuaRocks are not listed.
20
21The `luarocks search` command queries remote repositories.
22To query your local repository (the rocks you have installed), use [luarocks list](luarocks_list.md).
23
24## Example
25
26```
27luarocks search socket
28```
29