diff options
Diffstat (limited to 'network/asciinema/asciinema.1')
| -rw-r--r-- | network/asciinema/asciinema.1 | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/network/asciinema/asciinema.1 b/network/asciinema/asciinema.1 deleted file mode 100644 index 1d96f401c7..0000000000 --- a/network/asciinema/asciinema.1 +++ /dev/null @@ -1,117 +0,0 @@ -.TH "asciinema" "1" "June 21, 2015" "asciinema 1.1.1" -.SH "NAME" -asciinema \- terminal session recorder -.SH "SYNOPSIS" -.B asciinema -.I [\-h] [\-\-version] command [<args>] -.SH "DESCRIPTION" -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 -\-h, \-\-help -Display help message -.TP -\-\-version -Display version information -.SH "COMMANDS" -.B rec [<filename>] -.RS 4 -Record terminal session. -.PP -This is the single most important command in asciinema, since it is how you utilize this tool's main job. -.PP -By running \fBasciinema rec\fP \fI[filename]\fP you start a new recording session. The command (process) that is recorded can be specified with \fI-c\fP option (see below), and defaults to \fB$SHELL\fP which is what you want in most cases. -.PP -Recording finishes when you exit the shell (hit \fBCtrl+D\fP or type \fIexit\fP). If the recorded process is not a shell than recording finishes when the process exits. -.PP -If the \fIfilename\fP argument is given then the resulting recording is saved to a local file. It can later be replayed with \fBasciinema play\fP \fI<filename>\fP and/or uploaded to asciinema.org with \fBasciinema upload\fP \fI<filename>\fP. If the \fIfilename\fP argument is omitted then (after asking for confirmation) the resulting asciicast is uploaded to asciinema.org for further playback in a web browser. -.PP -\fBASCIINEMA_REC=1\fP is added to recorded process environment variables. This can be used by your shell's config file (\fI.bashrc\fP, \fI.zshrc\fP) to alter the prompt or play a sound when shell is being recorded. -.TP -Available options: -.RS 4 -.TP -\-c, \-\-command -specify command to record, defaults to $SHELL -.TP -\-t -specify the title of the asciicast -.TP -\-w, \-\-max\-wait -reduce recorded terminal inactivity to max <sec> seconds -.TP -\-y, \-\-yes -answer "yes" to all prompts (e.g. upload confirmation) -.TP -\-q, \-\-quiet -be quiet, suppress all notices/warnings (implies -y) -.RE -.RE -.PP -.B play <filename> -.RS 4 -Replay recorded asciicast in a terminal. -.PP -This command replays given asciicast (as recorded by \fIrec\fP 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's no "transcoding" of control sequences for new terminal size. -.TP -Available options: -.RS 4 -.TP -\-w, \-\-max\-wait -reduce replayed terminal inactivity to max \fIsec\fP seconds -.RE -.RE -.PP -.B upload <filename> -.RS 4 -Upload recorded asciicast to asciinema.org site. -.PP -This command uploads given asciicast (as recorded by \fIrec\fP command) to asciinema.org for further playback in a web browser. -.PP -\fBasciinema rec\fP \fIdemo.json\fP + \fBasciinema play\fP \fIdemo.json\fP + \fBasciinema upload\fP \fIdemo.json\fP is a nice combo for when you want to review an asciicast before publishing it on asciinema.org. -.RE -.PP -.B auth -.RS 4 -Assign local API token to asciinema.org account. -.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 \fBnecessary\fP 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's not necessary. You can assign new tokens to your account -from as many machines as you want. -.RE -.SH "CONTRIBUTING" -If you want to contribute to this project check out Contributing page: \fIhttps://asciinema.org/contributing\fP -.SH "BUGS" -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 -https://github.com/asciinema/asciinema/issues -issues and ideas for the command line recorder -.TP -https://github.com/asciinema/asciinema.org/issues -issues and ideas for the website -.TP -https://github.com/asciinema/asciinema-player/issues -issues and ideas for the javascript player -.SH "AUTHORS" -Developed with passion by \fBMarcin Kulik\fP and great open source contributors. |