[elpa] externals/dtache 082139f1c3 045/158: Add instructions on how to customize annotations

[ELPA Syncer]

branch: externals/dtache
commit 082139f1c3942c77c02e87b280b6eecf90469ea1
Author: Niklas Eklund <niklas.eklund@posteo.net>
Commit: Niklas Eklund <niklas.eklund@posteo.net>

    Add instructions on how to customize annotations
---
 README.org | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.org b/README.org
index abbd236b2f..5c7890231e 100644
--- a/README.org
+++ b/README.org
@@ -112,6 +112,26 @@ Commands to be used in shell buffers.
 | dtache-shell-create     | Create a session            |
 | dtache-shell-attach     | Attach to a session         |
 | dtache-shell-detach     | Detach from a session       |
+* Variables
+
+** Annotations
+
+The user can customize the appearance of annotations in =dtache-open-session= 
by modifying the =dtache-annotation-format=. The default annotation format is 
the following.
+
+#+begin_src elisp
+  (defvar dtache-annotation-format
+    `((:width 3 :function dtache--active-str :face dtache-active-face)
+      (:width 3 :function dtache--status-str :face dtache-failure-face)
+      (:width 10 :function dtache--session-host :face dtache-host-face)
+      (:width 40 :function dtache--working-dir-str :face 
dtache-working-dir-face)
+      (:width 30 :function dtache--metadata-str :face dtache-metadata-face)
+      (:width 10 :function dtache--duration-str :face dtache-duration-face)
+      (:width 8 :function dtache--size-str :face dtache-size-face)
+      (:width 12 :function dtache--creation-str :face dtache-creation-face))
+    "The format of the annotations.")
+#+end_src
+
+If the user wants to remove specific annotations or decrease/increase the 
widths, do that by changing the values for this variable.
 
 * Tips & Tricks
 ** Actions