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