misc/autocue/files/autocue.1

   1 .\" $NetBSD: autocue.1,v 1.2 2007/02/24 12:16:12 agc Exp $
   2 .\"
   3 .\" Copyright © 2006 Alistair Crooks.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior written
  15 .\"    permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd February 24, 2007
  30 .Dt AUTOCUE 1
  31 .Os
  32 .Sh NAME
  33 .Nm autocue
  34 .Nd display text in X11 cut buffers timed depending on size of text
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl S Ar speed
  38 .Op Fl c Ar maxcut
  39 .Op Fl s Ar symbolic-speed
  40 .Op Ar
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility reads a text input file, and sends formatted output
  45 to the X11 cut buffers by using the
  46 .Ar xcb
  47 utility.
  48 .Nm
  49 will then wait for a period of time (dependent upon the speed
  50 settings), before sending the next paragraph of text to the next cut
  51 buffers.
  52 .Pp
  53 The options are as follows:
  54 .Bl -tag -width maxcuts
  55 .It Fl S Ar speed
  56 Takes a numeric value for speed, which is the number of characters
  57 per second that the text can be read.
  58 See also the
  59 .Ar s
  60 argument for some pre-defined rates.
  61 Slow readers can generally read at 3 characters per second, medium
  62 at 7 characters per second, and fast readers at 10 or more characters per
  63 second.
  64 .It Fl c Ar maxcut
  65 Provides the maximum number of X11 cut buffers which will be used.
  66 .It Fl s Ar speed
  67 Provides pre-computed
  68 .Ar fast ,
  69 .Ar medium and
  70 .Ar slow
  71 definitions for the speed.
  72 .Pp
  73 If
  74 .Nm
  75 is going too fast, then a SIGUSR2 signal
  76 delivered via
  77 .Xr kill 1
  78 will make it go one
  79 character per second slower.
  80 If
  81 .Nm
  82 is going too slowly, then a SIGUSR1 signal
  83 delivered via
  84 .Xr kill 1
  85 will make it go
  86 one character per second faster.
  87 .El
  88 .Sh EXIT STATUS
  89 The
  90 .Nm
  91 utility exits 0 on success, and \*[Gt]0 if an error occurs.
  92 .Sh SEE ALSO
  93 .Xr kill 1
  94 .Sh AUTHORS
  95 The
  96 .Nm
  97 was written by
  98 .An Alistair Crooks Aq agc@NetBSD.org .