asciinema Manpage generated by Pandoc from Markdown

asciinema-manpage.man

.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "ASCIINEMA" "1" "2017\-12\-09" "Manual Page Version 0.0.1" "asciinema Manual Page for Version 2.0"
.hy
.SH NAME
.PP
asciinema \- terminal session recorder \ 
.SH SYNOPSIS
.PP
\f[B]asciinema\f[] \f[I][\-h] [\-\-version] command [<args>]\f[]
.SH DESCRIPTION
.PP
Terminal session recorder and the best companion of asciinema.org
service.
.PP
asciinema is composed of multiple commands, similar to git, apt\-get or
brew.
.PP
When you run asciinema with no arguments help messages is displayed,
listing all available commands with their options.
.SH OPTIONS
.TP
.B \f[C]\-h\f[], \f[C]\-\-help\f[]
Display help message
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
Display version information
.RS
.RE
.SH COMMANDS
.TP
.B \f[B]rec [<filename>]\f[]
Record terminal session.
.RS
.PP
This is the single most important command in asciinema, since it is how
you utilize this tool\[aq]s main job.
.PP
By running \f[B]asciinema rec\f[] \f[I][filename]\f[] you start a new
recording session.
The command (process) that is recorded can be specified with
\f[I]\-c\f[] option (see below), and defaults to \f[B]$SHELL\f[] which
is what you want in most cases.
.PP
Recording finishes when you exit the shell (hit \f[B]Ctrl+D\f[] or type
\f[I]exit\f[]).
If the recorded process is not a shell than recording finishes when the
process exits.
.PP
If the \f[I]filename\f[] argument is given then the resulting recording
is saved to a local file.
It can later be replayed with \f[B]asciinema play\f[]
\f[I]<filename>\f[] and/or uploaded to asciinema.org with \f[B]asciinema
upload\f[] \f[I]<filename>\f[].
If the \f[I]filename\f[] argument is omitted then (after asking for
confirmation) the resulting asciicast is uploaded to asciinema.org for
further playback in a web browser.
.PP
\f[B]ASCIINEMA_REC=1\f[] is added to recorded process environment
variables.
This can be used by your shell\[aq]s config file (\f[I].bashrc\f[],
\f[I].zshrc\f[]) to alter the prompt or play a sound when shell is being
recorded.
.TP
.B Available options:
\ 
.RS
.TP
.B \f[C]\-c\f[], \f[C]\-\-command\f[]
specify command to record, defaults to $SHELL
.RS
.RE
.TP
.B \f[C]\-t\f[]
specify the title of the asciicast
.RS
.RE
.TP
.B \f[C]\-w\f[], \f[C]\-\-max\-wait\f[]
reduce recorded terminal inactivity to max <sec> seconds
.RS
.RE
.TP
.B \f[C]\-y\f[], \f[C]\-\-yes\f[]
answer "yes" to all prompts (e.g.
upload confirmation)
.RS
.RE
.TP
.B \f[C]\-q\f[], \f[C]\-\-quiet\f[]
be quiet, suppress all notices/warnings (implies \-y)
.RS
.RE
.RE
.RE
.TP
.B \f[B]play <filename>\f[]
Replay recorded asciicast in a terminal.
.RS
.PP
This command replays given asciicast (as recorded by \f[I]rec\f[]
command) directly in your terminal.
.PP
When "\-" is passed as a filename the asciicast is read from stdin.
.PP
NOTE: it is recommended to run it in a terminal of dimensions not
smaller than the one used for recording as there\[aq]s no "transcoding"
of control sequences for new terminal size.
.TP
.B Available options:
\ 
.RS
.TP
.B \f[C]\-w\f[], \f[C]\-\-max\-wait\f[]
reduce replayed terminal inactivity to max \f[I]sec\f[] seconds
.RS
.RE
.TP
.B \f[C]\-s\f[], \f[C]\-\-speed\f[]
speed up playback by factor \f[I]factor\f[] (can be fractional)
.RS
.RE
.RE
.RE
.TP
.B \f[B]upload <filename>\f[]
Upload recorded asciicast to asciinema.org site.
.RS
.PP
This command uploads given asciicast (as recorded by \f[I]rec\f[]
command) to asciinema.org for further playback in a web browser.
.PP
\f[B]asciinema rec\f[] \f[I]demo.cast\f[] + \f[B]asciinema play\f[]
\f[I]demo.cast\f[] + \f[B]asciinema upload\f[] \f[I]demo.cast\f[] is a
nice combo for when you want to review an asciicast before publishing it
on asciinema.org.
.RE
.TP
.B \f[B]auth\f[]
Assign local API token to asciinema.org account.
.RS
.PP
On every machine you install asciinema recorder, you get a new, unique
API token.
This command connects this local token with your asciinema.org account,
and links all asciicasts recorded on this machine with the account.
.PP
This command displays the URL you should open in your web browser.
If you never logged in to asciinema.org then your account will be
created when opening the URL.
.PP
NOTE: it is \f[B]necessary\f[] to do this if you want to edit or delete
your recordings on asciinema.org.
.PP
You can synchronize your config file (which keeps the API token) across
the machines but that\[aq]s not necessary.
You can assign new tokens to your account from as many machines as you
want.
.RE
.SH CONTRIBUTING
.PP
If you want to contribute to this project check out Contributing page:
\f[I]<https://asciinema.org/contributing>\f[]
.SH BUG TRACKER
.PP
All your bug reports and feature ideas are highly appreciated as they
help to improve the quality and functionality of asciinema for everyone.
.PP
As the service is built of several parts there are separate bug
trackers:
.TP
.B <https://github.com/asciinema/asciinema/issues>
issues and ideas for the command line recorder
.RS
.RE
.TP
.B <https://github.com/asciinema/asciinema-server/issues>
issues and ideas for the website
.RS
.RE
.TP
.B <https://github.com/asciinema/asciinema-player/issues>
issues and ideas for the javascript player
.RS
.RE
.SH KNOWN BUGS
.PP
Blah...
TODO \-tbd\-
.SH EXAMPLES
.PP
Blah...
TODO \-tbd\-
.SH ENVIRONMENT VARIABLES
.PP
Blah...
TODO \-tbd\-
.SH FILES
.PP
Blah...
TODO \-tbd\-
.SH DEVELOPERS
.PP
Developed with passion by \f[B]Marcin Kulik\f[] and great open source
contributors.
.SH AUTHORS
.PP
This Manual Page was written by \f[B]Marcin Kulik\f[] and was modified
by \f[B]Kurt Pfeifle\f[].