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

Tweak rec subcommand documentation

Browse Source
This commit is contained in:
Marcin Kulik
2017-09-22 22:59:14 +02:00
parent a4c6d3fa95
commit 5bcbd2e8aa
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -105,16 +105,19 @@ Recording finishes when you exit the shell (hit <kbd>Ctrl+D</kbd> or type
`exit`). If the recorded process is not a shell then recording finishes when `exit`). If the recorded process is not a shell then recording finishes when
the process exits. the process exits.
If the `filename` argument is given then the resulting recording If the `filename` argument is omitted then (after asking for confirmation) the
(called [asciicast](doc/asciicast-v1.md)) is saved to a local file. It can later be replayed with resulting asciicast is uploaded to
`asciinema play <filename>` and/or uploaded to asciinema.org with `asciinema [asciinema-server](https://github.com/asciinema/asciinema-server) (by default to
upload <filename>`. If the `filename` argument is omitted then (after asking for asciinema.org), where it can be watched and shared.
confirmation) the resulting asciicast is uploaded to asciinema.org, where it can
be watched and shared. If the `filename` argument is given then the resulting recording (called
[asciicast](doc/asciicast-v2.md)) is saved to a local file. It can later be
replayed with `asciinema play <filename>` and/or uploaded to asciinema server
with `asciinema upload <filename>`.
`ASCIINEMA_REC=1` is added to recorded process environment variables. This `ASCIINEMA_REC=1` is added to recorded process environment variables. This
can be used by your shell's config file (`.bashrc`, `.zshrc`) to alter the can be used by your shell's config file (`.bashrc`, `.zshrc`) to alter the
prompt or play a sound when shell is being recorded. prompt or play a sound when the shell is being recorded.
Available options: Available options: