Build executable image from load.lisp.
[clfswm.git] / doc / variables.txt
blob09cf97eb1bfb8fe3ee1a923984b3c1d594791446
1     * CLFSWM Configuration variables *
2       ------------------------------
4 <= Circulate Mode Group =>
6   *CIRCULATE-TEXT-LIMITE* = 30
7     Maximum text limite in the circulate window
8   *CIRCULATE-TRANSPARENCY* = 0.8
9     Circulate window background transparency
10   *CIRCULATE-HEIGHT* = 15
11     Circulate mode window height
12   *CIRCULATE-WIDTH* = 400
13     Circulate mode window width
14   *CIRCULATE-BORDER* = "red"
15     Circulate string window border color
16   *CIRCULATE-FOREGROUND* = "green"
17     Circulate string window foreground color
18   *CIRCULATE-BACKGROUND* = "black"
19     Circulate string window background color
20   *CIRCULATE-FONT-STRING* = "fixed"
21     Circulate string window font string
24 <= Corner Group =>
26   *CORNER-COMMAND-TRY-NUMBER* = 10
27     Number of try to wait the window in query tree
28   *CORNER-COMMAND-TRY-DELAY* = 0.2
29     Time to wait before checking window in query tree
30   *CORNER-ERROR-MESSAGE-DELAY* = 5
31     Time to display the error message on commad error
32   *CORNER-ERROR-MESSAGE-COLOR* = "red"
33     Error message color
34   *CLFSWM-TERMINAL-CMD* = "xterm -T clfswm-terminal"
35     
36 The clfswm terminal command.
37 This command must set the window title to *clfswm-terminal-name*
38   *CLFSWM-TERMINAL-NAME* = "clfswm-terminal"
39     The clfswm terminal name
40   *VIRTUAL-KEYBOARD-CMD* = "xvkbd"
41     
42 The command to display the virtual keybaord
43   Here is an ~/.Xresources example for xvkbd:
44     xvkbd.windowGeometry: 300x100-0-0
45     xvkbd*Font: 6x12
46     xvkbd.modalKeytop: true
47     xvkbd.customization: -french
48     xvkbd.keypad: false
49   And make it always on top
50   *CORNER-SECOND-MODE-RIGHT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
51     Actions on corners in the second mode with the right mouse button
52   *CORNER-SECOND-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
53     Actions on corners in the second mode with the middle mouse button
54   *CORNER-SECOND-MODE-LEFT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
55     Actions on corners in the second mode with the left mouse button
56   *CORNER-MAIN-MODE-RIGHT-BUTTON* = 
57 ((:TOP-LEFT PRESENT-CLFSWM-TERMINAL) (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW) (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
58  (:BOTTOM-LEFT START-FILE-MANAGER))
59     Config(Corner group): Actions on corners in the main mode with the right mouse button
60   *CORNER-MAIN-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM) (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW) (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
61     Actions on corners in the main mode with the middle mouse button
62   *CORNER-MAIN-MODE-LEFT-BUTTON* = ((:TOP-LEFT OPEN-MENU) (:TOP-RIGHT PRESENT-VIRTUAL-KEYBOARD) (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
63     Actions on corners in the main mode with the left mouse button
64   *CORNER-SIZE* = 3
65     The size of the corner square
68 <= Expose Mode Group =>
70   *EXPOSE-DIRECT-SELECT* = T
71     Immediately select child if they can be directly accessed
72   *EXPOSE-TRANSPARENCY* = 0.9
73     Expose string window background transparency
74   *EXPOSE-SHOW-WINDOW-TITLE* = T
75     Show the window title on accel window
76   *EXPOSE-VALID-ON-KEY* = T
77     Valid expose mode when an accel key is pressed
78   *EXPOSE-BORDER* = "grey20"
79     Expose string window border color
80   *EXPOSE-BACKGROUND-LETTER-MATCH* = "green"
81     Expose string window background color for matching letters
82   *EXPOSE-FOREGROUND-LETTER-NOK* = "grey30"
83     Expose string window foreground color for letter not selected
84   *EXPOSE-FOREGROUND-LETTER* = "red"
85     Expose string window foreground color for letters
86   *EXPOSE-FOREGROUND* = "grey50"
87     Expose string window foreground color
88   *EXPOSE-BACKGROUND* = "grey10"
89     Expose string window background color
90   *EXPOSE-FONT-STRING* = "fixed"
91     Expose string window font string
94 <= Frame Colors Group =>
96   *FRAME-TRANSPARENCY* = 0.6
97     Frame background transparency
98   *FRAME-FOREGROUND-HIDDEN* = "Darkgreen"
99     Frame foreground for hidden windows
100   *FRAME-FOREGROUND-ROOT* = "Red"
101     Frame foreground when the frame is the root frame
102   *FRAME-FOREGROUND* = "Green"
103     Frame foreground
104   *FRAME-BACKGROUND* = "Black"
105     Frame background
108 <= Gimp Layout Group =>
110   *GIMP-LAYOUT-NOTIFY-WINDOW-DELAY* = 30
111     Time to display the GIMP layout notify window help
114 <= Hook Group =>
116   *QUERY-BUTTON-PRESS-HOOK* = NIL
117     Query hook. Hook called on each button press event in query loop
118   *QUERY-KEY-PRESS-HOOK* = (QUERY-MODE-COMPLETE-SUGGEST-RESET)
119     Query hook. Hook called on each key press event in query loop
120   *DEFAULT-NW-HOOK* = DEFAULT-FRAME-NW-HOOK
121     Default action to do on newly created windows
122   *CLOSE-HOOK* = (CLOSE-NOTIFY-WINDOW CLOSE-CLFSWM-TERMINAL CLOSE-VIRTUAL-KEYBOARD CLOSE-ALL-TOOLBARS)
123     Close hook. This hook is run just before closing the display
124   *INIT-HOOK* = (DEFAULT-INIT-HOOK DISPLAY-HELLO-WINDOW OPEN-ALL-TOOLBARS MY-INIT-HOOK MY-WALLPAPER)
125     Init hook. This hook is run just after the first root frame is created
126   *ROOT-SIZE-CHANGE* = (MY-WALLPAPER)
127     Hook executed when the root size has changed for example when adding/removing a monitor
128   *MAIN-ENTRANCE-HOOK* = NIL
129     
130 Hook executed on the main function entrance after
131 loading configuration file and before opening the display.
132   *LOOP-HOOK* = NIL
133     Hook executed on each event loop
134   *BINDING-HOOK* = 
135 (INIT-*QUERY-KEYS* SET-DEFAULT-QUERY-KEYS SET-DEFAULT-CIRCULATE-KEYS INIT-*INFO-KEYS* INIT-*INFO-MOUSE*
136  SET-DEFAULT-INFO-KEYS SET-DEFAULT-INFO-MOUSE INIT-*MAIN-KEYS* INIT-*MAIN-MOUSE* SET-DEFAULT-MAIN-KEYS
137  SET-DEFAULT-MAIN-MOUSE INIT-*SECOND-KEYS* INIT-*SECOND-MOUSE* SET-DEFAULT-SECOND-KEYS SET-DEFAULT-SECOND-MOUSE
138  MPD-BINDING FR-BINDING REBOOT-HALT-BINDING INIT-*VOLUME-KEYS* SET-DEFAULT-VOLUME-KEYS AMIXER-VOLUME-BIND LOCAL-BINDING)
139     Hook executed when keys/buttons are bounds
142 <= Identify Key Group =>
144   *IDENTIFY-TRANSPARENCY* = 0.8
145     Identify window background transparency
146   *IDENTIFY-BORDER* = "red"
147     Identify window border color
148   *IDENTIFY-FOREGROUND* = "green"
149     Identify window foreground color
150   *IDENTIFY-BACKGROUND* = "black"
151     Identify window background color
152   *IDENTIFY-FONT-STRING* = "fixed"
153     Identify window font string
156 <= Info Mode Group =>
158   *INFO-COLOR-SECOND* = "lightblue"
159     Colored info second color
160   *INFO-COLOR-FIRST* = "Cyan"
161     Colored info first color
162   *INFO-COLOR-UNDERLINE* = "Yellow"
163     Colored info underline color
164   *INFO-COLOR-TITLE* = "Magenta"
165     Colored info title color
166   *INFO-CLICK-TO-SELECT* = T
167     If true, click on info window select item. Otherwise, click to drag the menu
168   *INFO-TRANSPARENCY* = 0.8
169     Info window background transparency
170   *INFO-FONT-STRING* = "fixed"
171     Info window font string
172   *INFO-SELECTED-BACKGROUND* = "blue"
173     Info selected item background color
174   *INFO-LINE-CURSOR* = "white"
175     Info window line cursor color color
176   *INFO-BORDER* = "red"
177     Info window border color
178   *INFO-FOREGROUND* = "green"
179     Info window foreground color
180   *INFO-BACKGROUND* = "black"
181     Info window background color
184 <= Main Mode Group =>
186   *COLOR-MAYBE-SELECTED* = "Yellow"
187     Color of maybe selected windows
188   *COLOR-UNSELECTED* = "Blue"
189     Color of unselected color
190   *COLOR-SELECTED* = "Red"
191     Color of selected window
192   *COLOR-MOVE-WINDOW* = "DeepPink"
193     Color when moving or resizing a windows
196 <= Menu Group =>
198   *MENU-KEY-BOUND-COLOR* = "gray50"
199     Key bound min menu color
200   *MENU-COLOR-MENU-KEY* = #<XLIB:COLOR 0.99609375 0.6015625 0.99609375>
201     Menu key color in menu
202   *MENU-COLOR-KEY* = "Magenta"
203     Key color in menu
204   *MENU-COLOR-COMMENT* = "Yellow"
205     Comment color in menu
206   *MENU-COLOR-SUBMENU* = "Cyan"
207     Submenu color in menu
208   *XDG-SECTION-LIST* = 
209 (TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK OFFICE SETTINGS
210  SYSTEM UTILITY TERMINALEMULATOR SCREENSAVER)
211     Standard menu sections
214 <= Miscellaneous Group =>
216   *DEFAULT-WINDOW-HEIGHT* = 300
217     Default window height
218   *DEFAULT-WINDOW-WIDTH* = 400
219     Default window width
220   *SPATIAL-MOVE-DELAY-AFTER* = 0.5
221     Delay to display the new child after doing a spatial move
222   *SPATIAL-MOVE-DELAY-BEFORE* = 0.2
223     Delay to display the current child before doing a spatial move
224   *SNAP-SIZE* = 5
225     Snap size (in % of parent size) when move or resize frame is constrained
226   *HIDE-UNMANAGED-WINDOW* = T
227     Hide or not unmanaged windows when a child is deselected.
228   *NEVER-MANAGED-WINDOW-LIST* = 
229 ((IS-NOTIFY-WINDOW-P RAISE-WINDOW) (EQUAL-WM-CLASS-ROX-PINBOARD NIL) (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW)
230  (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW))
231     
232 CLFSWM will never manage windows of this type.
233 A list of (list match-function handle-function)
234   *DEFAULT-MODIFIERS* = NIL
235     
236 Default modifiers list to append to explicit modifiers
237 Example: :mod-2 for num_lock, :lock for Caps_lock...
238   *SHOW-HIDE-POLICY* = #<SYSTEM-FUNCTION <=>
239     
240 'NIL': always display all children (better with transparency support).
241 '<': Hide only children less than children above.
242 '<=': Hide children less or equal to children above (better for performance on slow machine).
243   *DEFAULT-FOCUS-POLICY* = :CLICK
244     Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select.
245   *DEFAULT-MANAGED-TYPE* = (:NORMAL)
246     Default managed window types
247   *DEFAULT-FRAME-DATA* = ((:TILE-SIZE 0.8) (:TILE-SPACE-SIZE 0.1) (:MAIN-LAYOUT-WINDOWS NIL) (:FAST-LAYOUT (TILE-SPACE-LAYOUT NO-LAYOUT)))
248     Default slots set in frame date
249   *DEFAULT-FONT-STRING* = "fixed"
250     The default font used in clfswm
251   *LOOP-TIMEOUT* = 1
252     Maximum time (in seconds) to wait before calling *loop-hook*
253   *BORDER-SIZE* = 1
254     Windows and frames border size
255   *SHOW-ROOT-FRAME-P* = NIL
256     Show the root frame information or not
257   *DEFAULT-TRANSPARENCY* = 0.8
258     Default transparency for all windows when in xcompmgr transparency mode
259   *TRANSPARENT-BACKGROUND* = T
260     Enable transparent background: one of nil, :pseudo, t (xcompmgr must be started)
261   *HAVE-TO-COMPRESS-NOTIFY* = T
262     
263 Compress event notify?
264 This variable may be useful to speed up some slow version of CLX.
265 It is particulary useful with CLISP/MIT-CLX.
268 <= Notify Window Group =>
270   *NOTIFY-WINDOW-TRANSPARENCY* = 0.8
271     Notify window background transparency
272   *NOTIFY-WINDOW-DELAY* = 10
273     Notify Window display delay
274   *NOTIFY-WINDOW-BORDER* = "red"
275     Notify Window border color
276   *NOTIFY-WINDOW-FOREGROUND* = "green"
277     Notify Window foreground color
278   *NOTIFY-WINDOW-BACKGROUND* = "black"
279     Notify Window background color
280   *NOTIFY-WINDOW-FONT-STRING* = "fixed"
281     Notify window font string
284 <= Placement Group =>
286   *VOLUME-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
287     Volume mode window placement
288   *TOOLBAR-WINDOW-PLACEMENT* = TOP-LEFT-PLACEMENT
289     Toolbar window placement
290   *UNMANAGED-WINDOW-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
291     Unmanager window placement
292   *ASK-CLOSE/KILL-PLACEMENT* = TOP-RIGHT-ROOT-PLACEMENT
293     Ask close/kill window placement
294   *NOTIFY-WINDOW-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
295     Notify window placement
296   *EXPOSE-QUERY-PLACEMENT* = BOTTOM-LEFT-ROOT-PLACEMENT
297     Expose mode query window placement
298   *EXPOSE-MODE-PLACEMENT* = TOP-LEFT-CHILD-PLACEMENT
299     Expose mode window placement (Selection keys position)
300   *CIRCULATE-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
301     Circulate mode window placement
302   *QUERY-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
303     Query mode window placement
304   *INFO-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
305     Info mode window placement
306   *SECOND-MODE-PLACEMENT* = TOP-MIDDLE-ROOT-PLACEMENT
307     Second mode window placement
308   *BANISH-POINTER-PLACEMENT* = MIDDLE-RIGHT-ROOT-PLACEMENT
309     Pointer banishment placement
312 <= Power Management Group =>
314   *POWER-HALT-CMD* = "sudo /sbin/halt"
315     Halt command
316   *POWER-REBOOT-CMD* = "sudo /sbin/reboot"
317     Reboot command
318   *POWER-SUSPEND-TO-DISK-CMD* = "sudo pm-hibernate"
319     Suspend to disk command
320   *POWER-SUSPEND-TO-RAM-CMD* = "sudo pm-suspend"
321     Suspend to ram command
324 <= Query String Group =>
326   *QUERY-MIN-COMPLET-CHAR* = 2
327     Query minimum input length for completion
328   *QUERY-MAX-COMPLET-LENGTH* = 100
329     Query maximum length of completion list
330   *QUERY-TRANSPARENCY* = 0.8
331     Query string window background transparency
332   *QUERY-BORDER* = "red"
333     Query string window border color
334   *QUERY-PARENT-ERROR-COLOR* = "red"
335     Query string window parenthesis color when no match
336   *QUERY-PARENT-COLOR* = "blue"
337     Query string window parenthesis color
338   *QUERY-CURSOR-COLOR* = "white"
339     Query string window foreground cursor color
340   *QUERY-FOREGROUND* = "green"
341     Query string window foreground color
342   *QUERY-MESSAGE-COLOR* = "yellow"
343     Query string window message color
344   *QUERY-BACKGROUND* = "black"
345     Query string window background color
346   *QUERY-FONT-STRING* = "fixed"
347     Query string window font string
350 <= Root Group =>
352   *SHOW-CURRENT-ROOT-MESSAGE* = "Current root"
353     Current root notify window message
354   *SHOW-CURRENT-ROOT-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
355     Current root notify window placement
356   *SHOW-CURRENT-ROOT-DELAY* = 1
357     Delay to show the current root
358   *HAVE-TO-SHOW-CURRENT-ROOT* = T
359     Show the current root if true
360   *CREATE-FRAME-ON-ROOT* = NIL
361     
362 Create frame on root.
363 Set this variable to true if you want to allow to create a new frame
364 on the root window in the main mode with the mouse
367 <= Second Mode Group =>
369   *SM-TRANSPARENCY* = 0.8
370     Second mode background transparency
371   *SM-HEIGHT* = 25
372     Second mode window height
373   *SM-WIDTH* = 300
374     Second mode window width
375   *SM-FONT-STRING* = "fixed"
376     Second mode window font string
377   *SM-FOREGROUND-COLOR* = "Red"
378     Second mode window foreground color
379   *SM-BACKGROUND-COLOR* = "Black"
380     Second mode window background color
381   *SM-BORDER-COLOR* = "Green"
382     Second mode window border color
385 <= Toolbar Group =>
387   *TOOLBAR-VOLUME-MODE-BUTTON-COLOR* = "green"
388     Volume mode color
389   *TOOLBAR-MPD-BUTTONS-COLOR* = "green"
390     MPD - Music Player Daemon buttons color
391   *TOOLBAR-MPD-INFO-COLOR* = "green"
392     MPD - Music Player Daemon information color
393   *MPD-TOOLBAR-CLIENT* = "gmpc"
394     MPD client
395   *MPD-TOOLBAR* = ((MPD-BUTTONS 1) (MPD-INFO 60))
396     MPD toolbar modules
397   *TOOLBAR-EXPOSE-MODE-BUTTON-COLOR* = "green"
398     Expose-mode button
399   *TOOLBAR-SYSTEM-INFO-URGENT-COLOR* = "Red"
400     System information colors (CPU+Mem+Battery)
401   *TOOLBAR-SYSTEM-INFO-ALERT-COLOR* = "Magenta"
402     System information colors (CPU+Mem+Battery)
403   *TOOLBAR-SYSTEM-INFO-LOW-COLOR* = "Yellow"
404     System information colors (CPU+Mem+Battery)
405   *TOOLBAR-SYSTEM-INFO-COLOR* = "green"
406     System information colors (CPU+Mem+Battery)
407   *TOOLBAR-MEM-COLOR* = "green"
408     Memory color
409   *TOOLBAR-CPU-COLOR* = "green"
410     CPU color
411   *TOOLBAR-CLFSWM-MENU-COLOR* = "green"
412     CLFSWM menu color
413   *TOOLBAR-CLOCK-ACTION* = "xclock -analog"
414     Toolbar clickable clock module action on click
415   *TOOLBAR-CLICKABLE-CLOCK-COLOR* = "green"
416     Clickable clock color
417   *TOOLBAR-CLICKABLE-LABEL-COLOR* = "green"
418     Clickable label color
419   *TOOLBAR-LABEL-COLOR* = "green"
420     Label color
421   *TOOLBAR-CLOCK-COLOR* = "green"
422     Clock color
423   *TOOLBAR-SENSIBILITY* = 3
424     Toolbar sensibility in pixels
425   *TOOLBAR-DEFAULT-AUTOHIDE* = NIL
426     Toolbar default autohide value
427   *TOOLBAR-DEFAULT-REFRESH-DELAY* = 30
428     Toolbar default refresh delay
429   *TOOLBAR-DEFAULT-THICKNESS* = 20
430     Toolbar default thickness
431   *TOOLBAR-WINDOW-TRANSPARENCY* = 0.8
432     Toolbar window background transparency
433   *TOOLBAR-DEFAULT-BORDER-SIZE* = 0
434     Toolbar Window border size
435   *TOOLBAR-WINDOW-BORDER* = "red"
436     Toolbar Window border color
437   *TOOLBAR-WINDOW-FOREGROUND* = "green"
438     Toolbar Window foreground color
439   *TOOLBAR-WINDOW-BACKGROUND* = "black"
440     Toolbar Window background color
441   *TOOLBAR-WINDOW-FONT-STRING* = "fixed"
442     Toolbar window font string
443   *DEFAULT-TOOLBAR* = ((CLFSWM-MENU 1) (EXPOSE-MODE-BUTTON 10) (SYSTEM-USAGE 90) (CLICKABLE-CLOCK 99))
444     Default toolbar modules
447 <= Volume Mode Group =>
449   *VOLUME-EXTERNAL-MIXER-CMD* = "/usr/bin/gnome-alsamixer"
450     Command to start an external mixer program
451   *VOLUME-TEXT-LIMIT* = 30
452     Maximum text limit in the volume window
453   *VOLUME-HEIGHT* = 15
454     Volume mode window height
455   *VOLUME-WIDTH* = 400
456     Volume mode window width
457   *VOLUME-BORDER-SIZE* = 1
458     Volume window border size
459   *VOLUME-BORDER* = "red"
460     Volume window border color
461   *VOLUME-FOREGROUND* = "green"
462     Volume window foreground color
463   *VOLUME-BACKGROUND* = "black"
464     Volume window background color
465   *VOLUME-FONT-STRING* = "fixed"
466     Volume window font string
469 <= Wallpaper Group =>
471   *WALLPAPER-COMMAND* = "Esetroot -scale"
472     Command to install the wallpaper
474  Those variables can be changed in clfswm.
475 Maybe you'll need to restart clfswm to take care of new values
477 This documentation was produced with the CLFSWM auto-doc functions.
478 To reproduce it, use the produce-conf-var-doc-in-file or
479 the produce-all-docs function from the Lisp REPL.
481 Something like this:
482 LISP> (in-package :clfswm)
483 CLFSWM> (produce-conf-var-doc-in-file "my-variables.txt")
485 CLFSWM> (produce-all-docs)