[elpa] externals/beframe 2fdabea0c6 06/10: Rewrite the manual about assuming and unassuming buffers

[ELPA Syncer]

branch: externals/beframe
commit 2fdabea0c6a9c2c40ba635f2fd4c81a13966b33b
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Rewrite the manual about assuming and unassuming buffers
---
 README.org | 108 ++++++++++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 78 insertions(+), 30 deletions(-)

diff --git a/README.org b/README.org
index 0a3116701a..f6372899d6 100644
--- a/README.org
+++ b/README.org
@@ -104,36 +104,84 @@ of ~beframe-create-frame-scratch-buffer~.  It kills the 
frame-specific
 scratch buffer after the frame is deleted.  Set this user option to
 ~nil~ to disable the killing of such buffers.
 
-#+findex: beframe-assume-frame-buffers
-#+findex: beframe-add-frame-buffers
-The command ~beframe-assume-frame-buffers~ (alias
-~beframe-add-frame-buffers~) prompts for a frame and then copies its
-buffer list into the current frame.
-
-#+findex: beframe-unassume-frame-buffers
-#+findex: beframe-remove-frame-buffers
-The command ~beframe-unassume-frame-buffers~ (alias
-~beframe-remove-frame-buffers~) prompts for a frame and then removes
-its buffer list from the current frame.
-
-#+findex: beframe-assume-buffers
-#+findex: beframe-add-buffers
-The command ~beframe-assume-buffers~ (alias ~beframe-add-buffers~)
-adds buffers from a given frame to the current frame.  In interactive
-use, the command first prompts for a frame and then asks about the
-list of buffers therein.  The to-be-assumed buffer list is compiled
-with ~completing-read-multiple~.  This means that the user can select
-multiple buffers, each separated by the ~crm-separator~ (typically a
-comma).
-
-#+findex: beframe-unassume-buffers
-#+findex: beframe-remove-buffers
-The command ~beframe-unassume-buffers~ (alias
-~beframe-remove-buffers~) removes buffers from the current frame.  In
-interactive use, the to-be-unassumed buffer list is compiled with
-~completing-read-multiple~.  This means that the user can select
-multiple buffers, each separated by the ~crm-separator~ (typically a
-comma).
+* Assuming and unassuming buffers
+:PROPERTIES:
+:CUSTOM_ID: h:97b140d0-677d-427d-b9c4-631dc36dbab7
+:END:
+
+[ Part of {{{development-version}}}. ]
+
+Beframe makes it possible to add or remove buffers from the list of
+buffers associated with the current frame.  This provides for a
+flexible workflow where buffers can be beframed but consolidated on
+demand into new lists.
+
+** Assuming buffers
+:PROPERTIES:
+:CUSTOM_ID: h:dc12ca87-9ba7-4d11-89c8-653bf19015a1
+:END:
+
+[ Part of {{{development-version}}}. ]
+
+To assume buffers is to include them from the buffer list associated
+with the current frame.
+
+  #+findex: beframe-assume-frame-buffers
+  #+findex: beframe-add-frame-buffers
+- The command ~beframe-assume-frame-buffers~ (alias
+  ~beframe-add-frame-buffers~) prompts for a frame and then copies its
+  buffer list into the current frame.
+
+  #+findex: beframe-assume-buffers
+  #+findex: beframe-add-buffers
+- The command ~beframe-assume-buffers~ (alias ~beframe-add-buffers~)
+  adds buffers from a given frame to the current frame.  In
+  interactive use, the command first prompts for a frame and then asks
+  about the list of buffers therein.  The to-be-assumed buffer list is
+  compiled with ~completing-read-multiple~.  This means that the user
+  can select multiple buffers, each separated by the ~crm-separator~
+  (typically a comma).
+
+  #+findex: beframe-assume-buffers-all-frames
+- The command ~beframe-assume-buffers-all-frames~ prompts with
+  minibuffer completion for a list of buffers to assume.  The
+  interface is the same as that of ~beframe-assume-buffers~ except
+  that there is no prompt for a frame: buffers belong to the
+  consolidated buffer list (all frames).
+
+  #+findex: beframe-assume-all-buffers-no-prompts
+- The command ~beframe-assume-all-buffers-no-prompts~ unconditionally
+  assumes the consolidated buffer list.
+
+** Unassuming buffers
+:PROPERTIES:
+:CUSTOM_ID: h:8fb895ac-7f99-4c92-b15a-18871b30c7b9
+:END:
+
+[ Part of {{{development-version}}}. ]
+
+To unassume buffers is to omit them from the buffer list associated
+with the current frame.
+
+  #+findex: beframe-unassume-frame-buffers
+  #+findex: beframe-remove-frame-buffers
+- The command ~beframe-unassume-frame-buffers~ (alias
+  ~beframe-remove-frame-buffers~) prompts for a frame and then removes
+  its buffer list from the current frame.
+
+  #+findex: beframe-unassume-buffers
+  #+findex: beframe-remove-buffers
+- The command ~beframe-unassume-buffers~ (alias
+  ~beframe-remove-buffers~) removes buffers from the current frame.
+  In interactive use, the to-be-unassumed buffer list is compiled with
+  ~completing-read-multiple~.  This means that the user can select
+  multiple buffers, each separated by the ~crm-separator~ (typically a
+  comma).
+
+  #+findex: beframe-unassume-all-buffers-no-prompts
+- The command ~beframe-unassume-all-buffers-no-prompts~ unconditionally
+  unassumes the consolidated buffer list, but preserves the list
+  stored in the user option ~beframe-global-buffers~.
 
 * Features of ~beframe-mode~
 :PROPERTIES: