4 CLFSWM - Configuration variables
10 CLFSWM - Configuration variables
14 Here are the variables you can configure in CLFSWM with the configuration file or the configuration menu:
18 Configuration variables groups:
23 <a href='#circulate-mode'
>
33 <a href='#expose-mode'
>
38 <a href='#frame-colors'
>
43 <a href='#gimp-layout'
>
53 <a href='#identify-key'
>
73 <a href='#miscellaneous'
>
78 <a href='#notify-window'
>
88 <a href='#query-string'
>
93 <a href='#second-mode'
>
99 <a name='circulate-mode' href='#top'
>
100 <= Circulate Mode Group =
>
103 <font color='#ff0000'
>
104 *circulate-font-string*
106 <font color='#
0000ff'
>
109 Circulate string window font string
<br>
111 <font color='#ff0000'
>
112 *circulate-background*
114 <font color='#
0000ff'
>
117 Circulate string window background color
<br>
119 <font color='#ff0000'
>
120 *circulate-foreground*
122 <font color='#
0000ff'
>
125 Circulate string window foreground color
<br>
127 <font color='#ff0000'
>
128 *circulate-border*
130 <font color='#
0000ff'
>
133 Circulate string window border color
<br>
135 <font color='#ff0000'
>
136 *circulate-width*
138 <font color='#
0000ff'
>
141 Circulate mode window width
<br>
143 <font color='#ff0000'
>
144 *circulate-height*
146 <font color='#
0000ff'
>
149 Circulate mode window height
<br>
151 <font color='#ff0000'
>
152 *circulate-text-limite*
154 <font color='#
0000ff'
>
157 Maximum text limite in the circulate window
<br>
160 <a name='corner' href='#top'
>
161 <= Corner Group =
>
164 <font color='#ff0000'
>
165 *corner-size*
167 <font color='#
0000ff'
>
170 The size of the corner square
<br>
172 <font color='#ff0000'
>
173 *corner-main-mode-left-button*
175 <font color='#
0000ff'
>
176 = ((:TOP-LEFT OPEN-MENU)
<br>
178 (:TOP-RIGHT PRESENT-VIRTUAL-KEYBOARD)
<br>
180 (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE)
<br>
182 (:BOTTOM-LEFT NIL))
<br>
184 Actions on corners in the main mode with the left mouse button
<br>
186 <font color='#ff0000'
>
187 *corner-main-mode-middle-button*
189 <font color='#
0000ff'
>
190 = ((:TOP-LEFT HELP-ON-CLFSWM)
<br>
192 (:TOP-RIGHT
<br>
194 ASK-CLOSE/KILL-CURRENT-WINDOW)
<br>
196 (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
<br>
198 Actions on corners in the main mode with the middle mouse button
<br>
200 <font color='#ff0000'
>
201 *corner-main-mode-right-button*
203 <font color='#
0000ff'
>
204 = ((:TOP-LEFT PRESENT-CLFSWM-TERMINAL)
<br>
206 (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW)
<br>
208 (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
<br>
210 (:BOTTOM-LEFT NIL))
<br>
212 Actions on corners in the main mode with the right mouse button
<br>
214 <font color='#ff0000'
>
215 *corner-second-mode-left-button*
217 <font color='#
0000ff'
>
218 = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL)
<br>
220 (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE)
<br>
222 (:BOTTOM-LEFT NIL))
<br>
224 Actions on corners in the second mode with the left mouse button
<br>
226 <font color='#ff0000'
>
227 *corner-second-mode-middle-button*
229 <font color='#
0000ff'
>
230 = ((:TOP-LEFT HELP-ON-CLFSWM)
<br>
232 (:TOP-RIGHT NIL) (:BOTTOM-RIGHT NIL)
<br>
234 (:BOTTOM-LEFT NIL))
<br>
236 Actions on corners in the second mode with the middle mouse button
<br>
238 <font color='#ff0000'
>
239 *corner-second-mode-right-button*
241 <font color='#
0000ff'
>
242 = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL)
<br>
244 (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
<br>
246 (:BOTTOM-LEFT NIL))
<br>
248 Actions on corners in the second mode with the right mouse button
<br>
250 <font color='#ff0000'
>
251 *virtual-keyboard-cmd*
253 <font color='#
0000ff'
>
256 The command to display the virtual keybaord
<br>
258 Here is an ~/.Xresources example for xvkbd:
<br>
260 xvkbd.windowGeometry:
300x100-
0-
0 <br>
262 xvkbd*Font:
6x12
<br>
264 xvkbd.modalKeytop: true
<br>
266 xvkbd.customization: -french
<br>
268 xvkbd.keypad: false
<br>
270 And make it always on top
<br>
272 <font color='#ff0000'
>
273 *clfswm-terminal-name*
275 <font color='#
0000ff'
>
276 =
"clfswm-terminal" <br>
278 The clfswm terminal name
<br>
280 <font color='#ff0000'
>
281 *clfswm-terminal-cmd*
283 <font color='#
0000ff'
>
284 =
"xterm -T clfswm-terminal" <br>
286 The clfswm terminal command.
<br>
288 This command must set the window title to *clfswm-terminal-name*
<br>
291 <a name='expose-mode' href='#top'
>
292 <= Expose Mode Group =
>
295 <font color='#ff0000'
>
296 *expose-font-string*
298 <font color='#
0000ff'
>
301 Expose string window font string
<br>
303 <font color='#ff0000'
>
304 *expose-background*
306 <font color='#
0000ff'
>
309 Expose string window background color
<br>
311 <font color='#ff0000'
>
312 *expose-foreground*
314 <font color='#
0000ff'
>
317 Expose string window foreground color
<br>
319 <font color='#ff0000'
>
320 *expose-border*
322 <font color='#
0000ff'
>
325 Expose string window border color
<br>
327 <font color='#ff0000'
>
328 *expose-valid-on-key*
330 <font color='#
0000ff'
>
333 Valid expose mode when an accel key is pressed
<br>
335 <font color='#ff0000'
>
336 *expose-show-window-title*
338 <font color='#
0000ff'
>
341 Show the window title on accel window
<br>
344 <a name='frame-colors' href='#top'
>
345 <= Frame Colors Group =
>
348 <font color='#ff0000'
>
349 *frame-background*
351 <font color='#
0000ff'
>
354 Frame background
<br>
356 <font color='#ff0000'
>
357 *frame-foreground*
359 <font color='#
0000ff'
>
362 Frame foreground
<br>
364 <font color='#ff0000'
>
365 *frame-foreground-root*
367 <font color='#
0000ff'
>
370 Frame foreground when the frame is the root frame
<br>
372 <font color='#ff0000'
>
373 *frame-foreground-hidden*
375 <font color='#
0000ff'
>
378 Frame foreground for hidden windows
<br>
381 <a name='gimp-layout' href='#top'
>
382 <= Gimp Layout Group =
>
385 <font color='#ff0000'
>
386 *gimp-layout-notify-window-delay*
388 <font color='#
0000ff'
>
391 Time to display the GIMP layout notify window help
<br>
394 <a name='hook' href='#top'
>
395 <= Hook Group =
>
398 <font color='#ff0000'
>
399 *binding-hook*
401 <font color='#
0000ff'
>
402 = (SET-DEFAULT-CIRCULATE-KEYS SET-DEFAULT-EXPOSE-KEYS
<br>
404 INIT-*INFO-KEYS*
<br>
406 INIT-*INFO-MOUSE*
<br>
408 SET-DEFAULT-INFO-KEYS
<br>
410 SET-DEFAULT-INFO-MOUSE
<br>
412 INIT-*QUERY-KEYS*
<br>
414 SET-DEFAULT-QUERY-KEYS
<br>
416 INIT-*MAIN-KEYS*
<br>
418 INIT-*MAIN-MOUSE*
<br>
420 SET-DEFAULT-MAIN-KEYS
<br>
422 SET-DEFAULT-MAIN-MOUSE
<br>
424 INIT-*SECOND-KEYS*
<br>
426 INIT-*SECOND-MOUSE*
<br>
428 SET-DEFAULT-SECOND-KEYS
<br>
430 SET-DEFAULT-SECOND-MOUSE)
<br>
432 Hook executed when keys/buttons are bounds
<br>
434 <font color='#ff0000'
>
435 *loop-hook*
437 <font color='#
0000ff'
>
440 Hook executed on each event loop
<br>
442 <font color='#ff0000'
>
443 *main-entrance-hook*
445 <font color='#
0000ff'
>
448 Hook executed on the main function entrance after
<br>
450 loading configuration file and before opening the display.
<br>
452 <font color='#ff0000'
>
453 *init-hook*
455 <font color='#
0000ff'
>
456 = (DEFAULT-INIT-HOOK DISPLAY-HELLO-WINDOW)
<br>
458 Init hook. This hook is run just after the first root frame is created
<br>
460 <font color='#ff0000'
>
461 *close-hook*
463 <font color='#
0000ff'
>
464 = (CLOSE-NOTIFY-WINDOW CLOSE-CLFSWM-TERMINAL
<br>
466 CLOSE-VIRTUAL-KEYBOARD)
<br>
468 Close hook. This hook is run just before closing the display
<br>
470 <font color='#ff0000'
>
471 *default-nw-hook*
473 <font color='#
0000ff'
>
474 = DEFAULT-FRAME-NW-HOOK
<br>
476 Default action to do on newly created windows
<br>
479 <a name='identify-key' href='#top'
>
480 <= Identify Key Group =
>
483 <font color='#ff0000'
>
484 *identify-font-string*
486 <font color='#
0000ff'
>
489 Identify window font string
<br>
491 <font color='#ff0000'
>
492 *identify-background*
494 <font color='#
0000ff'
>
497 Identify window background color
<br>
499 <font color='#ff0000'
>
500 *identify-foreground*
502 <font color='#
0000ff'
>
505 Identify window foreground color
<br>
507 <font color='#ff0000'
>
508 *identify-border*
510 <font color='#
0000ff'
>
513 Identify window border color
<br>
516 <a name='info-mode' href='#top'
>
517 <= Info Mode Group =
>
520 <font color='#ff0000'
>
521 *info-background*
523 <font color='#
0000ff'
>
526 Info window background color
<br>
528 <font color='#ff0000'
>
529 *info-foreground*
531 <font color='#
0000ff'
>
534 Info window foreground color
<br>
536 <font color='#ff0000'
>
537 *info-border*
539 <font color='#
0000ff'
>
542 Info window border color
<br>
544 <font color='#ff0000'
>
545 *info-line-cursor*
547 <font color='#
0000ff'
>
550 Info window line cursor color color
<br>
552 <font color='#ff0000'
>
553 *info-selected-background*
555 <font color='#
0000ff'
>
558 Info selected item background color
<br>
560 <font color='#ff0000'
>
561 *info-font-string*
563 <font color='#
0000ff'
>
566 Info window font string
<br>
568 <font color='#ff0000'
>
569 *info-click-to-select*
571 <font color='#
0000ff'
>
574 If true, click on info window select item. Otherwise, click to drag the menu
<br>
576 <font color='#ff0000'
>
577 *info-color-title*
579 <font color='#
0000ff'
>
582 Colored info title color
<br>
584 <font color='#ff0000'
>
585 *info-color-underline*
587 <font color='#
0000ff'
>
590 Colored info underline color
<br>
592 <font color='#ff0000'
>
593 *info-color-first*
595 <font color='#
0000ff'
>
598 Colored info first color
<br>
600 <font color='#ff0000'
>
601 *info-color-second*
603 <font color='#
0000ff'
>
606 Colored info second color
<br>
609 <a name='main-mode' href='#top'
>
610 <= Main Mode Group =
>
613 <font color='#ff0000'
>
614 *color-move-window*
616 <font color='#
0000ff'
>
619 Color when moving or resizing a windows
<br>
621 <font color='#ff0000'
>
622 *color-selected*
624 <font color='#
0000ff'
>
627 Color of selected window
<br>
629 <font color='#ff0000'
>
630 *color-unselected*
632 <font color='#
0000ff'
>
635 Color of unselected color
<br>
637 <font color='#ff0000'
>
638 *color-maybe-selected*
640 <font color='#
0000ff'
>
643 Color of maybe selected windows
<br>
646 <a name='menu' href='#top'
>
647 <= Menu Group =
>
650 <font color='#ff0000'
>
651 *menu-color-submenu*
653 <font color='#
0000ff'
>
656 Submenu color in menu
<br>
658 <font color='#ff0000'
>
659 *menu-color-comment*
661 <font color='#
0000ff'
>
664 Comment color in menu
<br>
666 <font color='#ff0000'
>
667 *menu-color-key*
669 <font color='#
0000ff'
>
672 Key color in menu
<br>
674 <font color='#ff0000'
>
675 *menu-color-menu-key*
677 <font color='#
0000ff'
>
678 = #
<XLIB:COLOR 0.99609375 0.6015625 0.99609375> <br>
680 Menu key color in menu
<br>
682 <font color='#ff0000'
>
683 *xdg-section-list*
685 <font color='#
0000ff'
>
686 = (TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO
<br>
688 VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK
<br>
690 OFFICE SETTINGS SYSTEM UTILITY TERMINALEMULATOR
<br>
692 ARCHLINUX SCREENSAVER)
<br>
694 Standard menu sections
<br>
697 <a name='miscellaneous' href='#top'
>
698 <= Miscellaneous Group =
>
701 <font color='#ff0000'
>
702 *have-to-compress-notify*
704 <font color='#
0000ff'
>
707 Compress event notify?
<br>
709 This variable may be useful to speed up some slow version of CLX.
<br>
711 It is particulary useful with CLISP/MIT-CLX.
<br>
713 <font color='#ff0000'
>
714 *show-root-frame-p*
716 <font color='#
0000ff'
>
719 Show the root frame information or not
<br>
721 <font color='#ff0000'
>
722 *border-size*
724 <font color='#
0000ff'
>
727 Windows and frames border size
<br>
729 <font color='#ff0000'
>
730 *loop-timeout*
732 <font color='#
0000ff'
>
735 Maximum time (in seconds) to wait before calling *loop-hook*
<br>
737 <font color='#ff0000'
>
738 *default-font-string*
740 <font color='#
0000ff'
>
743 The default font used in clfswm
<br>
745 <font color='#ff0000'
>
746 *default-frame-data*
748 <font color='#
0000ff'
>
749 = ((:TILE-SIZE
0.8) (:TILE-SPACE-SIZE
0.1)
<br>
751 (:FAST-LAYOUT (TILE-LEFT-LAYOUT TILE-LAYOUT))
<br>
753 (:MAIN-LAYOUT-WINDOWS NIL))
<br>
755 Default slots set in frame date
<br>
757 <font color='#ff0000'
>
758 *default-managed-type*
760 <font color='#
0000ff'
>
763 Default managed window types
<br>
765 <font color='#ff0000'
>
766 *default-focus-policy*
768 <font color='#
0000ff'
>
771 Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select.
<br>
773 <font color='#ff0000'
>
774 *default-modifiers*
776 <font color='#
0000ff'
>
779 Default modifiers list to append to explicit modifiers
<br>
781 Example: :mod-
2 for num_lock, :lock for Caps_lock...
<br>
783 <font color='#ff0000'
>
784 *never-managed-window-list*
786 <font color='#
0000ff'
>
787 = ((EQUAL-WM-CLASS-ROX-PINBOARD NIL)
<br>
789 (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW)
<br>
791 (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW))
<br>
793 CLFSWM will never manage windows of this type.
<br>
795 A list of (list match-function handle-function)
<br>
797 <font color='#ff0000'
>
798 *hide-unmanaged-window*
800 <font color='#
0000ff'
>
803 Hide or not unmanaged windows when a child is deselected.
<br>
805 <font color='#ff0000'
>
806 *snap-size*
808 <font color='#
0000ff'
>
811 Snap size (in pixels) when move or resize frame is constrained
<br>
813 <font color='#ff0000'
>
814 *spatial-move-delay-before*
816 <font color='#
0000ff'
>
819 Delay to display the current child before doing a spatial move
<br>
821 <font color='#ff0000'
>
822 *spatial-move-delay-after*
824 <font color='#
0000ff'
>
827 Delay to display the new child after doing a spatial move
<br>
829 <font color='#ff0000'
>
830 *create-frame-on-root*
832 <font color='#
0000ff'
>
835 Create frame on root.
<br>
837 Set this variable to true if you want to allow to create a new frame
<br>
839 on the root window in the main mode with the mouse
<br>
841 <font color='#ff0000'
>
842 *default-window-width*
844 <font color='#
0000ff'
>
847 Default window width
<br>
849 <font color='#ff0000'
>
850 *default-window-height*
852 <font color='#
0000ff'
>
855 Default window height
<br>
858 <a name='notify-window' href='#top'
>
859 <= Notify Window Group =
>
862 <font color='#ff0000'
>
863 *notify-window-font-string*
865 <font color='#
0000ff'
>
868 Notify window font string
<br>
870 <font color='#ff0000'
>
871 *notify-window-background*
873 <font color='#
0000ff'
>
876 Notify Window background color
<br>
878 <font color='#ff0000'
>
879 *notify-window-foreground*
881 <font color='#
0000ff'
>
884 Notify Window foreground color
<br>
886 <font color='#ff0000'
>
887 *notify-window-border*
889 <font color='#
0000ff'
>
892 Notify Window border color
<br>
894 <font color='#ff0000'
>
895 *notify-window-delay*
897 <font color='#
0000ff'
>
900 Notify Window display delay
<br>
903 <a name='placement' href='#top'
>
904 <= Placement Group =
>
907 <font color='#ff0000'
>
908 *banish-pointer-placement*
910 <font color='#
0000ff'
>
911 = BOTTOM-RIGHT-PLACEMENT
<br>
913 Pointer banishment placement
<br>
915 <font color='#ff0000'
>
916 *second-mode-placement*
918 <font color='#
0000ff'
>
919 = TOP-MIDDLE-PLACEMENT
<br>
921 Second mode window placement
<br>
923 <font color='#ff0000'
>
924 *info-mode-placement*
926 <font color='#
0000ff'
>
927 = TOP-LEFT-PLACEMENT
<br>
929 Info mode window placement
<br>
931 <font color='#ff0000'
>
932 *query-mode-placement*
934 <font color='#
0000ff'
>
935 = TOP-LEFT-PLACEMENT
<br>
937 Query mode window placement
<br>
939 <font color='#ff0000'
>
940 *circulate-mode-placement*
942 <font color='#
0000ff'
>
943 = BOTTOM-MIDDLE-PLACEMENT
<br>
945 Circulate mode window placement
<br>
947 <font color='#ff0000'
>
948 *expose-mode-placement*
950 <font color='#
0000ff'
>
951 = TOP-LEFT-CHILD-PLACEMENT
<br>
953 Expose mode window placement (Selection keys position)
<br>
955 <font color='#ff0000'
>
956 *notify-window-placement*
958 <font color='#
0000ff'
>
959 = BOTTOM-RIGHT-PLACEMENT
<br>
961 Notify window placement
<br>
963 <font color='#ff0000'
>
964 *ask-close/kill-placement*
966 <font color='#
0000ff'
>
967 = TOP-RIGHT-PLACEMENT
<br>
969 Ask close/kill window placement
<br>
972 <a name='query-string' href='#top'
>
973 <= Query String Group =
>
976 <font color='#ff0000'
>
977 *query-font-string*
979 <font color='#
0000ff'
>
982 Query string window font string
<br>
984 <font color='#ff0000'
>
985 *query-background*
987 <font color='#
0000ff'
>
990 Query string window background color
<br>
992 <font color='#ff0000'
>
993 *query-message-color*
995 <font color='#
0000ff'
>
998 Query string window message color
<br>
1000 <font color='#ff0000'
>
1001 *query-foreground*
1003 <font color='#
0000ff'
>
1006 Query string window foreground color
<br>
1008 <font color='#ff0000'
>
1009 *query-cursor-color*
1011 <font color='#
0000ff'
>
1014 Query string window foreground cursor color
<br>
1016 <font color='#ff0000'
>
1017 *query-parent-color*
1019 <font color='#
0000ff'
>
1022 Query string window parenthesis color
<br>
1024 <font color='#ff0000'
>
1025 *query-parent-error-color*
1027 <font color='#
0000ff'
>
1030 Query string window parenthesis color when no match
<br>
1032 <font color='#ff0000'
>
1033 *query-border*
1035 <font color='#
0000ff'
>
1038 Query string window border color
<br>
1041 <a name='second-mode' href='#top'
>
1042 <= Second Mode Group =
>
1045 <font color='#ff0000'
>
1046 *sm-border-color*
1048 <font color='#
0000ff'
>
1051 Second mode window border color
<br>
1053 <font color='#ff0000'
>
1054 *sm-background-color*
1056 <font color='#
0000ff'
>
1059 Second mode window background color
<br>
1061 <font color='#ff0000'
>
1062 *sm-foreground-color*
1064 <font color='#
0000ff'
>
1067 Second mode window foreground color
<br>
1069 <font color='#ff0000'
>
1070 *sm-font-string*
1072 <font color='#
0000ff'
>
1075 Second mode window font string
<br>
1077 <font color='#ff0000'
>
1078 *sm-width*
1080 <font color='#
0000ff'
>
1083 Second mode window width
<br>
1085 <font color='#ff0000'
>
1086 *sm-height*
1088 <font color='#
0000ff'
>
1091 Second mode window height
<br>
1095 This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-conf-var-doc-html-in-file or
1096 the produce-all-docs function from the Lisp REPL.
1101 Something like this:
<br>
1102 LISP
> (in-package :clfswm)
<br>
1103 CLFSWM
> (produce-conf-var-doc-html-in-file
"my-variables.html")
<br>
1104 or
<br> CLFSWM
> (produce-all-docs)