Emacs package that automatically saves the state in the background.

emacs

Go to file

Bram Schoenmakers 00d71e1efd Add remark on being idle		2023-05-24 22:54:58 +02:00
.gitignore	Add .gitignore	2023-05-14 22:49:45 +02:00
persist-state.el	Change project URL to Codeberg	2023-05-21 12:31:16 +02:00
README.org	Add remark on being idle	2023-05-24 22:54:58 +02:00

README.org

Emacs Persist State

Introduction
Supported packages
Installation and usage
Configuration
Contact
License

Introduction

I don't leave Emacs often, but sometimes Emacs leaves me.

At moments like these it's convenient to start Emacs again with a reasonably up to date state from the previous session: history variables, bookmarks, open buffers, etc. Usually these items are saved at Emacs exit (as part of kill-emacs-hook), but when Emacs exits unexpectedly due to a crash, these functions are not executed and you're left with an outdated state (if any).

This package saves your Emacs state regularly when idle for a brief moment, to minimize disturbance of executing all save functions in sequence. In case Emacs is idle for a longer time, no state is saved.

Supported packages

persist-state supports a number of packages out of the box. For some packages the save only takes place when the corresponding mode or variable is set accordingly. For example, saving history only takes place if savehist-mode is active. Consult the package's documentation or source code for more info about auto-saving.

bookmark
desktop
Eshell history
Prescient.el
recentf
savehist

Installation and usage

At this moment, there is no MELPA package. Therefore, clone the repository and put the package in your load-path, for example with use-package:

git clone https://codeberg.org/bram85/emacs-persist-state.git

  (use-package persist-state
    :ensure nil
    :load-path "/path/to/emacs-persist-state"
    :config
    (persist-state-mode))

Configuration

This table shows which variables can be customized.

Custom variable	Description
persist-state-save-interval	Interval (in seconds) to persist state.
persist-state-saving-functions	A list of functions that should be executed as part of saving state.
persist-state-wait-idle	When it's time to save, wait for this amount of idle time (in seconds).

To add custom functions that should be executed, add functions to persist-state-functions. E.g. to save bookmarks at regular intervals:

  (add-to-list 'persist-state-functions #'bookmark-save)

Contact

Issue reports: Codeberg
Mastodon: @bram85@emacs.ch
Mail: see git log.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.