aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_remove.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/luarocks_remove.md')
-rw-r--r--docs/luarocks_remove.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/luarocks_remove.md b/docs/luarocks_remove.md
new file mode 100644
index 00000000..0a74a2d9
--- /dev/null
+++ b/docs/luarocks_remove.md
@@ -0,0 +1,22 @@
1# luarocks remove
2
3Uninstall a rock.
4
5## Usage
6
7`luarocks remove [--force|--force-fast] <name> [<version>]`
8
9`<name>` is the name of a rock to be uninstalled. If a `<version>` is not
10given, try to remove all versions at once. Will only perform the removal if it
11does not break dependencies.
12
13To override this check and force the removal, use `--force`.
14
15To perform a forced removal without looking for broken dependencies,
16use `--force-fast`.
17
18## Example
19
20```
21luarocks remove --force luafilesystem 1.3.0
22```