1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00

Improve documentation of '--init-directory' command-line option.

* doc/emacs/custom.texi (Find Init):
* doc/emacs/cmdargs.texi (Initial Options): More accurate and
detailed description of what '--init-directory' does and how it
affects the Emacs session.  Add index entries and cross-references
as needed.  (Bug#72294)
This commit is contained in:
Eli Zaretskii 2024-07-26 09:14:43 +03:00
parent c27055a938
commit 268a2d10fc
2 changed files with 17 additions and 1 deletions

View File

@ -351,6 +351,16 @@ Do not include the @file{site-lisp} directories in @code{load-path}
@item --init-directory @item --init-directory
@opindex --init-directory @opindex --init-directory
Specify the directory to use when looking for the Emacs init files. Specify the directory to use when looking for the Emacs init files.
Note that this merely overrides the value of
@file{user-emacs-directory}, the directory which Emacs usually
determines as side effect of searching for your init file (@pxref{Find
Init}), but does not change the search for the init file. In
particular, if there's no init file in the directory named by this
option, Emacs will find and use the init file it would have used without
this option (but will search for your other per-user Emacs files in the
directory specified by this option). If you want to force Emacs to use
the init file in this directory, make sure it exists there before
starting Emacs with this option.
@item --no-splash @item --no-splash
@opindex --no-splash @opindex --no-splash

View File

@ -2958,8 +2958,14 @@ Note also that if neither the XDG location nor @file{~/.emacs.d}
exist, then Emacs will create @file{~/.emacs.d} (and therefore use it exist, then Emacs will create @file{~/.emacs.d} (and therefore use it
during subsequent invocations). during subsequent invocations).
@vindex user-emacs-directory
Emacs will set @code{user-emacs-directory} to the directory it decides Emacs will set @code{user-emacs-directory} to the directory it decides
to use. to use. This directory is subsequently used to look for your other
user-specific Emacs files, such as @code{custom-file} (@pxref{Saving
Customizations}), the saved desktop (@pxref{Saving Emacs Sessions}) and
others. The @code{--init-directory} command-line option (@pxref{Initial
Options}) overrides the value of @code{user-emacs-directory} determined
as side effect of the search for your user init file described above.
Although this is backward-compatible with older Emacs versions, modern Although this is backward-compatible with older Emacs versions, modern
POSIX platforms prefer putting your initialization files under POSIX platforms prefer putting your initialization files under