; * etc/NEWS: Backport edit made on wrong branch.
[emacs.git] / nt / epaths.nt
blobd2c5c2d7ec321354f3d778dc93b2d2798ea8619e
1 /* Hey Emacs, this is -*- C -*- code!  */
2 /* epaths.in file for MS-Windows build that uses the configure script.
4    Since Emacs on Windows must be relocatable to any directory, it
5    cannot have here hard-coded directories determined at configure
6    time.  Therefore, each directory must begin with %emacs_dir%, which
7    is resolved at startup to the root of the Emacs installation tree
8    (see w32.c:init_environment).
10    This file is edited at configure time to replace @VER@ by the Emacs
11    version being built (e.g., 25.9.77), @CFG@ by the canonical name of
12    the host system (e.g., i686-pc-mingw32), and @SRC@ by the root of
13    the Emacs source tree used to build Emacs.  */
15 Copyright (C) 1993, 1995, 1997, 1999, 2001-2016 Free Software
16 Foundation, Inc.
18 This file is part of GNU Emacs.
20 GNU Emacs is free software: you can redistribute it and/or modify
21 it under the terms of the GNU General Public License as published by
22 the Free Software Foundation, either version 3 of the License, or
23 (at your option) any later version.
25 GNU Emacs is distributed in the hope that it will be useful,
26 but WITHOUT ANY WARRANTY; without even the implied warranty of
27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28 GNU General Public License for more details.
30 You should have received a copy of the GNU General Public License
31 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
34 /* Together with PATH_SITELOADSEARCH, this gives the default value of
35    load-path, which is the search path for the Lisp function "load".
36    Configure (using "make epaths-force") sets this to
37    ${standardlisppath}, which typically has a value like:
38    <datadir>/emacs/VERSION/lisp where datadir is eg /usr/local/share.
40 #define PATH_LOADSEARCH "%emacs_dir%/share/emacs/@VER@/lisp"
42 /* Like PATH_LOADSEARCH, but contains the non-standard pieces.
43    These are the site-lisp directories.  Configure sets this to
44    ${locallisppath}, which typically defaults to something like:
45    <datadir>/emacs/VERSION/site-lisp:<datadir>/emacs/site-lisp
46    but can be overridden by the --enable-locallisppath argument.
47    This is combined with PATH_LOADSEARCH to make the default load-path.
48    If the --no-site-lisp option is used, this piece is excluded.
50 #define PATH_SITELOADSEARCH "%emacs_dir%/share/emacs/@VER@/site-lisp;%emacs_dir%/share/emacs/site-lisp"
52 /* Like PATH_LOADSEARCH, but used only during the build process
53    when Emacs is dumping.  Configure (using "make epaths-force-w32") sets
54    this to $buildlisppath, which normally has the value: <srcdir>/lisp.
56 #define PATH_DUMPLOADSEARCH "@SRC@/lisp"
58 /* The extra search path for programs to invoke.  This is appended to
59    whatever the PATH environment variable says to set the Lisp
60    variable exec-path and the first file name in it sets the Lisp
61    variable exec-directory.  exec-directory is used for finding
62    executables and other architecture-dependent files.  */
63 #define PATH_EXEC "%emacs_dir%/libexec/emacs/@VER@/@CFG@"
65 /* Where Emacs should look for its architecture-independent data
66    files, like the NEWS file.  The lisp variable data-directory
67    is set to this value.  */
68 #define PATH_DATA "%emacs_dir%/share/emacs/@VER@/etc"
70 /* Where Emacs should look for X bitmap files.
71    The lisp variable x-bitmap-file-path is set based on this value.  */
72 #define PATH_BITMAPS ""
74 /* Where Emacs should look for its docstring file.  The lisp variable
75    doc-directory is set to this value.  */
76 #define PATH_DOC "%emacs_dir%/share/emacs/@VER@/etc"
78 /* Where the configuration process believes the info tree lives.  The
79    lisp variable configure-info-directory gets its value from this
80    macro, and is then used to set the Info-default-directory-list.  */
81 #define PATH_INFO "%emacs_dir%/share/info"
83 /* Where Emacs should store game score files.  */
84 #define PATH_GAME "%emacs_dir%/var/games/emacs"
86 /* Where Emacs should look for the application default file. */
87 #define PATH_X_DEFAULTS ""