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