summaryrefslogtreecommitdiff
path: root/README.md
blob: 60e1749e691c2dd772f256edf70079cf8d0d3eef (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
# prelude.kak

Prelude of shell blocks for [Kakoune].

## Installation

Add [`prelude.kak`](rc/prelude.kak) to your autoload or source it manually.

## Usage

```
kak_escape [text…]
```

Similar to `shell_escape` you may find in other programming languages,
`kak_escape` escapes each argument so that it can be safely passed to Kakoune.

**Implementation**:
Single quotes each argument and doubles the single quotes inside.

**Note**:
The resulted text should be used unquoted and is not intended for use in double quotes, nor in single quotes.

**Example**:

``` kak
evaluate-commands %sh{
  . "$kak_opt_prelude"
  kak_escape evaluate-commands -try-client "$kak_client" 'echo Tchou' | kak -p "$kak_session"
}
```

[Kakoune]: https://kakoune.org