/See also: [[https://github.com/alphapapa/activities.el][Activities.el]], which provides more advanced functionality. To some extent, it obsoletes this library./
This package provides tools to save and restore frame and window configurations in Emacs, including buffers that may not be live anymore. In this way, it's like a lightweight "workspace" manager, allowing you to easily restore one or more frames, including their windows, the windows' layout, and their buffers.
Internally it uses Emacs's bookmarks system to restore buffers to their previous contents and location. This provides power and extensibility, since many major modes already integrate with Emacs's bookmarks system. However, in case a mode's bookmarking function isn't satisfactory, Burly allows the user to customize buffer-restoring functions for specific modes.
For Org mode, Burly provides such custom functions so that narrowed and indirect Org buffers are properly restored, and headings are located by outline path in case they've moved since a bookmark was made (the [[https://github.com/alphapapa/org-bookmark-heading][org-bookmark-heading]] package also provides this through the Emacs bookmark system, but users may not have it installed, and the functionality is too useful to not include here by default).
Internally, buffers and frame/window configurations are also encoded as URLs, and users may also save and open those URLs instead of using Emacs bookmarks. (The name "Burly" comes from "buffer URL.") For example, a URL to the =Installation/Quelpa= heading in this file, as I'm writing it, looks like this:
emacs+burly+file:///home/me/src/emacs/burly.el/README.org?pos=2651&outline-path=%28%22Installation%22%20%22Quelpa%22%29&relative-pos=308
In terms of built-in features, Burly may be seen as integrating or leveraging the built-in libraries =bookmark.el=, =window.el=, and =frameset.el=.
Contents :noexport: :PROPERTIES: :TOC: :include siblings :END: :CONTENTS:
[[#installation][Installation]]
[[#usage][Usage]]
[[#changelog][Changelog]]
[[#development][Development]]
[[#credits][Credits]]
[[#license][License]] :END:
Installation :PROPERTIES: :TOC: :depth 0 :END:
** MELPA
If you installed from MELPA, you're done. Just run one of the commands below.
** Quelpa
The easiest way is to install with [[https://github.com/quelpa/quelpa-use-package][quelpa-use-package]], like this:
(use-package burly :quelpa (burly :fetcher github :repo "alphapapa/burly.el"))
** Manual
** Bookmark commands
Most users will probably use Burly by bookmarking frame and window configurations and accessing them with these commands:
Note that bookmarks created by Burly are regular Emacs bookmarks, so they can be managed by Emacs's built-in bookmark commands, e.g. =list-bookmarks=, =bookmark-delete=, etc.
** URL commands
These commands work on URL strings. While most users probably won't use these, they may be useful for building custom tooling.
** Tab bar
Burly supports Emacs's ~tab-bar-mode~ with ~burly-tabs-mode~. When active, Burly bookmarks are opened in new tabs, and the tabs are named according to the bookmarks. Reopening a Burly bookmark uses the designated tab, if it already exists, and tabs may be reset to their bookmarked state with the command ~burly-reset-tab~ (which you might bind to =C-x t R=).
** Tips
You can customize settings in the =burly= group.
An Info manual is included with this package.
Changelog :PROPERTIES: :TOC: :depth 0 :END:
** 0.4-pre
Added
Fixed
** 0.3
Added
Changed
Fixed
** 0.2
Added
Changed
Fixed
** 0.1
Initial release.
Bug reports, feature requests, suggestions — /oh my/!
Credits
Thanks to [[https://github.com/clemera][Clemens Radermacher]] and [[https://github.com/rswgnu][Robert Weiner]] for their suggestions.
Thanks to [[https://github.com/tpeacock19][Trey Peacock]] for extensive feedback on pre-release versions.
License
GPLv3
** Info export options
** File-local variables