    +                              DECspell V1.5    1                     System and Installation Guide      			** INTERNAL USE ONLY **  ; 	NO PORTION OF THIS KIT IS TO BE DISTRIBUTED OUTSIDE OF THE  	DIGITAL INTERNAL NETWORK.  F The software described in this  manual  is  in  part  subject  to  the following copyright:  F Houghton Mifflin Spelling Verification  -  Correction,  (c)  CopyrightC 1983, 1981 Houghton Mifflin Company.  All rights strictly reserved.   F The spelling correction software contains unpublished materials  ownedF by  Houghton  Mifflin  Company,  licensed  for  use  solely in DigitalF software.  Reproductions or disassembly of embodied computer  programsE or algorithms prohibited.  Based on The American Heritage Dictionary.      Preface   F The DECspell System and Installation Guide describes the procedure forF installing  DECspell  on a VAX/VMS system, and the procedure to verify. that DECspell has been installed successfully.  + It also provides advice and information on:   )       .  How to make best use of DECspell   +       .  Hardware and software requirements   2       .  How to incorporate DECspell into ALL-IN-1         .  DECspell system files   Intended Audience   F This guide is intended primarily for VAX/VMS system managers who  wishF to  install  DECspell  on their system.  It is also intended for users/ who require further information about DECspell.          Document Structure  E Chapter  1         Contains the introduction.  Lists the hardware and ;                    software requirements. Describes the kit                     components.  = Chapter  2         Describes how to prepare for installation. ?                    Describes the installation procedure and the *                    verification procedure.  > Chapter  3         Gives some guidance on the use of DECspell.  E Chapter  4         Describes how to tune the performance of DECspell.   . Chapter  5         Contains the release notes.  G Appendix A         Describes how to incorporate DECspell into ALL-IN-1                      V1.3.  G Appendix B         Describes how to incorporate DECspell into ALL-IN-1                      V2.  , Appendix C         Lists the DECspell files.  A Appendix D         Describes severe error messages that DECspell  E                    displays when it fails, and how to deal with them.   < Appendix E         Lists specimen output of the Installation@                    Verification Procedure, for each type of kit.  D Appendix F         Contains the text of the file that is used in theC                    interactive test, which is the final part of the 7                    Installation Verification Procedure.   A Appendix G         Describes who to contact if you have problems.       '                               CHAPTER 1   1                     INTRODUCTION AND REQUIREMENTS        1.1  Introduction   F You install DECspell  using  the  VMSINSTAL  command  procedure.   The, installation procedure only requires you to:  6       .  Set up proper conditions for the installation         .  Load the media   F       .  Respond to any queries and prompts that are output during the          installation procedure      1.2  Hardware Requirements  K DECspell is installed on  an OpenVMS Alpha system  configuration  having  a A minimum  of  3000  disk  blocks  available  on the system disk.      1.3  Software Requirements  # The following software is required:   $      1   OpenVMS Alpha V6.1 or later   1.4  The Kit  F The DECspell software is distributed online via a backup saveset to be- used with the SYS$UPDATE:VMSINSTAL procedure.   F There are two types of kit, basic and  update.   The  basic  kits  areF complete  products.   An  update  kit  adds  an  extra dictionary to a previously installed basic kit.   K The DECspell kit contains both the American English and British dictionary.     '                               CHAPTER 2   1                      PREPARATION AND INSTALLATION    2.1  Preparing for Installation   6 Before you begin installing DECspell do the following:  %      1   Check the distribution  kit.         2   Make sure there are:   F           .  3000 free blocks on the system disk for a DECspell  basic              kit, and   F           .  a further 1100 blocks  if  an  additional  dictionary  is              being installed.     !      3   Back up the system disk.   =      4   Make sure there are no users logged into the system.    2.2  Installing DECspell  > Take note of the following points before you install DECspell:  F       .  During this installation procedure  a  number  of  cautionaryF          messages  and  general  information  messages,  which are notF          documented here,  may  display.   Please  read  all  messages4          carefully and follow the advice they offer.  F       .  If the following error messages display at any  time,  duringF          the  installation,  you  may need to increase the global pageF          table.   Otherwise,  reboot  your  machine  and  restart  the           installation procedure:  5          %SYSTEM-F-GPTFULL, global page table is full   G          %VMSINSTAL-F-NOREINSTAL, Image VMI$ROOT:[SYSLIB]DCLTABLES.EXE; ;                                   could not be re-installed   Q          %VMSINSTAL-F-UNEXPECTED, Installation terminated due to unexpected event     + Now follow these steps to install DECspell:   = 1   Log in under the privileged VMS system manager's account.   < 2   Type the following command to initiate the installation:  )     $ @VMSINSTAL SPLAXP015 <kit-location>   E 4   You will be asked a few questions about the installation options.     '                               CHAPTER 3   /                        ADVICE ON USING DECSPELL   F This chapter contains information to help you and the  users  on  yourF system  make  the  most  effective  use of DECspell.  It also containsF information that may help you in answering users' queries or problems.     3.1  Personal Dictionaries  F Personal dictionaries are lists maintained by users.   The  words  andF names  contained  in  them  are  words  which  are  not  in the masterF dictionary.  DECspell is easier to use when personal dictionaries  areF used  for  checking,  because  fewer  valid  words  are highlighted as errors.   F Users should  be  encouraged  to  make  full  use  of  their  personal
 dictionaries.     ( 3.1.1  Using DECspell for the First Time  K The first  time  a  user runs DECspell he will not have a default personal   dictionary.  This isF the personal dictionary that DECspell  always  uses  unless  the  userF specifies  otherwise.   DECspell  will  ask whether the user wants oneF created.  If  the  user  answers  NO,  this  question  is  asked  eachF subsequent  time  the  user  runs DECspell.  If the user answers YES aF default  personal  dictionary  is  created,   with   the   file   name SYS$LOGIN:PERSONAL.LGP.   F Personal dictionaries are ASCII files.  Users can create  and  add  toF other  personal  dictionaries using an editor, for example EDT.  ThereF can be more than one word per line; separate the  words  with  spaces. The words can be in any order.  5 3.1.3  Sharing Personal Dictionaries with Other Users   # You can specify additional personal F dictionaries with the /DICTIONARY qualifier.  Users  should  refer  toF their   own  dictionaries  by  name.   They  can  use  other  people'sF dictionaries, but will need to specify the directory for  dictionariesF located  in  other  accounts.   For  example,  user  Brown  issues the command:  6 $ SPELL/DICTIONARY=(TECHNICAL,[SMITH]COMPANY) NAME.TXT  ; This will cause DECspell to use the following dictionaries:   ) SYS$LOGIN:PERSONAL.LGP       (by default) ? SYS$LOGIN:TECHNICAL.LGP      (one of user Brown's dictionaries) ? [SMITH]COMPANY.LGP           (one of user Smith's dictionaries)   F DECspell requires Read access to additional dictionaries in  order  toF use   them  for  verification.   DECspell  requires  Write  access  toF additional dictionaries if you wish to add words while using DECspell.  F You can use this feature to set up a dictionary  that  can  be  sharedF between  users.   You  can  set  up shared dictionaries with Read-onlyF access to prevent the addition of incorrectly  spelled  words.   (This= means that users cannot add any words to those dictionaries.)     < 3.1.4  System Messages Associated with Personal Dictionaries  1 When a user invokes  additional  dictionaries  at F the start of using DECspell (with the /DICTIONARY switch), a number of: messages may appear if he makes any one of these mistakes:  -       .  Specifies the dictionary incorrectly   F       .  Specifies the directory in which  the  dictionary  is  stored          incorrectly  F       .  Specifies the  device  on  which  the  dictionary  is  stored          incorrectly  E       .  Specifies a dictionary that is protected against Read access   F The user is asked if he wishes to continue.  He can type Y to continueF without  using  the  incorrectly specified dictionary or type N, start, DECspell again and respecify the dictionary.   3.1.5  Words in Dictionaries  F DECspell dictionaries contain whole words only.  There are no  derivedF forms.   Separate entries exist for the plural and possessive forms ofF words in dictionaries.   If  a  user  adds  a  word  to  his  personalF dictionary  he  may  also  need to add the plural and possessive forms separately.   F Many hyphenated words are stored in the  dictionary  as  whole  words.F DECspell  also  handles  compound  words  (valid  words separated by aF single hyphen) by checking each part in the dictionary.  The  compoundF word  is  only  accepted  if  both  halves  are valid and have correctF capitalization.  Compound words can be added to personal dictionaries.  F DECspell handles abbreviations by first checking the word without  theF trailing  period.   If it is not found a second check is made with the trailing period appended.    3.2  The HELP Key   I The HELP key used by DECspell is the  PF2  key  or the HELP key on LK4xx  
 keyboards.   3.4  DCL Command Qualifiers   F Qualifiers modify the way DECspell works.  Users  can  use  them  when1 starting   DECspell   Users  can  abbreviate  any F qualifier uniquely and can use more than one qualifier at a time.  The/ following DCL command qualifiers are available:T     /OUTPUT   F Gives the output document a new name.  If this qualifier is  not  usedF the  output  document  will  be  stored under its original name with a higher version number.  1 For example:  $ SPELL/OUTPUT=NEWNAME.TXT NAME.TXTi    	 /NOOUTPUT   F Prevents a corrected version of the document being created.  Words can; still be added to the personal dictionaries during the run.l  ' For example:  $ SPELL/NOOUTPUT NAME.TXTa     /NOPERSONAL_DICTIONARY  F Prevents the users's default personal dictionary (PERSONAL.LGP)  being used.r  4 For example:  $ SPELL/NOPERSONAL_DICTIONARY NAME.TXT     /PERSONAL_DICTIONARY  F This can be used to specify an alternative personal dictionary  to  beF used instead of PERSONAL.LGP.  If the dictionary specified by the user? does not exist, DECspell asks whether he would like it created.   : For example:  $ SPELL/PERSONAL_DICTIONARY=DICNAME NAME.TXT     /DICTIONARYe  F Specifies additional personal dictionaries for checking.   If  a  userF wishes  to  use a dictionary for checking, he must have Read access toF the dictionary.  If a user wishes to add words  to  a  dictionary,  heF must  have  Write  access  to  the  dictionary.   Up  to 10 additional/ personal dictionaries can be used for checking.   = For example:  $ SPELL/DICTIONARY=(DICNAME1,DICNAME2) NAME.TXTr     /KEYPAD   F Specifies an alternative editor mini-keypad layout.  Available keypads% are WPS and EDT.  The default is WPS.r  ) For example:  $ SPELL/KEYPAD=EDT NAME.TXT      /MASTER_DICTIONARY  F Specifies an alternative master dictionary.   This  qualifier  can  beF used  only  if  the  system  has  both dictionaries.  The dictionaries available are:  3       .  AMERICAN (the American English dictionary)   1       .  BRITISH (the British English dictionary)   8 For Example:  $ SPELL/MASTER_DICTIONARY=BRITISH NAME.TXT     /RUNOFF   F Indicates that the document is a  RUNOFF  document,  if  it  does  notF already  have  a  .RN%  file type, where % is any character.  DECspell= then bypasses the RUNOFF commands when checking the document.r  % For example:  $ SPELL/RUNOFF NAME.TXT     	 /NORUNOFFl  F Indicates that the document is not a RUNOFF document, if it has a .RN%F file type.  DECspell then checks every line in the document, including any beginning with a period.  ' For example:  $ SPELL/NORUNOFF NAME.RNO   # 3.4.1  Tailoring Command Qualifiers   F Sometimes it is cumbersome to type in a whole line of qualifiers.   IfF the  same set of qualifiers are used frequently it is easier to set up+ a global symbol in your login command file.    For example:  + $ SPELL :== SPELL/MASTER=BRITISH/KEYPAD=EDT   E The command SPELL will now invoke DECspell with the above qualifiers.l   3.5  Finding the Version Numberc  C To find the version number of DECspell a user can do the following:   F While verifying a document, press the HELP key.  The top line of  each help frame has the format:  C HELP               topic for help                    VERSION NUMBERa   This version number shows:  C       .  The version of DECspell you are using (for example, V1.5).e  F       .  Whether the Corrector option is present (VC).  All V1.5  kitsF          have  the  Corrector.   V1.0 kits could be Verifier only kits          (VO).  F       .  Whether the master dictionary you are using  is  American  or          British (A or B).    '                               CHAPTER 5h  )                             RELEASE NOTESr  / 5.1  Differences Between DECspell V1.1 and T1.5   , DECspell V1.5 has the following differences:         .  No support for /dxo  !       .  No support for ALL-IN-1.   , 5.2  Software Problems Fixed by this Release   	None.    $ 5.3  Known Problems and Restrictions     5.3.2  Dictionary Status Report   F When DECspell has finished  checking  a  document,  it  displays  someF statistics  for  each  personal  dictionary  to  which words have been added.  These are:  "       .  The number of words added  1       .  The new total of words in the dictionarye  F The total number of words in the dictionary does not include any wordsF greater  than  32  characters  that  you  may  have  edited  into your dictionary.     * 5.3.3  Lines With More Than 255 Characters  F DECspell does not support documents containing lines  of  text  longerF than 255 characters (that is, documents whose record length is greaterF than 255 characters).  Personal  dictionaries,  however,  can  contain lines of any length.   5.3.4  RUNOFF Supporta  F DECspell does not highlight incorrect RUNOFF commands as errors.  This means that:   4       .  Incorrect RUNOFF commands will not be found  F       .  If a  RUNOFF  command  without  a  terminating  semicolon  isF          incorrect,  DECspell  assumes that the whole line is a RUNOFFF          command.  Therefore, DECspell will not highlight  any  errors"          in the text on that line.   d(                               APPENDIX C  5                 SYSTEM FILES ASSOCIATED WITH DECSPELL   F The following files will  be  written  onto  the  system  disk  during
 installation:-   Directory:     SYS$SYSTEM:A% 	LNGSPLCOR.EXE  		Main DECspell image , 	LNGSPLFOR.EXE  		DECspell image for /FORMAT   SYS$LIBRARY:& 	LNGSPLAED.LGS  		AMERICAN ENGLISH ???- 	LNGSPLAEM.EXE  		AMERICAN ENGLISH DICTIONARYy  ; 	LNGSPLBED.LGS  		BRITISH Dictionary - Optionally installed < 	LNGSPLBEM.EXE  		BRITISH Dictionary - Optionally installed + 	LNGSPLSHR.EXE  		Shareable DECspell image.s  	 SYS$HELP: * 	LNGSPLHLP.HLB  		Interactive help library   SYS$UPDATE:  	LNGSPLIVP.TXT 		IVP test inputh   SYS$MESSAGE: 	LNGSPLMSG.EXE  		Message file h   e  (                               APPENDIX D  -                         SEVERE ERROR MESSAGESt  F This chapter lists all the error messages that  appear  when  DECspell8 fails, why they have occurred and how to deal with them.    ( D.1  Associated With Master Dictionaries  F %LNGSPL-F-BAD_MASTDIC, Master dictionary  was  specified  incorrectly. See your system manager.  F You specified the master dictionary incorrectly when using the /MASTER
 qualifier.  F When using the /MASTER qualifier  specify  either  /MASTER=BRITISH  or /MASTER=AMERICAN    F %LNGSPL-F-FILNOTFOU, Master dictionary not  opened  -  disk  file  not foundi  F The master dictionary you specified does  not  exist  on  the  system.F Either  just  the  American or just the British dictionary is present.% You cannot use the /MASTER qualifier.e     D.3  Associated with Formatter
s D.3  Associated with Formatter  F %LNGSPL-F-SORTWRKSET, Not enough working set space for SORT.  See your system manager.s  F The sort facility in the formatter failed to get the  working  set  it needed.h  F Increase the user's working set quota.  If the  quota  is  already  at maximum, increase the maximum.    F %LNGSPL-F-SORVIRMEM, Not enough virtual memory  for  SORT.   See  your system manager.e  F The sort facility in the formatter failed to get the virtual memory it needed.i  F DECREASE the user's working set quota to release more memory  for  the system.p  F %LNGSPL-F-SORWRKDEV, SORT work file not a  disk  device  or  on  local node.  See your system manager.   F The logical names for the sort facility  in  the  formatter  temporaryF work  files, SORTWORK1, SORTWORK2, are pointing to unsuitable devices;F either to devices on another system, or to devices that are not random access devices (disks).H  F Reassign these logical names to point to a random access device  on  aF system  from  which  you  wish to run the SPELL/FORMAT.  AlternativelyF deassign these logical names, so that the sort creates temporary  work files in your local directory.    F %LNGSPL-F-SOREXTWRK, SORT could not extend work file.  See your system manager.  F The sort facility in the formatter  creates  two  work  files  on  theF device(s)  specified  by  the  logical names SORTWORK1, SORTWORK2.  IfF these logicals are undefined, the work files are created in your login
 directory.  F Ensure you extend your privilege for the device where SORT is creatingF the temporary work files.  If you extended the privilege, increase the free block space on the device.d    F %LNGSPL-F-SORTMAP, SORT could not map  work  file.   See  your  system manager.  F Ensure that the system parameter 'maximum process sections' is set  to 20.g    F %LNGSPL-F-SORCLNUP, SORT did not clean up work area.  Run SPELL/FORMAT again.  @ Sort failed to delete the work files and reinitialize the areas.    F %LNGSPL-F-SORNOOUT, SORT could not open a work file.  See your  system manager.    Sort failed to open a work file.  F If the logical names (SORTWORK1, SORTWORK2) are not defined,  increaseF the  free  disk  space  on  the  device(s)  they point to.  Otherwise,2 increase the free disk space on your login device.   D.4  Miscellaneous  F %LNGSPL-F-FILE_FNM_ERR, <NAME> document not accessible - was specified incorrectlye  : You have specified the filename of a document incorrectly.  : Check the filename of the required document and try again.  < %LNGSPL-F-FILE_GEN_ERR, <NAME> document Read access failure.# -RMS-F-DIR, error in directory namen  < You have specified the directory for a document incorrectly.  ; Check the name and location of the directory and try again.e    < %LNGSPL-F-FILE_GEN_ERR, <NAME> document Read access failure.8 -RMS-F-CHN, assign channel system service request failed' -SYSTEM-F-IVDEVNAM, invalid device namea  9 You have specified the device for a document incorrectly.e  + Check the name of the device and try again.   < %LNGSPL-F-FILE_GEN_ERR, <NAME> document Read access failure.+ -RMS-E-DNR, device not ready or not mounted   3 The device you specified was not online or mounted.r  D Check that the specified volume is online and mounted and try again.    F %LNGSPL-F-FILE_PRV_ERR, <NAME>  document  is  protected  against  Read access.   : You do not have Read access to the document you specified.  F If you can, change the protection of the  required  document  and  try again.    F %LNGSPL-F-FILE_PRV_ERR, <NAME> document  is  protected  against  Write access.u  F Either you do not have Write access to the  specified  (or  defaulted)B directory, or you do not have Write access to the document itself.  F If you do not have Write access to  the  directory,  use  the  /OUTPUT@ switch to create an output document in an alternative directory.  F If  you  do  not  have  Write  access  to  the  document,  change  its protection.U    4 %DEBUGBOOT-W-INSFWSL, insufficient working set limit  F You are trying to run DECspell with a working set EXTENT that  is  too small.  ! Increase your working set EXTENT..    5 %LNGSPL-F-FILE_FNF_ERR, <NAME> document was not foundf   The document does not exist.  : Check the name and location of the document and try again.  F %LNGSPL-F-FILE_DNF_ERR, <NAME> document not accessible - directory was	 not foundi  > The input or output directory for the document does not exist.  ; Check the name and location of the directory and try again.a    F %LNGSPL-F-BAD_KEYPAD, Keypad was specified  incorrectly.   Use  either
 WPS or EDT  F You have specified an invalid keypad layout or incorrectly specified aF keypad  layout  when  using  the  /KEYPAD  qualifier.  Only the keypadF layouts WPS and EDT are supported by DECspell when using  the  /KEYPAD
 qualifier.  ; Use a valid keypad option when using the /KEYPAD qualifier.a    E %LNGSCR-F-UNSUP_TERM, DECspell is not supported on this terminal type   F DECspell  is  supported  on  the  VT100,  VT200  and  VT52  series  of6 terminals.  Use a valid terminal type to run DECspell.    F %LNGSCR-F-INSUF_CAP, Terminal has insufficient capabilities to display 132 cols  F You cannot enter 132 column mode because your VT100 terminal does  not% have the Advanced Video Option (AVO).    Use the default 80 column mode.e      (                               APPENDIX F  -                         INTERACTIVE TEST FILEl      F The following piece of text is contained in the test file used as partF of  the  interactive  test  at  the end of the verification procedure.= Follow the instructions in the test file to complete the IVP.     $ Test Text File for LNGVCB and LNGVCA  5       TEST STARTID  --  YOU ARE RUNNING INTERACTIVELYO  F        Keep pressing RETURN to correct the highlighted errors.  If you@        have any problems, or you are happy with the verificationA        prosess and wish to finish, tpye the letter F, followed bye        RETURN.  E        As you can see, this product offers corrections just below theLC        text.  By pressing the RETURN key, you can correct them withiE        the suggested correction.  Digital beleives you will find thiss        product easy to use.d  D        This product offers suggestions on the corrections list whichA        are the required spelling - with a high degree of acurasy.=>        Detials of how this product are to be found in the user        documentation.F  >        You shud now be happy that the product is installed and@        functioning correctly.  The remainder of the installationF        prosedure will continue when you have corrected the last error.    (                               APPENDIX G  ,                           REPORTING PROBLEMS                               J Report problems in the notes conference at which you found the pointer to 	 this kit.p  