Content-type: text/html Manpage of OUT2OSD

OUT2OSD

Section: User Commands (1)
Index Return to Main Contents
 

NAME

out2osd - Output to TiVo On Screen Display  

SYNOPSIS

out2osd [options] [file(s)]

Options:

[-C configfile | --config configfile]
[-F FontName   | --fontname FontName]
[-S FontSize   | --fontsize FontSize]
[-T 0/1        | --freetype 0/1]
[-d delay      | --delay seconds]
[-b color      | --background color]
[-f color      | --foreground color]
[-l line       | --line number]
[-c column     | --column number]
[-V            | --version]
[-h            | --help]
 

DESCRIPTION

OUT2OSD displays text uning the TiVo On Screen Display (OSD). There are 16 lines and 33 columns, using the built-in font. It displays in 8 bit color, on a TiVo Series1, so there are 256 colors. If no file is given, stdin is displayed on screen. If one or more files are specified, then each file is displayed for "delay" seconds. It is assumed each file will fit on screen, otherwise only the tail end of the file that fits on screen will be displayed.

In order to use freetype fonts, the environment variable $FONT_PATH must be set in the .bash_profile or .profile:

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

OPTIONS

-C <file> | --config <file>
Set the configuration file.
Default: /var/hack/etc/out2osd.conf
-F <file> | --fontname <file>
Set the font file.
Default: /var/hack/share/fonts/Comic_Sans_MS.ttf
-S FontSize | --fontsize FontSize
Set the freetype font size, the range is 20 to 50.
Default: 24
-T 0/1 | --freetype 0/1
use built-in font or freetype fonts, range is 0 to 1
Default: 0
-b color | --background color
Set the background color. Valid colors:
transparent1, grey, white1, white2, white3, transparent2, blue, green, olive, orange, turquoise, red3, yellow, black1, transparent3, black2
Default: black1
-c column | --column number
Set the column, the range is 0-32.
Default: 1
-d delay | --delay seconds
Set the time the text is on screen, the minimum value is 1.
Default: 10 seconds.
-f color | --foreground color
Set the foreground color. Valid colors:
transparent1, grey, white1, white2, white3, transparent2, blue, green, olive, orange, turquoise, red3, yellow, black1, transparent3, black2
Default: white3
-l line | --line number
Set the line number, the range is 0-15.
Default: 1
-V | --version
Display the version number.
-h | --help
Display a help message.
 

CONFIG FILE

The config file is used to set options. Options are set on a command line, beginning with the word set. A line is broken up into words. A word is either a string of non-blank characters, everything between double quotes, or an equal sign.

The config file understands 3 types of lines:

blank line
skip it
comment line, beginning with '#'
skip it
command line, beginning with 'set'
set ITEM = VALUE [ITEM = VALUE] [...]
where ITEM = delay, line, column, foreground, background
 

CONFIG FILE EXAMPLES

Set the delay value to 60 seconds:

    set delay = 60

Set the background to transparent:


    set background = transparent1

Display text on the last line


    set line = 16
 

DIAGNOSTICS

    "Return Code"   Meaning
    -----------     -------
          0         Successful
       -100         Usage
       -101         Invalid background color name
       -102         Invalid column number
       -103         Invalid delay number
       -104         Invalid foreground color name
       -105         Invalid line number
       -106         Could not open font file
       -107         Invalid font size
       -108         Freetype enable must be 0/1
       -109         Config file error
         -?         System error
 

REQUIREMENTS

A Hacked series 1 or series 2 TiVo  

SEE ALSO

ncid.1, ncidd.8


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
CONFIG FILE
CONFIG FILE EXAMPLES
DIAGNOSTICS
REQUIREMENTS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 13:26:52 GMT, October 04, 2016