congif.1

   1 .TH CONGIF 1
   2 .SH NAME
   3 congif \- convert \fBscript(1)\fR output to GIF
   4 .SH SYNOPSIS
   5 .B congif
   6 [options] \fItimings\fR \fIdialogue\fR
   7 .br
   8 .SH DESCRIPTION
   9 \fBcongif\fR is an experimental tool that generates GIF animations of console
  10 sessions. Like \fBscriptreplay(1)\fR, it reads the output of \fBscript(1)\fR,
  11 including timing information. Unlike \fBscriptreplay(1)\fR, \fBcongif\fR parses
  12 the dialogue and encodes it as a GIF animation.
  13 .PP
  14 \fItimings\fR is the path to a file generated by \fBscript(1)\fR's \fB\-t\fR
  15 option.
  16 .PP
  17 \fIdialogue\fR is the path to a file generated by \fBscript(1)\fR's regular
  18 output (also known as \fItypescript\fR).
  19 .SH OPTIONS
  20 .TP
  21 \fB\-o\fR \fIoutput\fR
  22 set the file name of the resulting GIF.
  23 .PP
  24 The default is \fIcon.gif\fR.
  25 .TP
  26 \fB\-m\fR \fImaxdelay\fR
  27 set the maximum delay (in seconds), as in \fBscriptreplay(1)\fR
  28 .PP
  29 When this option is specified, the delay of each frame will be limited to
  30 \fImaxdelay\fR. This option is applied before \fB\-d\fR when both are specified.
  31 .TP
  32 \fB\-d\fR \fIdivisor\fR
  33 set the delay divisor, as in \fBscriptreplay(1)\fR
  34 .PP
  35 When this option is specified, each frame delay will be divided by \fIdivisor\fR,
  36 resulting in a sped-up animation. For instance, \fB\-d 2\fR will make a GIF that
  37 is twice as fast as the real session recorded.
  38 .TP
  39 \fB\-l\fR \fIcount\fR
  40 make a looping animation
  41 .PP
  42 The resulting GIF will instruct viewers to display the animation \fIcount\fR
  43 times. The special \fIcount\fR value of \fB0\fR will make the GIF loop forever.
  44 .PP
  45 When this option is not specified, \fBcongif\fR will not add looping information
  46 to the GIF file. For most GIF viewing programs, this is equivalent to
  47 \fB\-l 1\fR.
  48 .TP
  49 \fB\-f\fR \fIfont\fR
  50 select the bitmap font to be used in the output
  51 .PP
  52 \fIfont\fR must be the path to a MBFv1 bitmap font. \fBcongif\fR comes with a
  53 default font that will be used when this option is not given.
  54 .TP
  55 \fB\-h\fR \fIlines\fR \fB\-w\fR \fIcolumns\fR
  56 set the terminal size of the session to \fIlines\fR and \fIcolumns\fR
  57 .PP
  58 \fBcongif\fR needs to know the size of the terminal on which the session was
  59 recorded. By default, it uses the current size of the terminal on which
  60 \fBcongif\fR is being executed.
  61 .TP
  62 \fB\-c\fR \fIswitch\fR
  63 specify whether to show or hide the cursor in the animation
  64 .PP
  65 If \fIswitch\fR is \fB0\fR or \fBoff\fR, the cursor will be hidden during the
  66 entire animation. If \fIswitch\fR is \fB1\fR or \fBon\fR, the cursor will be
  67 shown as in the recorded session (this is the default).
  68 .PP
  69 Note that most terminal programs can hide or show the cursor themselves
  70 appropriately. This option is only necessary to deal with programs that do not
  71 hide the cursor when they should, as is the case in programs targetting old
  72 terminals that might not have cursor hiding capabilities.
  73 .TP
  74 \fB\-q\fR
  75 set quiet mode
  76 .PP
  77 The progress bar will not be shown.
  78 .TP
  79 \fB\-v\fR
  80 set verbose mode
  81 .PP
  82 The dialogue parser will write logs to stderr.
  83 .SH BUGS
  84 \fBcongif\fR can only parse dialogues recorded in the Linux console or any other
  85 terminal emulator that is compatible with \fBconsole_codes(4)\fR.
  86 .PP
  87 It is not possible to automatically determine the size of the terminal where the
  88 session was recorded. If the correct size is not given via \fB\-h\fR and
  89 \fB\-w\fR, \fBcongif\fR will not be able to generate an accurate animation.
  90 .SH SEE ALSO
  91 \fBscript(1)\fR, \fBscriptreplay(1)\fR, \fBconsole_codes(4)\fR