Variable: with-editor-shell-command-use-emacsclient

with-editor-shell-command-use-emacsclient is a customizable variable defined in with-editor.el.

Value

t

Documentation

Whether to use the emacsclient when running shell commands.

This affects with-editor-async-shell-command and, if the input ends with "&" with-editor-shell-command .

If shell-command-with-editor-mode(var)/shell-command-with-editor-mode(fun) is enabled, then it also affects shell-command-async and, if the input ends with "&" shell-command.

This is a temporary kludge that lets you choose between two possible defects, the ones described in the issues #23 and #40.

When t, then use the emacsclient. This has the disadvantage that with-editor-mode(var)/with-editor-mode(fun) won't be enabled because we don't know whether this package was involved at all in the call to the emacsclient, and when it is not, then we really should. The problem is that the emacsclient doesn't pass along any environment variables to the server. This will hopefully be fixed in Emacs eventually.

When nil, then use the sleeping editor. Because in this case we know that this package is involved, we can enable the mode. But this makes it necessary that you invoke $EDITOR in shell scripts like so:

  eval "$EDITOR" file

And some tools that do not handle $EDITOR properly also break.

This variable was added, or its default value changed, in with-editor version 2.7.1.

Source Code

;; Defined in ~/.emacs.d/elpa/with-editor-20260301.1317/with-editor.el
(defcustom with-editor-shell-command-use-emacsclient t
  "Whether to use the emacsclient when running shell commands.

This affects `with-editor-async-shell-command' and, if the input
ends with \"&\" `with-editor-shell-command' .

If `shell-command-with-editor-mode' is enabled, then it also
affects `shell-command-async' and, if the input ends with \"&\"
`shell-command'.

This is a temporary kludge that lets you choose between two
possible defects, the ones described in the issues #23 and #40.

When t, then use the emacsclient.  This has the disadvantage that
`with-editor-mode' won't be enabled because we don't know whether
this package was involved at all in the call to the emacsclient,
and when it is not, then we really should.  The problem is that
the emacsclient doesn't pass along any environment variables to
the server.  This will hopefully be fixed in Emacs eventually.

When nil, then use the sleeping editor.  Because in this case we
know that this package is involved, we can enable the mode.  But
this makes it necessary that you invoke $EDITOR in shell scripts
like so:

  eval \"$EDITOR\" file

And some tools that do not handle $EDITOR properly also break."
  :package-version '(with-editor . "2.7.1")
  :group 'with-editor
  :type 'boolean)