emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation for 'doom env'

Browse source
This commit is contained in:
Henrik Lissner 2019-08-07 01:42:46 -04:00
parent b34a542ca0
commit c8d6ab823b
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

28
core/cli/env.el
View file

@ -1,27 +1,27 @@
;;; core/cli/env.el -*- lexical-binding: t; -*- ;;; core/cli/env.el -*- lexical-binding: t; -*-
(defcli! env (&rest args) (defcli! env (&rest args)
"Regenerates your envvars file. "Creates or regenerates your envvars file.
doom env [-c|--clear] doom env [-c|--clear]
If -c or --clear is present This is meant to be a faster and more comprehensive alternative to
exec-path-from-shell. See the FAQ in the documentation for an explanation why.
Available switches: The envvars file is created by scraping your (interactive) shell environment
into newline-delimited KEY=VALUE pairs. Typically by running '$SHELL -ic env'
(or '$SHELL -c set' on windows). Doom loads this file at startup (if it exists)
to ensure Emacs mirrors your shell environment (particularly to ensure PATH and
SHELL are correctly set).
refresh Create or regenerate your envvar file This is useful in cases where you cannot guarantee that Emacs (or the daemon)
auto enable auto-reloading of your envvars file (on `doom refresh`) will be launched from the correct environment (e.g. on MacOS or through certain
clear deletes your envvar file (if it exists) and disables auto-reloading app launchers on Linux).
An envvars file (its location is controlled by the `doom-env-file' variable) This file is automatically regenerated when you run this command or 'doom
will contain a list of environment variables scraped from your shell environment refresh'. However, 'doom refresh' will only regenerate this file if it exists.
and loaded when Doom starts (if it exists). This is necessary when Emacs can't
be launched from your shell environment (e.g. on MacOS or certain app launchers
on Linux).
To generate a file, run `doom env refresh`. If you'd like this file to be Use the -c or --clear switch to delete your envvar file."
auto-reloaded when running `doom refresh`, run `doom env enable` instead (only
needs to be run once)."
(let ((default-directory doom-emacs-dir)) (let ((default-directory doom-emacs-dir))
(when (member "clear" args) ; DEPRECATED (when (member "clear" args) ; DEPRECATED
(message "'doom env clear' is deprecated. Use 'doom env -c' or 'doom env --clear' instead") (message "'doom env clear' is deprecated. Use 'doom env -c' or 'doom env --clear' instead")