Skip to content
This repository has been archived by the owner on Jun 16, 2020. It is now read-only.

Latest commit

 

History

History
92 lines (67 loc) · 2.99 KB

termtosvg.md

File metadata and controls

92 lines (67 loc) · 2.99 KB
Raw

termtosvg manual page

SYNOPSIS

termtosvg [-g GEOMETRY] [-t TEMPLATE] [--verbose] [--help] [output_file]

termtosvg record [-g GEOMETRY] [--verbose] [--help] [output_file]

termtosvg render [-g GEOMETRY] [-t TEMPLATE] [--verbose] [--help] input_file [output_file]

DESCRIPTION

termtosvg makes recordings of terminal sessions in animated SVG format. If no output filename is provided, a random temporary filename will be automatically generated.

COMMANDS

The default behavior of termtosvg is to render an SVG animation

termtosvg record

Record a terminal session in asciicast v2 format. The recording is a text file which contains timing information as well as what was displayed on the screen during the terminal session. It may be edited to alter the timing of the recording or the information displayed on the screen of the terminal.

termtosvg render

Render an animated SVG from a recording in asciicast v1 or v2 format. This allows rendering in SVG format of any recording made with asciinema.

OPTIONS

-g, --screen-geometry=GEOMETRY

geometry of the terminal screen used for rendering the animation. The geometry must be given as the number of columns and the number of rows on the screen separated by the character "x". For example "82x19" for an 82 columns by 19 rows screen.

-t, --template=TEMPLATE

Set the SVG template used for rendering the SVG animation. TEMPLATE may either be one of the default templates (gjm8, dracula, solarized_dark, solarized_light, progress_bar, window_frame, window_frame_js) or a path to a valid template.

-h, --help

Print usage and exit

-v, --verbose

Increase log message verbosity

SVG TEMPLATES

Templates make it possible to customize the SVG animation produced by termtosvg in a number of ways including, but not limited to:

  • Specifying the color theme and font used for rendering the terminal session
  • Adding a custom terminal window frame to the animation to make it look like a real terminal
  • Adding JavaScript code to pause the animation, seek to a specific frame, etc

See the dedicated manual page for more details.

ENVIRONMENT

SHELL

termtosvg will spawn the shell specified by the SHELL environment variable, or /bin/sh if the variable does not exist. Spawning a new shell is necessary so that termtosvg can act as an intermediary between the shell and the pseudo terminal and capture all the data sent to the terminal.

EXAMPLES

Record a terminal session and produce an SVG animation named animation.svg:

termtosvg animation.svg

Record a terminal session and render it using a specific template:

termtosvg -t ~/templates/my_template.svg

Record a terminal session with a specific screen geometry:

termtosvg -g 80x24 animation.svg

Record a terminal session in asciicast v2 format:

termtosvg record recording.cast

Render an SVG animation from a recording in asciicast format

termtosvg render recording.cast animation.svg