diff options
Diffstat (limited to 'docs/luarocks_doc.md')
-rw-r--r-- | docs/luarocks_doc.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/luarocks_doc.md b/docs/luarocks_doc.md new file mode 100644 index 00000000..d39e708b --- /dev/null +++ b/docs/luarocks_doc.md | |||
@@ -0,0 +1,21 @@ | |||
1 | # luarocks doc | ||
2 | |||
3 | Show documentation for an installed rock. | ||
4 | |||
5 | ## Usage | ||
6 | |||
7 | `luarocks doc [--home] [--list] <name> [<version>]` | ||
8 | |||
9 | Attempts to open documentation for an installed rock using a number | ||
10 | of heuristics. | ||
11 | |||
12 | If `--home` is passed, opens the home page of the project. | ||
13 | |||
14 | If `--list` is passed, documentation files bundled with the rock | ||
15 | are listed but not opened. | ||
16 | |||
17 | ## Example | ||
18 | |||
19 | ``` | ||
20 | luarocks doc luasocket | ||
21 | ``` | ||