Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 03:38:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Explain env var capture in v2 format

Browse Source
This commit is contained in:
Marcin Kulik
2017-09-17 12:57:16 +02:00
parent c39d60a922
commit 8db998d0d4
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/asciicast-v2.md
View File

@@ -66,6 +66,16 @@ Title of the asciicast, as given via `-t` option to `asciinema rec`. String.
Map of captured environment variables. Object (String -> String). Map of captured environment variables. Object (String -> String).
Example env:
```json
{"SHELL": "xterm-256color", "TERM": "/bin/bash"}
```
Official asciinema recorder captures only `SHELL` and `TERM` by default. All
implementations of asciicast-compatible terminal recorder should not capture any
additional environment variables unless explicitly permitted by the user.
## Event stream ## Event stream
Each element of the event stream is a 3-tuple encoded as JSON array: Each element of the event stream is a 3-tuple encoded as JSON array: