aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_doc.md
blob: d39e708baf38a9d6cf03bd6f17c14ef5674293dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# luarocks doc

Show documentation for an installed rock.

## Usage

`luarocks doc [--home] [--list] <name> [<version>]`

Attempts to open documentation for an installed rock using a number
of heuristics.

If `--home` is passed, opens the home page of the project.

If `--list` is passed, documentation files bundled with the rock
are listed but not opened.

## Example

```
luarocks doc luasocket
```