# Pagerfeeder Configuration File Commands

(last revised 5 December 1996)
Page Index:
1. Example configuration file
2. Functional command listing
3. Alphabetic command listing & description

On startup, pagerfeeder reads the configuration file named on the command line. Commands in this file set up all parameters used in processing Earthworm system TYPE_PAGE messages. In the control file, lines may begin with a valid pagerfeeder command (listed below) or with one of 2 special characters:

>     #  marks the line as a comment (example: # This is a comment).

>     @  allows control files to be nested; one control file can be
>        accessed from another with the command "@" followed by
>        a string representing the path name of the next control file
>        (example: @model.d).

Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!).

## 1. EXAMPLE CONFIGURATION FILE

    #
    #                    Pager Feeder Configuration File
    #                           (pagerfeeder.cnf)
    #
    #   This file is used to control the heartbeat intervals of the
    #   pagerfeeder program.
    #
    #   In this file, comment lines are preceded by #.
    #
    #
    MyModuleId   MOD_PAGERFEEDER
    #
    #    is the time in seconds between heartbeats
    #   sent to the status manager.  The status manager will report an error
    #   if heartbeats are not received from the status manager at regular
    #   intervals.
    #
    HeartbeatStatmgr  30
    #
    #    is the name of the transport ring that pagerfeeder
    #   lives on.  Should be the same ring as the statmgr.
    #
    RingName       HYPO_RING
    #
    # List the message logos to grab from transport ring:
    #
    #              Installation       Module       Message Type
    GetPagesFrom   INST_MENLO      MOD_WILDCARD    # pager msg
    #
    #    sets switch for writing a log file to disk.
    #   If 1, write a log file; if 0, don't.
    #
    LogFile  0

## 2. FUNCTIONAL COMMAND LISTING

Below are the commands recognized by pagerfeeder, grouped by the function they influence. All of the commands are required; they must be specified in the control file in order for pagerfeeder to operate.

             Earthworm system setup:
                    GetPagesFrom	   	required
    		HeartbeatStatmgr 	required
     		MyModuleId	   	required
    		RingName	   	required

    	Output Control:
    		LogFile		   	required

## 3. ALPHABETIC COMMAND LISTING & DESCRIPTION

In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and the values used by Calnet are listed after each command description.

    command arg1				processed by		function

    GetPagesFrom inst mod_id		pagerfeeder_config	Earthworm setup

> Controls the pager messages input to pagerfeeder. pagerfeeder will only process TYPE_PAGE messages that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module. Up to 2 "GetPagesFrom" command may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force pagerfeeder to process all pager messages, regardless of their place of origin.

>     Default:  none
>     Calnet:   GetPagesFrom  INST_MENLO  MOD_WILDCARD

    HeartbeatStatmgr nsec			pagerfeeder_config	Earthworm setup

> Defines the number of seconds nsec between TYPE_HEARTBEAT messages issued by pagerfeeder.

>     Default:  none
>     Calnet:   HeartbeatStatmgr 30

    LogFile switch				pagerfeeder_config	output

> Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, pagerfeeder will write a daily log file(s) called pagerfeederxx.log_yymmdd where xx is pagerfeeder's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable).

>     Default:  none

    MyModuleId mod_id			pagerfeeder_config	Earthworm setup

> Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number.

>     Default:  none
>     Calnet:   MyModuleId MOD_PAGERFEEDER

    RingName ring				pagerfeeder_config	Earthworm setup

> Tells pagerfeeder which shared memory region to use for input/output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region.

>     Default:  none
>     Calnet:   RingName HYPO_RING

Module Index | Pagerfeeder Overview