xsr

X Steps Recorder

This program is a clone of PSR for Windows, a program that allows users to make a recording of all of the steps they took. (It's like a screen recorder except it doesn't record a video.)

The main differences are that this only runs on Linux, that it records your keystrokes too (!), and that it saves the output as standard html (base64-uri-encoded images) rather than mhtml. This allows for easy editing of the resultant file, such as to remove passwords you typed (which is why psr doesn't record keystrokes in the first place).

Installation

See the Releases Page. Make sure you have scrot installed; I recommend that you have imagemagick and xdotool installed as well (to add pointer to screenshots).

Usage

Usage: xsr [options] [outfile]

Options:

  -o|--out outfile		Output file name (also can be first argument)
  -e|--edit-images-before-save	Edit images before saving file
  -d|--image-deps		Do not convert images to base64; instead, output the dependent file and it's resources directory
  -c|--image-extension=ext	Extension of image output (png or jpg)
  -u|--capture-focused		Captured the focused window only
  -q|--quiet			Supress output to STDOUT
  --mouse-icon|--cursor=file	Specify cursor image (default: the one installed to /usr/share/xsr/Cursor.png)
  --no-mouse			Do not add mouse to screenshots
  --countdown[=seconds]		Display countdown (default 5)
  --no-countdown		Don't display countdown
  -h|--help			Print this message

To quit, press Break (usually Shift+Pause). Ctrl+C works most of time fine too, although xsr will record that keypress.

Notes for this file

Please don't edit this file (README.md) directly! Please edit rather README.md.m4, and run make README.md after. You can commit the generated changes in README.md along with the manual changes in README.md.m4.