home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / thesrc15.zip / appendix.1 < prev    next >
Text File  |  1993-10-28  |  3KB  |  68 lines
  1. /*man-start*********************************************************************
  2.  
  3.  
  4. ========================================================================
  5. APPENDIX 1 - ENVIRONMENT VARIABLES
  6. ========================================================================
  7.  
  8. THE uses the following environment variables:
  9.  
  10.         THE_HOME_DIR     - the directory in which THE looks for its help
  11.                            file(s) and macro(s);
  12.         THE_HELP_FILE    - the fully qualified file name containing help
  13.                            information.
  14.         THE_PROFILE_FILE - the fully qualified file name for the default
  15.                            profile file.
  16.         THE_MACRO_PATH   - a list of all directories in which THE is to 
  17.                            look for macro files.
  18.  
  19. The following defines how these environment variables are used under UNIX.
  20.  
  21. If no environment variable; THE_HOME_DIR, is set prior to starting THE,
  22. THE uses /usr/local/THE/ (or /opt/THE/ if SYSVR4 is defined when compiling)
  23. as the default value for ${THE_HOME_DIR}. 
  24. This can be changed in the.c if necessary.
  25.  
  26. The default value of THE_HELP_FILE is ${THE_HOME_DIR}${TERM}.hlp
  27. eg. with no environment variables set and $TERM set to vt220, the help 
  28. file to be looked for will be /usr/local/THE/vt220.hlp (or 
  29. /opt/THE/vt220.hlp if SYSVR4 is defined when compiling).
  30. If THE_HOME_DIR environment variable was set to /usr/opt/etc or changed in
  31. the.c, the help file will be /usr/opt/etc/vt220.hlp. If no $TERM 
  32. environment variable is set, "default" is used.
  33.  
  34. The name of the default profile file is $HOME/.therc.
  35.  
  36. The default value of THE_MACRO_PATH is ${THE_HOME_DIR}:. THE will look for 
  37. a macro file first in ${THE_HOME_DIR} and then in the current directory. 
  38. So with no environment variables set, THE looks for macros in 
  39. $(THE_HOME_DIR} first and if no file exists in that directory, THE will 
  40. look in the current directory. If the file does not exist in either of 
  41. these places, an error message will be displayed.
  42. The format of THE_MACRO_PATH is dir1:dir2:dir3 Each directory is seperated 
  43. by colons. By default, up to 20 directories may be specified. This can be 
  44. changed in the.h.
  45.  
  46. The following defines how these environment variables are used under DOS 
  47. and OS/2.
  48.  
  49. By default THE_HOME_DIR is set to the directory from which THE was 
  50. invoked. Assuming THE.EXE resides in d:\tools, THE_HOME_DIR will equate 
  51. to d:\tools\.
  52.  
  53. The default value of THE_HELP_FILE is ${THE_HOME_DIR}dos.hlp for DOS and
  54. ${THE_HOME_DIR}os2.hlp for OS/2.
  55.  
  56. The name of the default profile file is ${THE_HOME_DIR}profile.the.
  57.  
  58. The default value of THE_MACRO_PATH is ${THE_HOME_DIR};. THE will look for
  59. a macro file first in THE_HOME_DIR and then in the current directory. So 
  60. with no environment variables set, THE first looks for macros in the 
  61. directory from which THE was invoked and then in the current directory. 
  62. If the file does not exist in either directory, an error message is displayed.
  63. The format of THE_MACRO_PATH is dir1;dir2;dir3 Each directory is seperated 
  64. by semi-colons. By default up to 20 directories may be specified. This can 
  65. be changed in the.h.
  66.  
  67. **man-end**********************************************************************/
  68.