Content-type: text/html Manpage of LCDNCID

LCDNCID

Section: User Contributed Perl Documentation (1)
Updated: 2018-06-03
Index Return to Main Contents
 

NAME

LCDncid - LCD Display NCID Client  

SYNOPSIS

 lcdncid [--configfile   | -C <filename>]
         [--debug        | -D]
         [--delay        | -d <1-3600 seconds>]
         [--help         | -h]
         [--lcdhost      | -l <[host][:port]>]
         [--log          | -L <0|1>]
         [--man          | -m]
         [--multi-screen | -M <0|1>]
         [--ncidhost     | -n <[host][:port]>]
         [--pidfile      | -p <filename>]
         [--priority     | -P <foreground|alert>]
         [--retry        | -r <seconds>]
         [--verbose      | -v <1-9>]
         [--version      | -V]
         [--timeout      | -t <1-300 seconds>]
 

DESCRIPTION

LCDncid is a NCID (Network Caller ID) client for LCD displays. It uses LCDproc to display the NCID information on the LCD display. NCID information is either Caller ID from a telephone call or a message.

LCDproc uses the LCD information information provided by the LCDproc server to automatically configure itself for the LCD display.

LCDncid supports LCD displays with at least 12 columns and with at least one row (12x1). It works best with a 20x4 LCD. If the LCD display has more than 4 rows, only the top 4 rows are used.

If either the LCDproc server or the NCID server connection goes away, or if either one is not available on startup, LCDncid will try to reestablish a connection unless the delay option is set to 0. It will keep trying, until the program is terminated, or it connects with the server.  

LCDd Priority Levels

LCDd will only show screens with the highest priority at that moment. If there are three info screens and one foreground screen, only the foreground screen will be visible. Only background, info and foreground screens will rotate. The alert screen will never rotate.
LCDd priority levels
    input:      The client is doing interactive input.
    alert:      The screen has an important message for the user.
    foreground: an active client
    info:       Normal info screen, default priority.
    background: The screen is only visible if no "info" screens exist.
    hidden:     The screen will never be visible.
 

OPTIONS

-C, --configfile <filename>
Specifies the configuration file to use. The program will still run if a configuration file is not found.

Default: /etc/ncid/lcdncid.conf

-D, --debug
Set debug mode to display information on screen.
-d, --delay <seconds>
Set the server reconnect delay time between 0 and 3600 seconds. If delay = 0, abort instead of trying to reconnect to a server.

Default: 0

-h, --help
Displays the help message and exits.
-l, --lcdhost <[host][:port]>
Specifies the LCDd server. Port may be specified by suffixing the hostname with :<port>.

Input must be <host> or <host:port>, or <:port>

Default: localhost:13666

-L, --log <0|1>
Turn on logging to /var/log/lcdncid.log.

Default: 0

-m, --man
Displays the manual page and exits.
-M, --multi-screen <0|1>
Turns multiple screens on or off for a 1-line LCD and a 2-line LCD.

A 1-line LCD gets 2 additional display screens and a 2-line LCD gets one additional display screen when multiple screens are turned on.

Default: 0

-n, --ncidhost <[host][:port]>
Specifies the NCID server. Port may be specified by suffixing the hostname with :<port>.

Input must be <host> or <host:port>, or <:port>

Default: localhost:3333

-p, --pidfile <filename>
Specifies the pidfile name to write. The program will still run if it does not have permission to write a pidfile. The pid filename that should be used is /var/run/lcdncid.pid.

Default: no pidfile

-P, --priority <foreground|alert>
Set the display priority.

The display priority for is used for updating the LCDd screen when a call or message arrives. The update priority can be set to "alert", if needed, when LCDd has other clients that use "alert".

Update priority levels: foreground, alert

The priority is reduced to "info" after the screen update. This cannot be changed.

LCDd priority levels used
    alert:      The screen has an important message for the user.
    foreground: an active client
    info:       Normal info screen, default priority.

Default: foreground

-t, --timeout <seconds>
Set the display time between 1 and 300 seconds.

Default: 10

-v, --verbose <level>
Set the verbose level between 1 and 9. Set the level to a higher number for more information. Only verbose levels 1-4 are used.
Verbose Levels
    1: Show start, program name, options
       Show server connect, disconnect and retry messages
       show a termination by signal
       show a errorExit
    2: Include LCDproc lines sent and received
    3: Include NCID lines received
    4: Include poll() wait and poll() event
-V, --version
Displays the version number
 

EXAMPLES

Enable logging to /var/log/lcdncid.log
lcdncid --log 1
Enable retry mode and retry every 30 seconds when a server disconnects
lcdncid --retry 30
Display Caller ID for 5 seconds.
lcdncid --timeout 5
Connect to NCID at localhost, port 3000.
lcdncid --ncidhost :3000
Connect to NCID at ncid.target.home, port 3000.
lcdncid --ncidhost ncid.target.home:3000
 

REQUIREMENTS

perl 5.6 or higher and perl(Config::Simple)

NCID (only server required): http://ncid.sourceforge.net/ncid/ncid.html

LCDproc: http://lcdproc.org/  

FILES

/etc/ncid/lcdncid.conf

/var/log/lcdncid.log  

SEE ALSO

lcdncid.conf.5, ncidd.8, ncidd.conf.5, ncidd.alias.5, LCDd.8, lcdproc.1

 

Index

NAME
SYNOPSIS
DESCRIPTION
LCDd Priority Levels
OPTIONS
EXAMPLES
REQUIREMENTS
FILES
SEE ALSO
This document was created by man2html, using the manual pages.
Time: 17:53:06 GMT, May 09, 2023