With-Editor User Manual

Next:   [Contents][Index]


With-Editor User Manual

The library with-editor makes it easy to use the Emacsclient as the $EDITOR of child processes, making sure they know how to call home. For remote processes a substitute is provided, which communicates with Emacs on standard output instead of using a socket as the Emacsclient does.

This library was written because Magit has to be able to do the above to allow the user to edit commit messages gracefully and to edit rebase sequences, which wouldn’t be possible at all otherwise.

Because other packages can benefit from such functionality, this library is made available as a separate package. It also defines some additional functionality which makes it useful even for end-users, who don’t use Magit or another package which uses it internally.

This manual is for With-Editor version 3.4.3.

Copyright (C) 2015-2024 Jonas Bernoulli <emacs.with-editor@jonas.bernoulli.dev>

You can redistribute this document and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Table of Contents


Next:   [Contents][Index]