bram/emacs-persist-state
1
0
Fork 0
Code Issues Activity
Emacs package that automatically saves the state in the background.
13 commits 2 branches 3 tags 167 KiB
Emacs Lisp 100%
Go to file
Bram Schoenmakers d61ba29a76 Add # to function name
2023-05-13 21:49:09 +02:00
persist-state.el Add # to function name 2023-05-13 21:49:09 +02:00
README.org Add support for prescient.el 2023-05-12 20:05:04 +02:00

README.org

Emacs Persist State

Introduction

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

At moments like these, it's convenient to have a reasonably up to date state of recent files, bookmarks, history variables, etc. available when you restart Emacs again.

This package allows you to execute a function at a regular interval. To minimize any disturbance while you're working, a few seconds of idleness will trigger the execution of all save functions.

Supported packages:

  • bookmark
  • desktop
  • Eshell history
  • Prescient.el
  • recentf
  • savehist

Installation and usage

Clone the repository and put the package in your load-path.

  (use-package persist-state
    :ensure nil
    :load-path "lisp/persist-state"
    :init
    (persist-state-enable))

Then, add functions to persist-state-functions which should be executed, e.g. to save bookmarks at regular intervals:

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

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).

License

MIT License

Copyright (c) 2023 Bram Schoenmakers

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.