home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / apps / text_ed / elv16b2 / doc / environ.ms < prev    next >
Text File  |  1992-08-18  |  3KB  |  72 lines
  1. .Go 11 "ENVIRONMENT VARIABLES"
  2. .PP
  3. \*E examines several environment variables when it starts up.
  4. The values of these variables are used internally for a variety
  5. of purposes.
  6. You don't need to define all of these;
  7. on most systems, \*E only requires TERM to be defined.
  8. On AmigaDOS, MS-DOS or TOS systems, even that is optional.
  9. .SH
  10. TERM, TERMCAP
  11. .PP
  12. TERM tells \*E the name of the termcap entry to use.
  13. TERMCAP may contain either the entire termcap entry,
  14. or the full pathname of the termcap file to search through.
  15. .PP
  16. If your version of \*E is using tinytcap instead of the full termcap library,
  17. then the value of TERMCAP \fIcannot\fR contain any backslash escapes (\\E, \\r, etc.)
  18. or carat escapes (^[, ^M, etc.), because tinytcap doesn't understand them.
  19. Instead, you should embed the actual control character into the string.
  20. .SH
  21. TMP, TEMP
  22. .PP
  23. These only work for AmigaDOS, MS-DOS and Atari TOS.
  24. Either of these variables may be used to set the "directory" option,
  25. which controls where temporary files are stored.
  26. If you define them both, then TMP is used, and TEMP is ignored.
  27. .SH
  28. LINES, COLUMNS
  29. .PP
  30. The termcap entry for your terminal should specify the size of your screen.
  31. If you're using a windowing interface, then there is an ioctl() call which
  32. will provide the size of the window; the ioctl() values will override the
  33. values in the termcap entry.
  34. The LINES and COLUMNS environment variables (if defined)
  35. will override either of these sources.
  36. They, in turn, can be overridden by a ":set" command.
  37. .PP
  38. Normally, the LINES and COLUMNS variables shouldn't need to be defined.
  39. .SH
  40. EXINIT
  41. .PP
  42. This variable's value may contain one or more colon-mode commands,
  43. which will be executed after all of the ".exrc" files
  44. but before interactive editing begins.
  45. .PP
  46. To put more than one command in EXINIT, you can separate the commands
  47. with either a newline or a '|' character.
  48. .SH
  49. SHELL, COMSPEC
  50. .PP
  51. You can use COMSPEC in MS-DOS, or SHELL in any other system,
  52. to specify which shell should be used for executing commands and
  53. expanding wildcards.
  54. .SH
  55. HOME
  56. .PP
  57. This variable should give the full pathname of your home directory.
  58. \*E needs to know the name of your home directory so it can locate
  59. the ".exrc" file there.
  60. .SH
  61. TAGPATH
  62. .PP
  63. This variable is used by the "ref" program.
  64. It contains a list of directories that might contain a relevent "tags" file.
  65. Under AmigaDOS, MS-DOS or Atari TOS, the names of the directories should be separated by
  66. semicolons (";").
  67. Under other operating systems, the names should be separated by colons (":").
  68. .PP
  69. If you don't define TAGPATH, then "ref" will use a default list which includes
  70. the current directory and a few other likely places.
  71. See the definition of DEFTAGPATH at the start of ref.c for an accurate list.
  72.