Site Configuration Keyword Reference

for LISTSERV® version 15.5

 

Last updated 5 Dec 2007

 

Defining site configuration keyword values

After making changes, restart the server

Alphabetical keyword reference

 

Defining site configuration keyword values

 

The syntax used to define these values differs from platform to platform. For each site configuration keyword we have provided examples for all systems affected by the keyword. A general syntax guide follows:

 

VM

 

The configuration file is located on LISTSERV's 191 minidisk and is called LOCAL SYSVARS.

 

KEYWORD = 'somevalue'

 

Note that for VM the space on either side of the "=" sign is required. For substitutions, follow the REXX language syntax. For instance,

 

MAILER = 'mailer@'NODE

MYDOMAIN = NODE 'some.host.com'

 

OpenVMS

 

OpenVMS users should use the new Site Configuration Wizard in the web interface to modify the site configuration file, rather than editing it by hand. It is also possible to use the LISTSERV_CONFIGURE.COM application, provided with the software, to modify the site configuration file. However, LISTSERV_CONFIGURE.COM may not allow you to edit all possible keyword settings.

 

While hand-editing SITE_CONFIG.DAT is not recomended, for situations that may require it, SITE_CONFIG.DAT entries look like this:

 

NODE      "LISTSERV.EXAMPLE.COM"

MYDOMAIN  "LISTSERV.EXAMPLE.COM"

LOCAL     "*.EXAMPLE.COM"

DBRINDEX  "1"

 

All values, including numerics and Booleans, must be in double quotes.

 

Unix (all)

 

Unix users should use the new Site Configuration Wizard in the web interface to modify the site configuration file (go.user), rather than editing it by hand. However, it is possible to edit the file by hand if necessary.

 

Keywords requiring text values:

 

KEYWORD="somevalue"

 

Keywords requiring numeric values (ie, Boolean settings):

 

KEYWORD=number

 

eg, NODE="listserv.mynode.com", but DBRINDEX=0 .

 

For substitutions, follow this example:

 

MYDOMAIN="$NODE some.host.com"

 

Note that under unix, all site configuration variables must be exported. The commonly-used variables are exported for you in the go script. Anything else must be exported at the end of go.user.

 

Windows (all)

 

In LISTSERV 15.0 and following, the old SITE.EXE application used to edit the configuration file (site.cfg) is obsolete and its use deprecated. Windows users should use the new Site Configuration Wizard in the web interface to modify the site configuration file, rather than editing it by hand. However, it is possible to edit the file by hand if necessary.

 

KEYWORD=somevalue

 

Note that both text and numerics, unless specifically noted in the keyword documentation, do not require (and should not use) double quotes.  There are a few exceptions to this general rule.

 

For substitutions, follow this example:

 

MYDOMAIN=%NODE% some.host.com

 

Restart the Server (in some cases)

 

In LISTSERV 15.0 and following, any configuration change made via the web interface that requires a manual server restart will cause a message to that effect to be displayed.

 

Windows sites using the SMTPL.EXE "listener" should also stop and restart the listener as some changes will affect it as well.

 


Alphabetical Keyword Reference

 

Please see the full documentation of each keyword for platform availability.

 

Keywords not hyperlinked are obscure, undocumented VM-only settings.  If you are a VM site and need help with these settings, please contact L-Soft customer support.

 

If the "Introduced" column is blank, the keyword existed prior to LISTSERV 1.8d (13).

 

Keyword

Introduced

Abstract

ALL_REQUEST_ALLOWED_USERS

14.0

Specifies non-POSTMASTER users who are allowed to post to the ALL-REQUEST alias.

ANTI_VIRUS

14.0

Turns LISTSERV's real-time anti-virus scanning on or off.

AVS_DROP_SPAM

14.4

One of two variables that may be set on servers that submit mail to the external LISTSERV AVS for virus and spam scanning, which can help deal with DoS mail-bombing attacks.

AVS_DROP_VIRUS

14.4

One of two variables that may be set on servers that submit mail to the external LISTSERV AVS for virus and spam scanning, which can help deal with DoS mail-bombing attacks.

BITNET_ROUTE

 

Defines the hostname of a machine that knows how to route mail to BITNET addresses

BOUNCES_TO

1.8d (13)

Tells LISTSERV where to send bounces not related to any particular list

CHANGELOG_DBMS

14.0

Tells LISTSERV to mirror a copy of all or selected changelogs to DBMS.

CHANGELOG_DBMS_CONNECTION

14.0

Used in conjunction with CHANGELOG_DBMS. Sets the DBMS connection characteristics for mirroring changelog data to DBMS.

CHANGELOG_DBMS_TABLE

14.0

Used in conjunction with CHANGELOG_DBMS. Sets the DBMS table characteristics for mirroring changelog data to DBMS.

CHECKMDISK

 

List of library minidisks to be checked at startup

CLI_*

14.0

Three configuration variables under the CLI_* rubric are available for use with DBMS/Mail Merge.

CMDPIPE_HOSTNAME

1.8c (12)

Defines the hostname used by the LCMD utility

CMSNAME

 

The name of the CMS system to be used on IPL commands

CRASH_MONITOR

1.8c (12)

Where to send VMS or NT crash reports

CREATEPW

 

The password required to create new lists

DATABASE

 

Indicates whether the (old) VM database functions are enabled or not

DBMS_*

1.8d (13)

Several configuration variables under the DBMS_* rubric are available for use with the DBMS/Mail Merge.

DBRINDEX

1.8c (12)

Determines whether or not the new LISTSERV database functions use reverse indexing

DEBUG_LOG_PW

14.3

Debug setting to display passwords in LISTSERV's log file

DEBUG_LOG_TCPGUI

14.3

Show fully-logged TCPGUI commands for debugging purposes.

DEFAULT_CHANGELOG_PERIOD

14.0

Sets a default period for rotating change-logs.

DEFAULT_DIST_BACKGROUND

15.0

Boolean value that sets the server default for background DISTRIBUTE

DEFAULT_LANGUAGE

1.8d (13)

Sets the default national language template for use by all lists on the server

DEFAULT_LOOPCHECK

14.5

Sets the server default for the list-level Loopcheck keyword

DEFAULT_MISC_OPTIONS

14.5

Sets the server default for the list-level Misc-Options keyword

DEFAULT_PROBE

1.8d (13)

Sets defaults for passive probing

DEFAULT_SPLIT

1.8b (11)

Provides a default value for the "SPLIT=" command line keyword

DELAY

 

The delay between  two reader-scan operations

DIAGD4

 

Indicates whether LISTSERV should use diagnose X'D4' to mimic the RSCS origin on files it DISTRIBUTEs

DIST_ALLOWED_USERS

1.8d (13)

Space-separated list of non-POSTMASTER users who are to be allowed to use DISTRIBUTE

DIST_BACKGROUND_CHUNKSIZE

15.0

Tuning parameter for background DISTRIBUTE.

DIST_BACKGROUND_JOBSIZE

15.0

Tuning parameter for background DISTRIBUTE.

DIST_FORWARD

14.4

Enables and tunes DISTRIBUTE "workers".  This is a tuning feature for embedded mail merge.

DIST_FORWARD_MINSIZE

15.0

The minimum message size, in kilobytes, to make use of DISTRIBUTE workers

DIST_FORWARD_THRESHOLD

14.4

Enables and tunes DISTRIBUTE "workers".  This is a tuning feature for embedded mail merge.

DIST_OWNER_MAIL_MERGE

1.8d-2000b (13.2)

Determines whether or not list owners may use the mail-merge feature for their lists.

DIST_SECURITY

1.8d (13)

Boolean value which controls security validation feature for the DISTRIBUTE command. WARNING: See the full documentation before changing this value.

DKIM_SIGN

14.5

Specifies DomainKeys domains for which you are able and willing to sign

DKIM_SIGN_ALL

14.5

Boolean value which directs LISTSERV to sign all messages for which it has a suitable DomainKeys private key.

EMBEDDED_MAIL_MERGE

14.4

Boolean value which determines whether or not LISTSERV may use a standard SMTP mailer to send mail-merge messages.

FILEDISK

 

The filemode of  the DEFAULT disk  to be used  for storing files via a PUT command

FILEMAXL

 

The maximum number of  lines for any incoming non-mail file to be accepted

FILTER_ALLOW

1.8d (13)

Defines users or classes of users who should be exempt from LISTSERV's standard filter

FILTER_ALSO

1.8b (12)

Defines users or classes of users who should not be allowed to post to any list on the server.

FIOC_INUSE_RETRY

 

Defines the number of seconds LISTSERV will try to open a file locked by an external process

FIOC_TARGET

 

Defines (in kilobytes) the "target size" for LISTSERV's file cache.

FIOC_TRIM

 

Defines (in kilobytes) the threshold at which point LISTSERV should start aggressively trimming the cache.

FIOC_WARNING

 

Defines (in kilobytes) the cache size at which LISTSERV should write a warning to the console log.

FOREIGN_ANTI_VIRUS

14.4

Add anti-virus protection for those Windows sites that for policy or other reasons must run anti-virus systems other than F-Secure on their servers.

GETQWAIVE

 

Internet addresses of  persons to  be granted  an "infinite" GET quota

HIDE_TRACEBACK

14.3

Determines whether or not error tracebacks are shown to non-postmasters.

IGNORE

 

(VM only) A list of userid@nodes whose messages and files are to be ignored

IGNORE_EMAIL_CASE

14.1

Provided for DBMS lists with UEMAIL fields to work around RFC821 requirement that an email address local-part must be evaluated case-sensitively.

IGNORE_EXTERNAL_PRIME

1.8d (13)

Boolean value determining whether or not LISTSERV will ignore the PRIME setting on incoming DISTRIBUTE jobs.

INDEX_VIA_GETPOST

1.8c (12)

On VM, determines whether INDEX subscriptions use GETPOST or old-style database jobs by default.

INSTPW

 

The  optional local  "installation password"  associated with the INSTALL command

JOB_STAT_DEFAULT

1.8d (13)

Boolean value determining whether or not the "Summary of resource utilization" is generated or suppressed in a CJLI JOB command response.

LDAP_*

15.5

Seven configuration variables under the LDAP_* rubric for configuring LDAP support.

LICENSE_WARNING

 

Toggles license warnings on and off. WARNING: See the full documentation before changing this value.

LIST_ADDRESS

 

Default value for the "List-Address=" keyword

LIST_EXITS

1.8a (10)

Filenames of executable files that can be defined as exits by an "Exit=" list header keyword

LMCPUT

 

Boolean variable indicating how PUT commands for datafiles associated  with the LMC FAC are handled

LOCAL

 

a list  of nodes to be associated with  the hardcoded LCL FAC.  Also used as the default for the "Local=" list keyword

MAILER

 

Internet address of the local mailer

MAILMAXL

 

the maximum number of  lines for an incoming  MAIL file to be accepted

MAXBSMTP

 

Maximum number  of 'RCPT TO:'  lines per BSMTP file  sent to the mailer

MAX_CONSECUTIVE_SUBS

14.3

The maximum number of lists to which consecutive subscription attempts will be accepted from a given subscriber, to prevent "spoofing" attacks.

MAXDISTL

 

(HPO only) The maximum number of recipients to be listed in the LISTSERV console log as recipients of an SMTP job

MAXDISTN

 

Maximum number of recipients in forwarded DISTRIBUTE jobs

MAXGET

 

Maximum number of GET requests a user can make per day

MAXGETK

 

Maximum number of kilobytes of data a user may obtain a day via GET requests.

MDISK.cuu

 

Information about library minidisks

MSGD

 

Userid  of the virtual machine running a  RFC1312/MSP server, if "Internet TELL" support is desired

MYDOMAIN

 

The list of domain names  which are equivalent to NODE--e.g., MX addresses, CNAMEs, etc.

MYORG

 

Short organization name that appears in the RFC-822 "Sender:" line.

NDMAIL

 

Whether to send mail to the local MAILER in Netdata format

NODE

 

Internet address of this LISTSERV host

NO_NJE_JOBS

 

Directs a  VMS™  server  running in  NJE  mode  to send  all outgoing server-to-server requests  via the Internet

OCI_*

1.8d (13)

Three configuration variables under the OCI_* rubric are available for use with the DBMS/Mail Merge.

ODBC_*

1.8d (13)

Three configuration variables under the ODBC_* rubric are available for use with the DBMS/Mail Merge.

OFFLINETHR

 

Defines   the  system   and   RSCS  spool   thresholds  for   automatic offline/online control

PLAIN_FROMLINE

14.3

Controls the "verboseness" of LISTSERV's administrative From: line.

POSTMASTER

 

A list of  userid@nodes, of which  the first one  is the "main" postmaster (to receive transferred files).

PRIMETIME

 

Defines  the  "prime  time"  for your  node

QUALIFY_DOMAIN

1.8b (11)