-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathburly.info
361 lines (273 loc) · 10.3 KB
/
burly.info
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
This is README.info, produced by makeinfo version 6.7 from README.texi.
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* Burly: (burly). Save and restore window configurations and their buffers.
END-INFO-DIR-ENTRY
File: README.info, Node: Top, Next: Installation, Up: (dir)
Burly.el
********
_See also: Activities.el (https://github.com/alphapapa/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
org-bookmark-heading (https://github.com/alphapapa/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’.
* Menu:
* Installation::
* Usage::
* Changelog::
* Development::
* Credits::
* License::
— The Detailed Node Listing —
Installation
* MELPA::
* Quelpa::
* Manual::
Usage
* Bookmark commands::
* URL commands::
* Tab bar::
* Tips::
Changelog
* 0.4-pre: 04-pre.
* 0.3: 03.
* 0.2: 02.
* 0.1: 01.
File: README.info, Node: Installation, Next: Usage, Prev: Top, Up: Top
1 Installation
**************
* Menu:
* MELPA::
* Quelpa::
* Manual::
File: README.info, Node: MELPA, Next: Quelpa, Up: Installation
1.1 MELPA
=========
If you installed from MELPA, you’re done. Just run one of the commands
below.
File: README.info, Node: Quelpa, Next: Manual, Prev: MELPA, Up: Installation
1.2 Quelpa
==========
The easiest way is to install with quelpa-use-package
(https://github.com/quelpa/quelpa-use-package), like this:
(use-package burly
:quelpa (burly :fetcher github :repo "alphapapa/burly.el"))
File: README.info, Node: Manual, Prev: Quelpa, Up: Installation
1.3 Manual
==========
1. Install version 2.1 or later of the ‘map’ library from GNU ELPA.
2. Copy ‘burly.el’ into a directory in your ‘load-path’, then
‘(require 'burly)’.
File: README.info, Node: Usage, Next: Changelog, Prev: Installation, Up: Top
2 Usage
*******
* Menu:
* Bookmark commands::
* URL commands::
* Tab bar::
* Tips::
File: README.info, Node: Bookmark commands, Next: URL commands, Up: Usage
2.1 Bookmark commands
=====================
Most users will probably use Burly by bookmarking frame and window
configurations and accessing them with these commands:
• ‘burly-bookmark-frames’: Bookmark the current frames and their
window configurations.
• ‘burly-bookmark-windows’: Bookmark the current frame’s window
configuration.
• ‘burly-open-bookmark’: Select and open a Burly bookmark.
• ‘burly-open-last-bookmark’: Open the last-opened Burly bookmark.
Helpful for, e.g. quickly restoring an overview while working on a
project.
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.
File: README.info, Node: URL commands, Next: Tab bar, Prev: Bookmark commands, Up: Usage
2.2 URL commands
================
These commands work on URL strings. While most users probably won’t use
these, they may be useful for building custom tooling.
• ‘burly-open-url’: Open a Burly URL (at point, or prompt for one),
displaying the buffer(s) in the current window or frame.
• ‘burly-kill-buffer-url’: Copy BUFFER’s URL to the kill ring.
• ‘burly-kill-frames-url’: Copy the current frameset’s URL to the
kill ring.
• ‘burly-kill-windows-url’: Copy the current frame’s window
configuration URL to the kill ring.
File: README.info, Node: Tab bar, Next: Tips, Prev: URL commands, Up: Usage
2.3 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’).
File: README.info, Node: Tips, Prev: Tab bar, Up: Usage
2.4 Tips
========
• You can customize settings in the ‘burly’ group.
• An Info manual is included with this package.
File: README.info, Node: Changelog, Next: Development, Prev: Usage, Up: Top
3 Changelog
***********
* Menu:
* 0.4-pre: 04-pre.
* 0.3: 03.
* 0.2: 02.
* 0.1: 01.
File: README.info, Node: 04-pre, Next: 03, Up: Changelog
3.1 0.4-pre
===========
*Added*
• Option ‘burly-tabs-after-hook’, run after opening a Burly bookmark
in ‘burly-tabs-mode’. (Useful for, e.g. integrating with Bufler
(https://github.com/alphapapa/bufler.el) to set the new tab’s
workspace automatically.)
• Option ‘burly-tabs-abbreviate-name’ abbreviates the names of Burly
bookmarks when using ‘burly-tabs-mode’.
*Fixed*
• Preservation of window parameter ‘window-preserved-size’.
File: README.info, Node: 03, Next: 02, Prev: 04-pre, Up: Changelog
3.2 0.3
=======
*Added*
• Command ‘burly-tabs-mode’, which integrates Burly with
‘tab-bar-mode’. When active, Burly bookmarks are opened in new
tabs, and the tabs are named according to the bookmark.
• Command ‘burly-reset-tab’, which resets a tab to the state of the
bookmark which opened it.
*Changed*
• Emacs version 28.1 or later is required.
*Fixed*
• Buffers that can’t be restored by name no longer cause an error
which aborts restoration of the rest of the bookmark’s buffers.
• Added workaround for regression in Emacs 28 regarding bookmarks for
‘help-mode’ buffers. (See Emacs bug 56643
(https://debbugs.gnu.org/cgi/bugreport.cgi?bug=56643).)
• Removed unadvisable local rebinding of ‘alist-get’ in function
‘burly-follow-url-org-mode’. An innocent change in Org 9.6 was
broken by this, which then broke this when called through Burly.
(With thanks to Ihor Radchenko (https://github.com/yantar92) for
debugging.)
• Load default bookmarks file when needed. (#46
(https://github.com/alphapapa/burly.el/issues/46). Thanks to Billy
Zheng (https://github.com/zw963) and ParetoOptimalDev
(https://github.com/ParetoOptimalDev) for reporting, and to Thomas
Freeman (https://github.com/tfree87) for fixing.)
File: README.info, Node: 02, Next: 01, Prev: 03, Up: Changelog
3.3 0.2
=======
*Added*
• Bookmark commands use ‘completing-read’ and offer existing Burly
bookmark names, making it easier to update bookmarks. (Thanks to
Erik Sjöstrand (https://github.com/Kungsgeten).)
• Command ‘burly-open-last-bookmark’.
• Option ‘burly-set-window-persistent-parameters’, which synchronizes
‘window-persistent-parameters’ with
‘burly-window-persistent-parameters’, ensuring that built-in Emacs
commands like ‘window-toggle-side-windows’ persist parameters that
are persisted with Burly.
*Changed*
• Option ‘burly-window-persistent-parameters’’s default value
includes more window parameters, like header/mode line, side, slot,
etc, making it easier to restore an overview of a project or
"workspace."
• Emacs version 27.1 or later is required.
*Fixed*
• Narrow Org buffers to correct heading (at the top of the buffer
rather than at point).
• Buffers whose names have multibyte characters. (Fixes #43
(https://github.com/alphapapa/burly.el/issues/43). Thanks to Liu
Hui (https://github.com/ilupin) for reporting.)
• Bind ‘print-level’ to nil where ‘prin1-to-string’ is used (in case
the value is non-nil in a user’s config, which would cause
truncated values).
File: README.info, Node: 01, Prev: 02, Up: Changelog
3.4 0.1
=======
Initial release.
File: README.info, Node: Development, Next: Credits, Prev: Changelog, Up: Top
4 Development
*************
Bug reports, feature requests, suggestions — _oh my_!
File: README.info, Node: Credits, Next: License, Prev: Development, Up: Top
5 Credits
*********
• Thanks to Clemens Radermacher (https://github.com/clemera) and
Robert Weiner (https://github.com/rswgnu) for their suggestions.
• Thanks to Trey Peacock (https://github.com/tpeacock19) for
extensive feedback on pre-release versions.
File: README.info, Node: License, Prev: Credits, Up: Top
6 License
*********
GPLv3
Tag Table:
Node: Top219
Node: Installation2550
Node: MELPA2701
Node: Quelpa2873
Node: Manual3186
Node: Usage3455
Node: Bookmark commands3626
Node: URL commands4492
Node: Tab bar5173
Node: Tips5662
Node: Changelog5857
Node: 04-pre6027
Node: 036587
Node: 028018
Node: 019435
Node: Development9529
Node: Credits9700
Node: License10060
End Tag Table
Local Variables:
coding: utf-8
End: