***      YAC: Yet Another Caller ID Program - TiVo Listener     ***
*** Copyright (C) 2002 Jensen Harris (jensen@sunflowerhead.com) ***
***                http://www.sunflowerhead.com                 ***

WELCOME

Thanks for checking out YAC.  YAC is a Caller ID system that uses
the modem in your Windows-based computer to monitor incoming phone
calls.  When a phone call is received, YAC displays the Caller ID
info on the computer screen.  YAC also contacts any "YAC Listeners"
(such as your TiVo) on the network and sends them Caller ID
information as well.  The TiVo Listener (this program) receives
that information and displays Caller ID on your TV screen.

YAC can also be used to send short text messages from the YAC server
computer to any listeners (such as your TiVo) on the network.


ACKNOWLEDGEMENTS

A couple of acknowledgements are in order.  YAC was inspired by
the "elseed" TiVo Caller ID program.  Unfortunately, my TiVo's
modem was not consistently picking up Caller ID information, so I
was out of luck.  However, the YAC TiVo Listener is based on
"elseed", especially the very robust code to handle the hardware
display.  No one has done it better, and the YAC TiVo Listener
display code is taken directly from "elseed" (which based its
display code, in turn, on "tivobi").


GETTING STARTED

YAC is licensed and distributed under the GNU General Public License.
Be sure to read the LICENSE file before proceeding.

Do not use WinZip to unpack YAC for TiVo on your Windows computer.
Instead, use ftp (in binary mode) or rsync or another means of file
copy to move the downloaded file to your TiVo.  Then, change to the
directory in which you moved the downloaded file and issue these
commands to unpack YAC:

  gzip -d yac-0.15-tivo.tar.gz
  cpio -H tar -i < yac-0.15-tivo.tar
  chmod 777 yac

(You may need to give a more complete path if the downloaded file is
not in your path.)

That should leave you with three files: the YAC program, this README,
and the LICENSE.  Once you have read the README and LICENSE, you are
welcome to remove them from your system.  The YAC program itself can
go anywhere on your TiVo: I have mine located at /var/hack/bin/yac.


HOW TO RUN YAC

To run YAC, simply type:

  yac

If you want to run yac in the background, you can type instead:

  yac &

At this point, YAC will be listening on your network, waiting for
the YAC server to notify it when calls come in.

YAC on the TiVo is NOT a Caller ID program by itself.  It does not
use the internal modem of the TiVo in any way.  Instead, the YAC
TiVo program is a "listener."  It listens for Caller ID information
to be broadcast on the network from a YAC server that is connected
to the phone line.  When YAC TiVo Listener receives that information,
it is displayed on the TV screen.

You must have a YAC server running for this listener to be useful.
The YAC server runs on Windows 2000 or later.  You can download the
server, as well as additional listeners, at the YAC web site (see
below for contact information.)  All YAC software is free.

To use this version of YAC for TiVo, you must be running YAC for
Windows version 0.15 or later.


RUNNING YAC AT STARTUP

If you want to run YAC automatically when your TiVo starts up,
simply add this line to the end of your /etc/rc.d/rc.sysinit file:

  /var/hack/bin/yac &

Make sure you type the complete and accurate path to yac.


OTHER OPTIONS

There are some configuration options available for YAC.  Type:

  yac -h

to see a full list of these options.  Mostly, you'll probably want
to leave things as they are.

This command:

  yac -D

runs YAC in a verbose debugging mode.  If you are very interested in
what YAC's up to, you can run YAC in this mode to get up-to-the-minute
status on what YAC is doing.  This might help you troubleshoot problems.


CONTACT INFO AND BUG REPORTING

You can contact the author with questions or bug reports via e-mail.
You can also post a message on the TiVo Community Forum Underground,
as I read that message board and can reply to your question there.

Web: http://www.sunflowerhead.com/software/yac/
E-mail: jensen@sunflowerhead.com
TiVo Community Forum: http://www.tivocommunity.com/ (TiVo Underground)


QUESTIONS AND ANSWERS

Q: When I try to run YAC, I get a "permission denied" error.
A: You haven't given yourself permission to execute YAC.  Type:

      chmod 777 yac


Q: I am running YAC, but nothing happens when the phone rings.
A: First thing: do you have a YAC server running on your Windows
   computer?  You need to have a YAC server running on your network
   in order to relay the Caller ID information to TiVo.

   Second thing: If you do have a YAC server, is the Caller ID
   information popping up on your computer screen?  If not, see the
   troubleshooting information for the YAC server.

   Third thing: If Caller ID is showing up on your YAC server, did you
   remember to add your TiVo as a listener?  Click on the YAC icon on
   your Windows computer and click "Select Listeners...".  Enter "TiVo"
   as the computer type, and type the IP Address of your TiVo (for
   instance: 192.168.1.200).

   Fourth thing: Can you ping your TiVo from your computer?  Type:

      ping 192.168.1.200 (substitute the correct IP address)


Q: Can I download the source code for YAC?
A: Yes, the source code is licensed and distributed under the GNU
   General Public License.  See the YAC web site to download the source
   code to YAC.


VERSION HISTORY

Version 0.10 - 11 August 2002
Initial version of YAC TiVo Listener.

Version 0.15 - 11 September 2002
Added support for receiving and displaying short text messages.