To run the CLOC package type CLOC and hit return. You will be prompted
for several filespecs, some of which need not be supplied. E.G.

               (logfile)     outputfilespec         default   TTY:
               (controlfile) inputfilespec          default   TTY:
               (resultsfile) outputfilespec         default   TTY:
               (textfile)    inputfilespec          default   NUL:

1. logfile.
   CLOC command lines are read from the  controlfile  and copied
   to the  logfile  together with any default command lines, comments,
   and error messages.

2. controlfile.
   The first line in this file is ITEMISEUSING  or  INPUTDETAILS  or  GETTEXT .
   If it starts with ITEMISEUSING  or  INPUTDETAILS   then the package assumes
   textdata is available in the  textfile , so an explicit file should be
   supplied.
   If it starts with GETTEXT then no textdata will be read from textfile, so
   none need be provided. All the previously saved information will be found
   in the file whose name is given in the specification part of the GETTEXT
   command.

3. resultsfile
   The first line sent to this file is "output from CLOC mark .... etc".
   The last line sent to this file is  "end of output from CLOC mark .... etc".
   Absence of these lines could indicate a fault in your control statements.
   The results from the CLOC package are sent to this file. The lines will,
   by default, be upto 120 characters wide. This can be changed by the
   OUTPUT DETAILS control statement. When the resultsfile is tty: the
   default width changes to 79. (On ADM31 terminals this should be changed
   to no more than 79 otherwise automatic wrap-around will occur.)

4. You can use any of the 95 printable ASCII characters in the textfile,and
   on the control lines. The CLOC controlfield and the CLOC keywords can be
   in uppercase, lowercase, or mixed. When you specify a word or pattern
   you need not use the exact case of letter that you used in the  textfile,
   by default "The" and "the" for example count as one "word". The control
   line ITEMISE USING  CLOC UNCHANGED  is available if you need to separate
   words according to the case of their letters.

5. Seven extra sorting options can be used on the WORDLIST, CONCORDANCE,
   COLLOCATIONS, and INDEX (see below) control statements. The sorting options
   are known as DALPHA, REVDALPHA, ALENGTH, DLENGTH, AXLENGTH, DXLENGTH, LAST
   respectively.
     DALPHA stands for "descending alphabetic order"
     REVDALPHA stands for "reverse descending alphabetic order"
     ALENGTH stands for "ascending length order"
     DLENGTH stands for "descending length order"
     AXLENGTH stands for "ascending extended length order"
     DXLENGTH stands for "descending extended length order"
     LAST stands for "last occurrence order"
   Further details can be found in the new edition of the CLOC users guide
   held in SYS:CLOC.DOC  . In general a sorting option that starts with A
   means "ascending ..." while if it starts with D it means "descending ..."

6. Extra features
   6.1 The CLOC and CLOC UNCHANGED, itemising strategies.
       The first of these is the default and ensures that upper and lower
       case letters do not distinguish words, and that padding letters
       do not appear in the vocabulary tables. The opposite is the case
       when you select CLOC UNCHANGED.

   6.2 A new class of letters called "deferred letters" is available
       for use in conjunction with "padding letters". Deferred letters
       will always appear in the vocabulary tables, while padding letters
       are only present when the CLOC UNCHANGED itemising strategy is used.
       You can choose to declare such things as apostrophy, hyphen,
       diacritics, or breathing marks to be "deferred" or "padding"
       as you wish. See the CLOC users guide for details.

   6.3 The NOREFS option
       This can be used where one would usually request particular
       text references to be printed. This option suppresses printing
       of such text references. It can be used on the CONCORDANCE,
       COLLOCATIONS, CO-OCCURRENCE, WRITETEXT, or INDEX control statements.
       E.G.    CONCORDANCE) NOREFS
               INDEX) NOREFS

   6.4 The WRITETEXT command
       This command does not need to be preceeded by any word selection
       statements. When used this command will print out the text data
       from CLOC's itemised internal form. Each line can be prefixed
       with a text reference.
       E.G.1       WRITETEXT
         The above task will prefix each line with a line number.
       E.G.2       WRITETEXT) NOREFS
         As above but without line numbers or any other form of text reference.
       E.G.3       WRITETEXT) REFS P3L2
         As before but each line will have a COCOA like text reference.

   6.5 The -INSERT feature
       This allows any sequence of CLOC control statements to be stored in
       a DEC20 file for inclusion at any point in the control statement
       sequence. This file can of course have -INSERT statements within it.
       See part 4.1.3 of the CLOC users guide.
       E.G.     -INSERT) test1.dat

   6.6 The -LIST feature
       This allows you to ensure that subsequent CLOC commands are sent
       to the CLOC diagnostic and information file. See section 4.1.4
       of the CLOC users guide.

   6.7 The -NOLIST feature
       This allows you to turn off the process of automatically sending
       CLOC commands to the diagnostic and information file.
       See section 4.1.5 of the CLOC users guide. You can use this
       feature in conjunction with -LIST above to selectively stop
       printing large numbers of words used as data to the
       *LIST OF WORDS   command.

   6.8 The INDEX command
       This will produce a sorted vocabulary list which has each word
       prefixed by its frequency of occurrence and followed by a list
       of references to where it occurrs in the text. The references
       can be a simple line number, COCOA like text references, or
       be absent. See section 4.7 of the CLOC users guide.
       E.G    INDEX
              INDEX) REFS P2 L2
              INDEX) NOREFS

   6.9 The ABOUT option
       This is available on the CONCORDANCE COLLOCATIONS and CO-OCCURRENCE
       commands. It allows you to choose the node about which the citations
       are printed. Thus ABOUT NODE+1 will cause all citations to be
       printed with the word to the right of the node as the central item.
       Similarly ABOUT COLLOCATE will print citations using the collocate.

  6.10 The RESTRICTED span
       This qualifier can be added at the end of the *SPAN control statement.
       It ensures that when two nodes are closer than leftspan+rightspan
       the overlapping collocates are only counted once and that the node
       does not count as a collocate.

  6.11 The *PATTERN option on the CO-OCCURRENCES command
       You can now put a list of patterns following this command. The
       package will look for all matches with the sequence of patterns.
       Thus the order of the patterns on this line is important.
       E.g. CO-OCCURRENCES
            *PATTERN) *ing *ly

7. The current version was developed from an original which was designed
   for a card-based batch operating system. It is not designed to work
   interactively.

8. References
   1. The CLOC users guide is contained in the file SYS:CLOC.DOC
   2. Some examples are available in SYS:CLOC.EXP
   3. Reed A.,"CLOC - A Collocation Package", ALLC Bulletin, Vol 5, No 2, 1977
   4. Reed A. and Schonfelder J. L., "CLOC: A General-purpose concordance
      and Collocations Generator", Advances in Literary and Linguistic
      Computing, Edited by Knowles, Agar, and Smith, Published by Aston
      University Press, April 1979

                            Alan Reed, (April 1982)
