annotate docs/aimPaths @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1
tomwalters@0 2 The pathnames which are to be modified for using the AIM software.
tomwalters@0 3 ====================================================================
tomwalters@0 4
tomwalters@0 5 In the following ${DIR} is the pathname of the directory in which AIM is
tomwalters@0 6 installed in your file system. For example this might be: /usr/local/aim
tomwalters@0 7
tomwalters@0 8
tomwalters@0 9 1. Executables.
tomwalters@0 10 --------------
tomwalters@0 11
tomwalters@0 12 The executable files of the model, AIM tools and the script files are located
tomwalters@0 13 in the ${DIR}/bin directory.
tomwalters@0 14
tomwalters@0 15 If the path name is set to this directory, these programs can be executed
tomwalters@0 16 from anywhere in the system. The best thing to do is to set the PATH
tomwalters@0 17 variable of the environment to:
tomwalters@0 18
tomwalters@0 19 setenv PATH ${DIR}/bin:$PATH
tomwalters@0 20
tomwalters@0 21 This can be done in the .login, .profile or any other appropriate start-up
tomwalters@0 22 script.
tomwalters@0 23
tomwalters@0 24
tomwalters@0 25 2. On-line manual.
tomwalters@0 26 -----------------
tomwalters@0 27
tomwalters@0 28 The `manaim' script prints AIM manual pages with appropriate name in the
tomwalters@0 29 Unix man page format.
tomwalters@0 30 But if the user wishes to get the man pages through "xman", the environment
tomwalters@0 31 variable MANPATH needs to be setup to search the aim/release/man
tomwalters@0 32 directory along with the other default man directories.
tomwalters@0 33
tomwalters@0 34 Add the directory which contains the AIM manual pages to the MANPATH
tomwalters@0 35 in your environment, for example by including the following in your
tomwalters@0 36 start-up script:
tomwalters@0 37
tomwalters@0 38 setenv MANPATH ${DIR}/man:${MANPATH}
tomwalters@0 39
tomwalters@0 40 or, if MANPATH is an undefined variable:
tomwalters@0 41
tomwalters@0 42 setenv MANPATH ${DIR}/man
tomwalters@0 43
tomwalters@0 44
tomwalters@0 45 For compatibility with systems which do not conventionally use a
tomwalters@0 46 MANPATH, the pathname of the AIM pages directory must be the first
tomwalters@0 47 pathname in the list.
tomwalters@0 48
tomwalters@0 49 The AIM man pages will be appear in the "User Commands" section and the
tomwalters@0 50 "Local" section of xman.
tomwalters@0 51
tomwalters@0 52