diff options
Diffstat (limited to 'docs/luarocks_admin_remove.md')
-rw-r--r-- | docs/luarocks_admin_remove.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/luarocks_admin_remove.md b/docs/luarocks_admin_remove.md new file mode 100644 index 00000000..7a861a23 --- /dev/null +++ b/docs/luarocks_admin_remove.md | |||
@@ -0,0 +1,47 @@ | |||
1 | # luarocks-admin remove | ||
2 | |||
3 | Remove a rock or rockspec from a rocks server. | ||
4 | |||
5 | ## Usage | ||
6 | |||
7 | `luarocks-admin remove [--server=<server>] [--no-refresh] {<rockspec>|<rock>}...` | ||
8 | |||
9 | Arguments are local files, which may be rockspecs or rocks. | ||
10 | |||
11 | The flag `--server` indicates which server to use. If not given, the default server set in the `upload_server` variable from the [configuration files](config_file_format.md) is used instead. | ||
12 | |||
13 | The flag `--no-refresh` indicates the local cache should not be refreshed prior to generation of the updated manifest. | ||
14 | |||
15 | You need to have [rsync](https://rsync.samba.org/) installed in order to use this command. | ||
16 | |||
17 | ## Examples | ||
18 | |||
19 | ### Basic example | ||
20 | |||
21 | Remove a rockspec from your default configured upload server: | ||
22 | |||
23 | ``` | ||
24 | luarocks-admin remove lpeg-0.9-1.rockspec | ||
25 | ``` | ||
26 | |||
27 | ### Handling multiple repositories | ||
28 | |||
29 | Assuming your `~/.luarocks/config.lua` file looks like this: | ||
30 | |||
31 | ```lua | ||
32 | upload_server = "main" | ||
33 | upload_servers = { | ||
34 | main = { | ||
35 | rsync = "www.example.com/repos/main", | ||
36 | }, | ||
37 | dev = { | ||
38 | rsync = "www.example.com/repos/devel-rocks", | ||
39 | }, | ||
40 | } | ||
41 | ``` | ||
42 | |||
43 | you can specify which repository to use with the `--server` flag: | ||
44 | |||
45 | ``` | ||
46 | luarocks-admin remove --server=dev my_rock-scm-1.rockspec | ||
47 | ``` | ||