# INSTALL OUT2OSD on the TiVo

OUT2OSD is compiled to use directories under /var/hack.
You can change this if you like, by using the
command line to specify the location of the configuration
file, and then using the configuration file to set the
options for your new directory structure.

OUT2OSD will also use the environment variable FONT_PATH
to search directories for the font specified.  In your
.bash_profile add the following line:

    FONT_PATH=:/var/hack/share/fonts export FONT_PATH

The tar files creates the following:

                                   hack
                                   |
          -------------------------------------
            |          |           |          |
          share       bin         etc        doc
            |          |           |          |
          fonts     out2osd  out2osd.conf  out2osd
            |                                 |
            |                  ------------------------------------
            |                  |           |          |           |
       abbey_m1.ttf        INSTALL.TiVo  README  out2osd.1.txt   FONTS
                                                 out2osd.1.html

If you have a series 1 TiVo, Copy out2osd-VERSION.series1-tivo.tgz to the tivo.
If you have a series 2 TiVo, Copy out2osd-VERSION.series2-tivo.tgz to the tivo.
    - cd /var
    - tar -xzvf /PATH/out2osd-VERSION.series2-tivo.tgz
          where PATH is the path to the tar file
                VERSION is the out2osd version number.
      EXAMPLE: tar -xzvf /var/tmp/out2osd-0.7.series2-tivo.tgz

Edit /var/hack/out2osd.conf if you would like to change the defaults.
You can change the line, column, foreground, background, delay value,
use the built-in font or a freetype font, font file and font size.

The easiest way to test the display is to run the following:

	echo "Hello TiVo" | out2osd

The text will stay on screen for awhile.  The default is 10 seconds.

At any point, you can use command lines options to change the defaults
or override the configuration file settings.

To obtain a usage message: out2osd -h

Documentation is in the formatted man page: out2osd.1.txt