TERMREC(1)

πŸ’– TERMREC(1) β€” the tty recorder bestie πŸ’–

okay so picture this: you're in the group chat of your terminal, and you want receipts. that's termrec, and she is serving β€” she's a tty recorder. ✨


πŸŽ€ NAME πŸŽ€

termrec β€” a tty recorder. that's it, that's the whole vibe. no cap.


🌸 SYNOPSIS 🌸

termrec [-f format] [-e command] [outfile]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so termrec is a tty recorder, periodt. she can record the output of any text mode program, and then you get to replay it later with termplay, ttyplay, ipbt, ttyplayer, nh-recorder, asciinema or similar. like, your terminal session becomes content. iconic behavior fr fr πŸ’…

if your outfile ends in .gz, .xz, .bz2 or .zst, the data gets appropriately compressed. she's thoughtful like that 🫢

and if you don't give her an outfile at all? no stress, she'll just make up a name for you, something like:

2008-11-27.13-02-42.ttyrec.bz2

you can also write directly to some remote URLs, such as tcp://host:port β€” but ngl, that's usually of little use. lowkey pointless but she supports it anyway πŸ’€


✨ OPTIONS ✨ (the good stuff)

🌈 Options:

  • -f format, --format β€” you can specify a format other than ttyrec. the ones on the menu are:
    • ansi β€” no timing data. this is same as the output of script(1). giving minimalist πŸŽ€
    • ttyrec β€” compatible with ttyrec by Satoru Takabayashi. the og, the blueprint πŸ‘‘
    • nh-recorder β€” compatible with nh-recorder by Helge Dennhardt.
    • asciicast β€” compatible with asciinema by Marcin Kulik; format v2.
    • asciicast-v1 β€” likewise, format v1. yeah she keeps the old one too, she's not a gatekeeper 🫢
  • -e command, --exec β€” runs a command instead of spawning a shell, and records its output. so instead of a whole interactive shell moment, you're like "bestie just run this one thing and film it" 🎬
  • -r, --raw β€” inhibits noting info about your terminal size and UTFness. so real talk: this data is usually a good thing, but it can confuse some programs. also note that none of the formats provides a way to mark which exactly charset you use β€” only if it's UTF-8 or one of ancient ones. so it's giving we know it's UTF-8 or it's giving ancient, no in-between 😭
  • -a, --append β€” if the output file already exists, it will be appended instead being overwritten. she adds to the lore instead of deleting the lore πŸ“
  • -h, --help β€” shows a short explanation of parameters. the "hey bestie here's how I work" button πŸ’–

πŸ’œ ENVIRONMENT πŸ’œ

  • SHELL β€” unless -e is given, this will be the shell spawned, falling back to /bin/sh if not set. on Windows, COMSPEC is used instead. so yeah, windows girlies get their own variable, equality πŸ’…

πŸ‘‘ SEE ALSO πŸ‘‘

termplay(1), termtime(1), termcat(1).


πŸ’€ no warnings here bestie, she's chill. just remember -a appends and everything else overwrites, and -r can confuse some programs β€” that's the tea.

version 0.19 Β· dated 2024-04-01 Β· this was the termrec manual page, and she ate, no crumbs left 🌟 mwah, ily, go record something iconic βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from