aboutsummaryrefslogtreecommitdiff
path: root/doc/haredoc.txt
blob: 00fc9dd197299001ffb026d801ac347c74aae0d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
*haredoc.txt*         *haredoc* -- documentation for the Hare programming language

This plugin integrates the haredoc command of the Hare programming language,
which looks up and displays documentation for Hare symbols/identifiers in your
source code, including symbols defined in the system's Hare standard library.
See haredoc(1) and hare(1).

        https://docs.harelang.org/

This plugin appropriately uses |popup-window| and |terminal-window| to display
documentation. If either |+popupwin| or |+terminal| is not available, this
plugin falls back to a normal window.


MAPPINGS

                                                        *K* *haredoc-K*
K                       Show documentation for the Hare symbol under the
                        cursor in a |popup-window|.
                        Press d and u to scroll large outputs.
                        Press q or CTRL-C to close.


                                                        *gK* *haredoc-gK*
gK                      Show documentation for the Hare symbol under the
                        cursor in a |terminal-window|.
                        Press d and u to scroll large outputs.
                        Press q or CTRL-C once or twice to close.

COMMANDS

                                                        *:Haredoc*
:Haredoc {symbol}       Show documentation for the given Hare symbol in a
                        |terminal-window|.
                        Press d and u to scroll large outputs.
                        Press q or CTRL-C once or twice to close.

:Haredoc .              Same as the |K| command.

:Haredoc ,              Same as the |gK| command.




LICENSE

Vim License


 vim:tw=78:ts=8:noet:ft=help:norl: