HELP
 1
            QSHELP - 92069-16122 REV.1912 790220  
 1
 QUERY LANGUAGE COMMANDS
 1
  CREATE        STORE A PROCEDURE BY NAME IN A 'FMGR' FILE
  DATA-BASE     NAMES THE DATA BASE TO BE USED
  SELECT-FILE   NAMES THE SELECT FILE TO BE USED
  DESTROY       DELETES A PROCEDURE FILE
  DISPLAY       DISPLAYS A PROCEDURE FILE 
  EXECUTE       SCHEDULE A PROGRAM TO BE RUN FROM QUERY 
  EXIT          TERMINATE QUERY SYSTEM
  FIND          SELECT RECORDS FROM DATA-BASE 
  FORM          DISPLAY DATA-BASE SETS AND ITEMS
  HELP          INVOKE HELP PROCESSOR 
  LIST          CHANGE LIST LOGICAL UNIT
  REPORT        GENERATE A REPORT 
  UPDATE        ALTER DATA-BASE ITEMS 
  XEQ           CHANGE INPUT TO BATCH FILE
 1
  FOR MORE INFORMATION ENTER THE FOLLOWING COMMAND, 
 1
          HELP HELP;
 1
%%
HELP HELP 
 1
 FUNCTION - 
   THE HELP COMMAND PROVIDES FUNCTION, SYNTAX, AND
   OPERAND INFORMATION ON COMMANDS
 1
 SYNTAX - 
         HELP ['COMMAND NAME'[ 'TYPE OF HELP']] ; 
 1
   REQUIRED - NONE
   DEFAULTS - "ALL" IF FUNCTION, SYNTAX, OR 
              OPERANDS NOT SPECIFIED
   NOTE     - IF HELP IS ENTERED WITHOUT ANY
              OPERANDS A LIST OF AVAILABLE
              COMMANDS WITH A SHORT DESCRIPTION 
              OF EACH WILL BE DISPLAYED 
 1
   SYNTAX INTERPRETATION -
     1. USER SUPPLIED VALUES ARE IN APOSTROPHES.
     2. WORDS WITHOUT APOSTROPHES ARE TO BE ENTERED 
        AS SHOWN
     3. COMMAS AND QUOTES ARE TO BE ENTERED AS SHOWN
     4. BRACKETS ( [,] ) DESCRIBE OPTIONAL PARAMETERS 
     5. KEYWORDS ARE SEPARATED BY ONE OR MORE BLANKS
 1
 OPERANDS - 
   'COMMAND NAME' 
            - NAME OF THE COMMAND TO BE EXPLAINED 
   'TYPE OF HELP' 
            - ONE OR MORE OF THE FOLLOWING WORDS MAY BE USED
              FU [NCTION] - FUNCTION IS TO BE DISPLAYED 
              SY [NTAX]   - FORMAT IS TO BE DISPLAYED 
              OP [ERANDS] - OPERAND DESCRIPTION IS TO BE DISPLAYED
              AL [L]      - FUNCTION, SYNTAX, AND OPERAND 
                         DESCRIPTIONS ARE TO BE DISPLAYED 
 1
   NOTE     - THE TYPE OF HELP, THE COMMAND NAME , AND THE
              HELP COMMAND ITSELF MUST BE SEPARATED 
              FROM EACH OTHER WITH A BLANK. 
 1
%%
HELP EXECUTE
 1
 FUNCTION - 
   THE EXECUTE COMMAND ALLOWS THE USER TO EXECUTE A 
   PROGRAM FROM QUERY. THIS COULD BE USED TO SCHEDULE 
   THE 'EDITR' TO EDIT A PROCEDURE. 
 1
 SYNTAX - 
         EXECUTE [ = 'PROGRAM NAME']; 
 1
 OPERANDS - 
         'PROGRAM NAME' IS THE NAME OF THE PROGRAM TO BE
         SCHEDULED. THE PARAMETERS FROM THE RUN STRING USED 
         TO EXECUTE QUERY ARE PASSED TO THE PROGRAM BEING 
         SCHEDULED. 
 1
         WHEN NO NAME IS SPECIFIED DEFAULT IS 'EDITR'.
 1
%%
HELP CREATE 
 1
 FUNCTION - 
   THE CREATE COMMAND IS USED TO STORE A FIND,
   REPORT OR UPDATE PROCEDURE BY A SPECIFIC NAME
   INTO A FMGR DISC FILE. 
 1
 SYNTAX - 
         CREATE NAME = 'PROCEDURE NAME';
         'PROCEDURE SPECIFICATION'; 
         END; 
 1
     NOTE    - EACH ENTRY IN THE PROCEDURE SPECIFICATION MUST 
              BE TERMINATED BY A SEMICOLON. 
 1
 OPERANDS - 
   'PROCEDURE NAME' 
            - FMP FILE DESCRIPTOR (IE, FILENAME [:SECURITY [:CARTRIDGE]]) 
   'PROCEDURE SPECIFICATION'
            - FIND, UPDATE, OR REPORT PROCEDURE 
 1
%%
HELP LIST 
 1
 FUNCTION - 
   THE LIST COMMAND ALLOWS THE LIST LOGICAL UNIT TO BE
   CHANGED TO THE DESIRED OUTPUT DEVICE, OR OUTPUT FILE.
 1
 SYNTAX - 
         LIST='OUTPUT NAME';
 1
 OPERANDS - 
   'OUTPUT NAME'
              - INTEGER NUMBER
                   OR 
              - FMP FILE DESCRIPTOR.
 1
%%
HELP DATA-BASE
 1
 FUNCTION - 
   THE DATA-BASE COMMANDS DEFINES THE DATA-BASE AND 
   OPENS IT ACCORDING TO THE SECURITY LEVEL SPECIFIED.
 1
 SYNTAX - 
         DATA-BASE = 'DATA-BASE NAME' ; 
 1
   THE USER IS THEN PROMPTED FOR THE LEVEL CODE WORD, AS FOLLOWS: 
 1
         LEVEL? 'LEVEL CODE WORD' ; 
         MODE? 'OPEN ACCESS MODE' ; 
 1
   THE USER MUST ENTER THE LEVEL CODE WORD.  WHEN HE IS ON AN 
   INTERACTIVE DEVICE THE LEVEL CODE WORD IS NOT DISPLAYED AS 
   IT IS ENTERED. 
 1
   THE USER MUST ALSO ENTER THE OPEN ACCESS MODE. 
 1
 OPERANDS - 
   'DATA-BASE NAME' 
            - FMP FILE DESCRIPTOR OF THE DATA BASE. 
              THE SECURITY CODE MUST BE INCLUDED, 
              (IE., FILENAME:SECURITY [:CARTRIDGE] )
    'LEVEL CODE WORD' 
            - 1 TO 6 CHARACTER WORD SPECIFING THE READ/WRITE
              ACCESS THE USER HAS.  THE LEVEL CODE WORDS ARE
              DEFINED FOR THE DATA BASE WHEN IT IS FIRST CREATED. 
              THE LEVEL CODE WORD REPRESENTS A READ/WRITE LEVEL 
              FROM 1 TO 15.  WHEN AN ILLEGAL LEVEL CODE WORD IS 
              ENTERED, THE USER HAS A LEVEL OF 0. 
    'OPEN ACCESS MODE'
            - AN INTEGER SELECTED FROM THE TABLE BELOW.  THIS 
              INTEGER DEFINES THE TYPE OF ACCESS THE USER HAS 
              TO THE DATA BASE. 
 1
                     1 INDICATES SHARED READ/WRITE
                     3 INDICATES EXCLUSIVE READ/WRITE 
                     8 INDICATES SHARED READ ONLY 
 1
%%
HELP SELECT-FILE
 1
 FUNCTION - 
   THE SELECT-FILE SPECIFIES A WORK FILE FOR THE FIND COMMAND.
 1
 SYNTAX - 
        SELECT-FILE = 'DATA FILE NAME' ;
 1
 OPERAND -
   'DATA FILE NAME' 
            - FMP FILE DESCRIPTOR, (IE., FILENAME [:SECURITY [:CARTRIDGE]]) 
            - WHEN THE FILE DOES NOT EXITS, IT IS CREATED.
              WHEN THE FILE DOES ALREADY EXIST IT MUST BE A TYPE 1
              FILE OF AT LEAST THREE BLOCKS.
 1
%%
HELP DESTROY
 1
 FUNCTION - 
   THE DESTROY COMMAND WILL DELETE A STORED 
   PROCEDURE OR BATCH FILE FROM THE DISC.(PURGE)
 1
 SYNTAX - 
         DESTROY NAME = 'FILE NAME' ; 
 1
 OPERANDS - 
   'FILE NAME'
            - FMP FILE DESCRIPTOR, (IE. FILENAME [:SECURITY [:CARTRIDGE]])
              THE FILE NAME MAY BE ANY FMP FILE.
 1
            CAUTION -  AVOID DELETING THE CURRENTLY DECLARED
                       SELECT FILE. 
 1
%%
HELP DISPLAY
 1
 FUNCTION - 
   THE DISPLAY COMMAND WILL DISPLAY A STORED
   PROCEDURE FILE, OR BATCH FILE. 
 1
 SYNTAX - 
         DISPLAY NAME = 'PROCEDURE NAME' ;
 1
 OPERANDS - 
   'PROCEDURE NAME' 
            - FMP FILE DESCRIPTOR,(IE. FILENAME [:SECURITY [:CARTRIDGE]]) 
              THE FILE MUST BE AN ASCII.
 1
%%
HELP EXIT 
 1
 FUNCTION - 
   THE EXIT COMMAND CAUSES IMMEDIATE TERMINATION OF 
   THE QUERY SYSTEM.  IT CLOSES ALL FILES AND THE DATA BASE.
 1
 SYNTAX - 
         EXIT ; 
 1
 OPERANDS - 
   NONE 
 1
%%
HELP FORM 
 1
 FUNCTION - 
   THE FORM COMMAND WILL DISPLAY A LIST OF DATA-SET 
   AND DATA-ITEM NAMES ALONG WITH THE ITEM LENGTH, AND
   ACCESS LEVEL OF EACH ITEM. 
 1
 SYNTAX - 
         FORM ; 
 1
 OPERANDS - 
   NONE 
 1
%%
HELP REPORT 
 1
 FUNCTION - 
   THE REPORT COMMAND WILL GENERATE A REPORT USING
   THE DATA RECORDS FOUND BY A FIND COMMAND.
 1
 SYNTAX - 
         REPORT NAME = 'PROCEDURE NAME' ; 
                   OR 
         REPORT ALL[,'CHAR'] ;
                   OR 
         REPORT [,<CHAR>] ; 
         'REPORT PROCEDURE' 
         END; 
 1
 OPERANDS - 
   'REPORT PROCEDURE' 
            - CONSIST OF ONE OR MORE OF THE REPORT
              STATEMENT TYPES.  EACH STATEMENT MUST BE TERMINATED 
              BY A SEMICOLON. 
                1. DETAIL 
                2. EDIT 
                3. GROUP
                4. HEADER 
                5. SORT 
                6. TOTAL
 1
 1
   'PROCEDURE NAME' 
            - FMP FILE DESCRIPTOR, (IE., FILENAME [:SECURITY [:CARTRIDGE]]) 
   <CHAR>   - ANY ASCII CHARACTER WILL
              LIST REPORT PROCEDURE 
              DEFAULT: NO LIST
   ALL      - LISTS ALL FOUND RECORDS WITHOUT ANY 
              FORMATTING
   'CHAR'   - ANY ASCII CHARACTER - WILL LIST ALL 
              FOUND RECORDS WITHOUT ANY 
              FORMATTING OR DATA-ITEM NAME
 1
%%
HELP FIND 
 1
 FUNCTION - 
   THE FIND COMMAND WILL RETRIEVE DATA RECORDS
   FROM THE DATA-BASE AS SPECIFIED IN THE FIND
   STATEMENT
 1
 SYNTAX - 
         FIND 'RETRIEVE PROCEDURE' END; 
                  OR
         FIND NAME = 'PROCEDURE NAME' ; 
 1
 OPERANDS - 
   'RETRIEVE PROCEDURE' 
            - CONSISTS OF ['SET NAME'.]'DATA ITEM NAME' 
              'RELATIONAL OPERATOR''DATA ITEM PHRASE' 
              'LOGICAL CONNECTOR' 
   'PROCEDURE NAME' 
            - FMP FILE DESCRIPTOR, (IE., FILENAME [:SECURITY [:CARTRIDGE]]) 
              WHICH CONTAINS A FIND COMMAND.
   'DATA ITEM NAME' 
            - 1 TO 6 CHARACTER STRING 
   'SET NAME' 
  
            - 1 TO 6 CHARACTER STRING SPECIFYING A DATA 
              SET.  THE DATA SET MUST BE SPECIFIED ON THE 
              FIRST ITEM IN A FIND COMMAND.  WHEN THE DATA
              ITEM BELONGS TO ONLY ONE SET, THE SET NAME MAY
              BE OMITTED.  ALL OTHER ITEMS IN A FIND COMMAND
              MUST BELONG TO THE DATA SET.
   'RELATIONAL OPERATOR'
            - IS/IE/ISNOT/INE/ILT/
              INLT/IGT/INGT 
   'DATA ITEM PHRASE' 
            - "DATA ITEM VALUE" 
   'LOGICAL CONNECTOR'
            - AND/OR
 1
%%
HELP UPDATE 
 1
 FUNCTION - 
   THE UPDATE COMMAND ALLOWS THE USER TO ALTER
   DATA-BASE ITEMS BY DELETING, REPLACING, OR ADDING
   ENTRIES TO THE DATA BASE.
 1
   THE UPDATE ADD COMMAND PROMPTS THE USER FOR THE VALUE OF 
   EACH ITEM IN THE DATA SET.  THE VALUE MAY BE DEFAULTED 
   BY ENTERING A SEMICOLON ONLY.  PATH ITEMS MAY NOT BE 
   DEFAULTED. 
 1
   THE UPDATE REPLACE COMMAND MUST BE USED AFTER A FIND 
   COMMAND, BECAUSE IT REPLACES THE ITEM VALUES IN EACH 
   RECORD FOUND WITH THE NEW VALUE. THE REPLACE COMMAND 
   PROMPTS THE USER FOR THE NAME OF THE ITEM TO BE REPLACED 
   AND THE ITEM'S VALUE.
 1
   THE UPDATE DELETE COMMAND MUST BE USED AFTER A FIND
   COMMAND, BECAUSE IT DELETES FROM THE DATA BASE ALL 
   ENTRIES PLACED IN THE SELECT-FILE BY THE FIND COMMAND. 
 1
         CAUTION - ONLY DELETE ONE RECORD AT A TIME 
           FROM A MASTER DATA SET.
 1
 SYNTAX - 
         UPDATE A[DD], 'SET NAME' ; 
                  OR
         UPDATE D[ELETE] ;
                  OR
         UPDATE R[EPLACE];
                  OR
         UPDATE 'PROCEDURE NAME' ;
 1
   THE UPDATE ADD COMMAND PROMPTS THE USER FOR THE ITEM VALUE 
   BY PRINTING THE ITEM NAME FOLLOWED BY A QUESTION MARK. 
   THE USER MUST ENTER A VALUE FOR EACH PATH ITEM, BUT MAY
   DEFAULT ANY OTHER ITEM VALUE BY ENTERING A SEMICOLON ONLY. 
 1
   THE UPDATE REPLACE COMMAND PROMPTS THE USER FOR THE
   NAME OF THE ITEM TO UPDATE BY PRINTING "ITEM?".  THE 
   USER MUST ENTER THE FOLLOWING, 
 1
           'ITEM NAME' = 'VALUE' ;
 1
   THE UPDATE REPLACE COMMAND IS TERMINATED BY ENTERING A 
   SEMICOLON ONLY IN RESPONSE TO THE "ITEM?" PROMPT.
 1
 OPERANDS - 
   'PROCEDURE NAME' 
            - FMP FILE DESCRIPTOR, (IE., FILENAME [:SECURITY [:CARTRIDGE]]) 
   'DATA SET NAME'
            - 1 TO 6 CHARACTER STRING 
    'ITEM NAME' 
            - 1 TO 6 CHARACTER STRING 
    'VALUE' 
            - THE ITEM VALUE MUST BE ENCLOSED IN QUOTES, AND TERMINATED 
              WITH A SEMICOLON.  ARRAY ITEMS MAY BE ENTERED WITH EACH 
              ARRAY ELEMENT VALUE ENCLOSED IN QUOTES, SEPARATED BY
              COMMAS, TERMINATED BY A SEMICOLON.  FOR EXAMPLE,
 1
                  "ITEM VALUE" [,"ITEM VALUE" [, ... [,ITEM VALUE]]] ;
 1
%%
HELP XEQ
 1
 FUNCTION - 
   THE XEQ COMMAND EXECUTES A QUERY BATCH FILE.  A QUERY BATCH FILE 
   CONSISTS OF COMMANDS, AND COMMAND PARAMETERS.  A COMMAND PARAMETER 
   IS ANY INFORMATION FOR WHICH QUERY WOULD NORMALLY PROMPT AN INTER- 
   ACTIVE USER.  THE COMMAND PARAMETERS MUST IMMEDIATELY FOLLOW THE 
   COMMAND.  FOLLOWING IS AN EXAMPLE OF A BATCH FILE WHICH OPENS A DATA 
   BASE CALLED "BASE" WITH SECURITY CODE "SC", USING LEVEL CODE WORD
   "L10", IN MODE 1.  THE BATCH FILE ALSO CONTAINS THE COMMAND TO 
   DEFINE THE SELECT-FILE CALLED "SELT".
  
        DATA-BASE=BASE:SC;
        L10;
        1;
        SELECT-FILE=SELT; 
  
 1
 SYNTAX - 
        XEQ = 'BATCH FILE NAME' ; 
 1
 OPERANDS - 
   'BATCH FILE NAME'
            - FMP FILE DESCRIPTOR, (IE., FILENAME [:SECURITY [:CARTRIDGE]]) 
 1
%%
**
            &QSHLP - 92069-18122 REV.1912 790220
                                                    