>From 1d7c3c1153aa355c2a0679900d5afd4e12a27ca0 Mon Sep 17 00:00:00 2001
From: Morgan Veyret <address@hidden>
Date: Sun, 15 Jun 2008 03:02:45 +0200
Subject: [PATCH] Documented *group-dump-dir* and updated sample rc file.

---
 primitives.lisp       |    3 ++-
 sample-stumpwmrc.lisp |   37 ++++++++++++++++++++-----------------
 2 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/primitives.lisp b/primitives.lisp
index ffc120b..8bb69f6 100644
--- a/primitives.lisp
+++ b/primitives.lisp
@@ -909,7 +909,8 @@ will have no effect.")
   "List of rules governing window placement. Use define-frame-preference to
 add rules")
 
-(defvar *group-dump-dir* ".stumpwm.d/")
+(defvar *group-dump-dir* ".stumpwm.d/"
+  "Directory to search for group dump files when applying placement rules.")
 
 (defmacro define-frame-preference (group &rest frames)
   (let ((x (gensym "X")))
diff --git a/sample-stumpwmrc.lisp b/sample-stumpwmrc.lisp
index 8ef329e..084ea3f 100644
--- a/sample-stumpwmrc.lisp
+++ b/sample-stumpwmrc.lisp
@@ -47,26 +47,29 @@
 ;; Last rule to match takes precedence!
 ;; TIP: if the argument to :title or :role begins with an ellipsis, a substring
 ;; match is performed.
-;; TIP: rules won't do anything if the target groups/frames don't exist! Save
-;; your layout with "asfdump" and "asfrestore" will re-create everything for
-;; you.
-
+;; TIP: if the create flag is set then a missing group will be created and
+;; restored from *group-dump-dir*/dump-name file (defaults to group name).
+;; TIP: if the restore flag is set then group dumpis restored even for an
+;; existing group.
 (define-frame-preference "Default"
-  ;; frame raise lock (lock AND raise == jumpto)
-  (0 t nil :class "Konqueror" :role "...konqueror-mainwindow")
-  (1 t nil :class "XTerm"))
+  ;; frame raise lock create restore (lock AND raise == jumpto)
+  (0 t nil nil :class "Konqueror" :role "...konqueror-mainwindow")
+  (1 t nil nil :class "XTerm"))
 
 (define-frame-preference "Ardour"
-  (0 t   t   :instance "ardour_editor" :type :normal)
-  (0 t   t   :title "Ardour - Session Control")
-  (0 nil nil :class "XTerm")
-  (1 t   nil :type :normal)
-  (1 t   t   :instance "ardour_mixer")
-  (2 t   t   :instance "jvmetro")
-  (1 t   t   :instance "qjackctl")
-  (3 t   t   :instance "qjackctl" :role "qjackctlMainForm"))
+  (0 t   t nil nil  :instance "ardour_editor" :type :normal)
+  (0 t   t    nil nil :title "Ardour - Session Control")
+  (0 nil nil  nil nil :class "XTerm")
+  (1 t   nil  nil nil :type :normal)
+  (1 t   t    nil nil :instance "ardour_mixer")
+  (2 t   t   nil nil  :instance "jvmetro")
+  (1 t   t   nil nil  :instance "qjackctl")
+  (3 t   t   nil nil  :instance "qjackctl" :role "qjackctlMainForm"))
 
 (define-frame-preference "Shareland"
-  (0 t   nil :class "XTerm")
-  (1 nil t   :class "aMule"))
+  (0 t   nil  nil nil :class "XTerm")
+  (1 nil t   nil nil  :class "aMule"))
 
+(define-frame-preference "Emacs"
+  (1 t t t t  :dump-name "emacs-editing" :title "...xdvi")
+  (0 t t t nil :class "Emacs"))
\ No newline at end of file
-- 
1.5.5.1