nt/paths.h

   1 /* Hey Emacs, this is -*- C -*- code! */
   2
   3 /* Synched up with: Not synched with FSF. */
   4
   5 /* Think twice before editing this file.  Generated automatically by configure.
   6
   7  The file startup.el guesses at reasonable values for load-path, exec-path,
   8  and lock-directory.  This means that if you move emacs and its associated
   9  sub-tree to a different place in the filesystem, or to a different machine,
  10  you won't have to do anything for it to work.
  11
  12  If you define the paths in this file then they will take precedence over
  13  any value generated by the heuristic in startup.el.  The hardcoded paths
  14  will be checked to see if they are valid, in which case they will be used.
  15  Otherwise the editor will attempt to make its normal guess.
  16
  17  See the NEWS file for a description of the heuristic used to locate the lisp
  18  and exec directories at startup time.  If you are looking at this file
  19  because you are having trouble, then you would be much better off arranging
  20  for those heuristics to succeed than defining the paths in this file.
  21
  22    **  Let me say that again.  If you're editing this file, you're making
  23    **  a mistake.  Re-read the section on installation in ../etc/NEWS.
  24
  25  If it defines anything, this file should define some subset of the following:
  26
  27    PATH_PREFIX          The default value of `prefix-directory'.  This is the
  28                         default root for everything.
  29
  30    PATH_LOADSEARCH      The default value of `load-path'.
  31
  32    PATH_EXEC            The default value of `exec-directory' and `exec-path'.
  33                         (exec-path also contains the value of whatever is in
  34                         the PATH environment variable.)
  35
  36    PATH_DATA            The default value of `data-directory'.  This
  37                         is where architecture-independent files are
  38                         searched for.
  39
  40    PATH_LOCK            The name of the directory that contains lock files
  41                         with which we record what files are being modified in
  42                         Emacs.  This directory should be writable by everyone.
  43                         If this is specified, the string must end with a slash!
  44
  45    PATH_SUPERLOCK       The name of the file !!!SuperLock!!! in the lock
  46                         directory.  You probably should let this default...
  47
  48    PATH_INFO            The default value of `Info-directory-list'.
  49                         This is where info files are searched for. */