[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/bufferlo 6e25a3e1cd 6/7: Update documentation
From: |
ELPA Syncer |
Subject: |
[elpa] externals/bufferlo 6e25a3e1cd 6/7: Update documentation |
Date: |
Sun, 12 May 2024 12:57:46 -0400 (EDT) |
branch: externals/bufferlo
commit 6e25a3e1cdf8ca26966c3d9ded5408b3066b4ddb
Author: Florian Rommel <mail@florommel.de>
Commit: Florian Rommel <mail@florommel.de>
Update documentation
---
README.org | 46 +++++++++++++++++++++++++---------------------
bufferlo.el | 30 ++++++++++--------------------
2 files changed, 35 insertions(+), 41 deletions(-)
diff --git a/README.org b/README.org
index b363b92329..a0c526b199 100644
--- a/README.org
+++ b/README.org
@@ -10,22 +10,23 @@ with the standard frame and tab management facilities,
including
undeletion of frames and tabs, tab duplication and moving, frame
cloning, and persisting sessions (via desktop.el).
-A buffer is added to the local buffer list when it is displayed in the
-frame/tab (e.g., by opening a new file in the tab or by switching to
-the buffer from the global buffer list). In addition, bufferlo
-provides functions that allow the manipulation of the local buffer
-list. Bufferlo does not touch the global buffer list or the existing
-buffer-management facilities. Use the equivalent bufferlo variants to
-work with the frame/tab local buffer list.
+With bufferlo, every frame or tab (if you use tab-bar tabs) has an
+additional manageable local buffer list. A buffer is added to the
+local buffer list when displayed in the frame/tab (e.g., by opening a
+new file in the tab or by switching to the buffer from the global
+buffer list). Bufferlo provides extensive management functions for
+the local list and frame/tab-local variants of the switch-buffer
+function, buffer menu, and Ibuffer. In addition, you can configure
+any command that selects a buffer to use the local buffer list
+(bufferlo anywhere). Bufferlo also allows you to bookmark and persist
+the state of individual frames or tabs.
The packages [[https://github.com/alpaker/frame-bufs][frame-bufs]]
(unmaintained) and [[https://protesilaos.com/emacs/beframe][beframe]] provide
similar
-functionality, but only at the frame level, without support for tabs
-and desktop.el.
-
-You may also have a look at full workspace solutions like
-[[https://github.com/alphapapa/bufler.el][bufler]] (automatic rule-based
workspace management and buffer grouping)
-or [[https://github.com/nex3/perspective-el][perspective]] (comprehensive
workspace isolation, workspace merging,
-workspace persistence). They work quite differently than bufferlo.
+functionality, but only at the frame level, without support for tabs.
+You may also have a look at (more different) workspace-oriented solutions
+like [[https://github.com/alphapapa/bufler.el][bufler]] (rule-based workspace
management and buffer grouping),
+[[https://github.com/nex3/perspective-el][perspective]] (comprehensive
workspace isolation and persistence),
+or [[https://github.com/alphapapa/activities.el][activities.el]]
(purpose-based session management on frame/tab level).
* Installation
@@ -66,6 +67,9 @@ respective global commands:
Orphan buffers are buffers that are not in any frame/tab's local
buffer list.
+The functions ~previous-buffer~ and ~next-buffer~ are automatically aware
+of the local buffer list when ~bufferlo-mode~ is enabled.
+
Bufferlo provides functions to manage the local buffer lists:
- ~bufferlo-clear~:
Clear the frame/tab's buffer list.
@@ -285,12 +289,12 @@ Of course, you can also set an arbitrary buffer as the
initial frame buffer:
** Bufferlo Anywhere
-"Bufferlo anywhere" is an optional feature that lets you have
-bufferlo's frame/tab-local buffer list anywhere you like, i.e. in any
-command with interactive buffer selection (via ~read-buffer~,
-e.g., ~diff-buffers~, ~make-indirect-buffer~, ...) -- not just in the
-switch-buffer facilities. You can configure which commands use
-bufferlo's local list and which use the global list.
+"Bufferlo anywhere" lets you have bufferlo's frame/tab-local buffer
+list anywhere you like, i.e. in any command with interactive buffer
+selection (via ~read-buffer~, e.g., ~diff-buffers~, ~make-indirect-buffer~,
+...) -- not just in the switch-buffer facilities. You can configure
+which commands use bufferlo's local list and which use the global
+list.
Enable ~bufferlo-anywhere-mode~ to use bufferlo's local buffer list by
default. Customize ~bufferlo-anywhere-filter~ and
@@ -299,6 +303,6 @@ local list. With the command prefix
~bufferlo-anywhere-disable-prefix~,
you can temporarily disable ~bufferlo-anywhere-mode~ for the next
command.
-Instead the minor mode, you can use the command prefix
+Instead of the minor mode, you can use the command prefix
~bufferlo-anywhere-enable-prefix~, which only temporarily enables
bufferlo's local buffer list for the next command.
diff --git a/bufferlo.el b/bufferlo.el
index fabf99892d..410959a071 100644
--- a/bufferlo.el
+++ b/bufferlo.el
@@ -33,26 +33,16 @@
;; including undeletion of frame and tabs, tab duplication and moving,
;; frame cloning, and persisting sessions (via desktop.el).
-;; A buffer is added to the local buffer list when it is displayed in
-;; the frame/tab (e.g., by opening a new file in the tab or by
-;; switching to the buffer from the global buffer list). In addition,
-;; bufferlo provides functions that allow the manipulation of the
-;; local buffer list. Bufferlo does not touch the global buffer list
-;; or the existing buffer-management facilities. Use the equivalent
-;; bufferlo variants to work with the frame/tab local buffer list.
-
-;; The packages frame-bufs (unmaintained) and beframe provide similar
-;; functionality, but only at the frame level, without support for
-;; tabs and desktop.el.
-;; https://github.com/alpaker/frame-bufs
-;; https://protesilaos.com/emacs/beframe
-
-;; You may also have a look at full workspace solutions like bufler
-;; (automatic rule-based workspace management and buffer grouping) or
-;; perspective (comprehensive workspace isolation, workspace merging,
-;; workspace persistence). They work quite differently than bufferlo.
-;; https://github.com/alphapapa/bufler.el
-;; https://github.com/nex3/perspective-el
+;; With bufferlo, every frame or tab (if you use tab-bar tabs) has an
+;; additional manageable local buffer list. A buffer is added to the
+;; local buffer list when displayed in the frame/tab (e.g., by opening
+;; a new file in the tab or by switching to the buffer from the global
+;; buffer list). Bufferlo provides extensive management functions for
+;; the local list and frame/tab-local variants of the switch-buffer
+;; function, buffer menu, and Ibuffer. In addition, you can configure
+;; any command that selects a buffer to use the local buffer list
+;; (bufferlo anyhwere). Bufferlo also allows you to bookmark and
+;; persist the state of individual frames or tabs.
;;; Code:
- [elpa] externals/bufferlo updated (90ba743101 -> 9a856826bb), ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo 465fd42aef 2/7: Add missing requires, ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo c2580a9d1f 4/7: Fix default values for bufferlo-anywhere-filter, ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo 8d08bca744 3/7: Add bookmarking feature for frames and tabs, ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo 9cf9ff8e1d 1/7: Remove cl-lib dependency, ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo 4ba5bee7fd 5/7: Add warnings for bufferlo functions, ELPA Syncer, 2024/05/12
- [elpa] externals/bufferlo 6e25a3e1cd 6/7: Update documentation,
ELPA Syncer <=
- [elpa] externals/bufferlo 9a856826bb 7/7: Version 0.7, ELPA Syncer, 2024/05/12