ncid-modules man page

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/share/ncid/ncid-<name>
/etc/ncid/conf.d/ncid-<name>.conf
/etc/ncid/ncid.conf

See Also

ncid.1, ncid.conf.5, ncid-initmodem.1, ncid-kpopup.1, ncid-mysql.1, ncid-mythtv.1, ncid-notify.1, ncid-page.1, ncid-samba.1, ncid-skel.1, ncid-speak.1, ncid-wakeup.1 ncid-yac.1

Info