diff options
author | Jesse Luehrs <doy@tozt.net> | 2021-12-05 19:37:42 -0500 |
---|---|---|
committer | Jesse Luehrs <doy@tozt.net> | 2021-12-05 19:37:42 -0500 |
commit | f6d8f7d72bb8bd54350f74b75ea0b8d2ecd55ccd (patch) | |
tree | 6aace9bc2cb94cd5ced7f2488f272abe211b926f | |
parent | d9611e009279eeb74d642f72adab9621577b33c8 (diff) | |
download | ttyrec-bin-f6d8f7d72bb8bd54350f74b75ea0b8d2ecd55ccd.tar.gz ttyrec-bin-f6d8f7d72bb8bd54350f74b75ea0b8d2ecd55ccd.zip |
metadata and readmev0.1.0
-rw-r--r-- | Cargo.toml | 6 | ||||
-rw-r--r-- | README.md | 25 |
2 files changed, 31 insertions, 0 deletions
@@ -1,8 +1,14 @@ [package] name = "ttyrec-bin" version = "0.1.0" +authors = ["Jesse Luehrs <doy@tozt.net>"] edition = "2021" +description = "record and play back ttyrec files" +repository = "https://git.tozt.net/ttyrec-bin" +readme = "README.md" +keywords = ["ttyrec"] +categories = ["command-line-utilities"] license = "MIT" [dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..b86a036 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# ttyrec + +The ttyrec file format is used to record terminal sessions for later +playback. This is commonly used for recording terminal games such as +[NetHack](https://alt.org/nethack) or [Dungeon Crawl Stone +Soup](https://crawl.akrasiac.org/), but can be used for any terminal session. + +## Recording + +Sessions can be recorded using the `ttyrec` command. It launches a shell, and +all output from that session is saved to a file, similar to the [`script` +command from +util-linux](https://www.man7.org/linux/man-pages/man1/script.1.html). Unlike +`script`, however, `ttyrec` also saves information about the timing between +chunks of output, so that the session can be played back in real time as it +happened. See `ttyrec --help` for more information about available options. + +## Playback + +The `ttyplay` command is an interactive player for ttyrec files. In addition to +playing back files as they were recorded, this player allows for arbitrary +seeking forwards and backwards through the file, pausing, adjusting the +playback speed, and searching for output content. See `ttyplay --help` for more +information about available options, and press `?` while the player is paused +(via the Space key) to see a list of key bindings. |