desktop+ extends desktop by providing more features related to sessions persistance.
-
Instead of relying on Emacs' starting directory to choose the session Emacs restarts, sessions are manipulated by name. All information about them is stored into a centralized directory.
-
Desktop sessions by default save only buffers associated to "real" files. Desktop+ extends this by handling also "special buffers". The list of currently supported special buffer types is:
- compilation buffers (in
compilation-mode) - terminal buffers (in
term-mode) - org agenda & todo lists (in
org-agenda-mode) - indirect buffers (a.k.a clones).
- man pages (in
Man-mode) - shell buffers (in
shell-mode)
- compilation buffers (in
desktop+ can be found on MELPA and it's the recommended way of installing it.
Otherwise, you can install it manually. First install desktop+ dependencies:
dash and
f. Then:
-
clone the git repository:
$ git clone https://github.com/ffevotte/desktop-plus.git
-
tell emacs where to find it, for example by adding a snippet like this in your
init.elfile:(add-to-list 'load-path "/path/to/desktop-plus") (require 'desktop+)
Two functions are defined to manipulate desktop sessions by name:
-
desktop-create: create a new session and give it a name. -
desktop-load: change the current session; the new session to be loaded is identified by its name, as given during session creation usingdesktop-create. The currently active session is identified in the title bar.
As a special case, if the session name is left blank when calling one of these two functions, a name is automatically derived from the current working directory (see "Auto-named sessions" below).
Once created or loaded, sessions are automatically saved when exiting emacs or changing session.
It is also possible to create and load sessions without explicitly specifying a name. These sessions are then automatically named after the current working directory. This can be done either by leaving the session name blank when calling desktop-create or desktop-load, or by using their dedicated counterparts:
-
desktop-create-auto: create a new auto-named session. -
desktop-load-auto: load a previously created auto-named session.
If you want to invoke Emacs from the command-line and specify a session to load at startup, you can define the following useful bash function:
function emacs-desktop () {
emacs --eval '(desktop-load "'"$1"'")'
}You can then invoke a named session directly from the command-line:
$ emacs-desktop my-sessionor an auto-named session:
$ cd /path/to/working/directory
$ emacs-desktop-
desktop+-base-dir: directory where all information about desktop sessions are stored. The default value is"~/.emacs.d/desktops/". -
desktop+-frame-title-function: function called to get the new frame title format when the session changes. This function must take the desktop session name as a string argument and return a frame title format suitable for settingframe-title-format.Customize it to change the way session names are displayed. For example:
(defun my/desktop-frame-title-function (desktop-name) (list (concat "%b - Emacs [" desktop-name "]"))) (setq desktop+-frame-title-function 'my/desktop-frame-title-function)
-
desktop+-special-buffer-handlers: list of special buffer types which should be handled specially. The default value contains all known types. You can remove some of them if you want.;; remove items from the list if you don't want a specific special buffer ;; type to be handled. ;; ;; The value of this variable should be changed before `desktop+` is loaded. (setq desktop+-special-buffer-handlers '(term-mode compilation-mode org-agenda-mode indirect-buffer Man-mode shell-mode))
-
(desktop+-add-handler NAME PRED SAVE-FN LOAD-FN)Add handlers for special buffers.
NAME is a symbol identifying the handler for later activation or deactivation.
PRED should be a unary function used as a predicate to determine whether a buffer should be handled specially. When called in a buffer which should be handled, PRED should return non-nil.
SAVE-FN should be a function taking no parameter, returning a list of all relevant parameters for the current buffer, which is assumed to be in the given major mode.
LOAD-FN should be a function of the form
(lambda (name &rest args) ...)allowing to restore a buffer named NAME in major mode MODE, from information stored in ARGS, as determined by SAVE-FN..
If you make improvements to this code or have suggestions, please do not hesitate to fork the repository or submit bug reports on github. The repository's URL is:
https://github.com/ffevotte/desktop-plus.git
- Dryvenn introduced auto-named sessions;
- Brian Malehorn contributed Man-mode and shell-mode buffers handling.
Thanks!
Copyright (C) 2014-2017 François Févotte.
This program is free software: you can redistribute it 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 program 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.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent