This document describes the use of the Kusari Licence Management System for INSTITUTION licences.
Each product is controlled by based on its Product Code. This is an 8 or 9 character identifier, such as ASW3210NA.
To use a product Kusari must be able to find the Licence Key for that product. This key is usually stored in a file; in this case the key consists of a line which begins with the product code followed by the word INSTITUTION and some further data which validate the key.
Kusari looks for licence information based on the NAG_KUSARI_FILE environment variable. This variable should contain a file name (path), a licence server specification, or a comma-separated list of file names and licence servers.
For INSTITUTION licences, the licence key should be stored in the registry or in a file; if in a file, the file name should appear in the NAG_KUSARI_FILE environment variable. If other products controlled by Kusari are being used, this variable may already exist. You can place the INSTITUTION key into the same file as an existing licence, or you place it in a new file and add the new file name to the list in NAG_KUSARI_FILE.
The INSTITUTION licence cannot be handled by a licence server, it can only be stored in a file or in the registry.
A file name can contain any printing character except comma (,), semi-colon (;) or at-sign (@). A colon (:) is permitted only following a single drive letter at the beginning of the filename. For example, c:\somedir\somefile.something.
A licence server specification consists of a server name (or IP number) followed by a colon, and optionally by a port number. For example, some_machine.some_company.com:.
When a product requests a licence, Kusari will visit each file, or ask each server, in turn, until it finds one with a potential licence. It will then attempt to check out a licence from that source; if this fails the failure will be reported and no further sources will be checked.
If the environment variable NAG_KUSARI_FILE is not set, Kusari will look for the files nag.key, nag.licence and nagware.licence in the current working directory (in that order). Depending on the software product it might also look for these files in the product's installation directory.
The environment variable may be set as follows:
A single machine licence is provided in a licence file; this may be stored in the registry using klreg (see later section) or accessed directly by the software as determined by the NAG_KUSARI_FILE environment variable (see above).
A licence file may contain blank lines, comment lines (beginning with a '#' or '!' character, and licence key lines. Here is a sample licence file:
! Licence file for Fred Nurke's Machine. ! A full licence for the NAGWare f95 compiler, Release 4.1 NPW3241NA FULL "qfrdwhyMoQFkfpm5e6ESprJmtE" ! A trial licence for the NAGWare f95 compiler, Release 5.0 NPW3250NA TRIAL 2004/10/05 "EMnxidA3oeojOFlYvi5ibxPjB7" ! An INSTITUTION licence for the N-SEA product. ASW3210NA INSTITUTION Nurke001:3853146 "9wny+nBSh9Cpekje4dZDoobo5K" ! That's all folks.
Depending on the specific hardware features of a machine, a licence key may contain multiple key specifications, e.g.
NPW3242NA FULL "xhhhTkzEiUPgdIpwIbCHgrBjjv" "EMnxidA3oeojOFlYvi5ibxPjB7"The purpose of the additional key(s) is to ensure that the licence software functions correctly even for machines with unusual hardware, and has no significance for the user.
When the evaluation is finished, it is recommended that the trial licence key lines be deleted from the licence file.
If the application reports ``Error: Licence file not found'', check