NAME

ncid-modules - NCID client output modules overview

DESCRIPTION

NCID output modules are used to extend the functionality of the client. They are mostly simple shell scripts although there is one program for the TiVo that acts like a module.

Module names are of the format: ncid-<name>.

Modules are normally called by the client using the command line:

ncid --no-gui --program ncid-<name>

The client can only call one module at a time, but multiple clients can each have a different output module.

Each module may have a configuration file called ncid-<name>.conf>. The ncid-<name>.conf> file understands three line types:

blank line:: ignored

comment line:: begins with a '#' and is ignored

shell variable:: set to a value, for example: foo=bar

The current modules distributed with NCID are:

ncid-alert

ncid-initmodem

ncid-kpopup

ncid-mysql

ncid-mythtv

ncid-notify

ncid-page

ncid-samba

ncid-skel

ncid-speak

ncid-tivo

ncid-wakeup

ncid-yac

FILES

/usr/local/share/ncid/ncid-<name>

/usr/local/etc/ncid/conf.d/ncid-<name>.conf

/usr/local/etc/ncid/ncid.conf

NAME

DESCRIPTION

FILES

SEE ALSO