Documentation update
[clfswm.git] / doc / variables.html
blobb8b82de1d6fbd874bd75c92e20cb2be68a3031b1
1 <html>
2 <head>
3 <title>
4 CLFSWM - Configuration variables
5 </title>
6 </head>
7 <body>
8 <h1>
9 <a name='top'>
10 CLFSWM - Configuration variables
11 </a>
12 </h1>
13 <p>
14 Here are the variables you can configure in CLFSWM with the configuration file or the configuration menu:
15 </p>
16 <h3>
17 <a name='top'>
18 Configuration variables groups:
19 </a>
20 </h3>
21 <ul>
22 <li>
23 <a href='#circulate-mode'>
24 Circulate Mode Group
25 </a>
26 </li>
27 <li>
28 <a href='#corner'>
29 Corner Group
30 </a>
31 </li>
32 <li>
33 <a href='#expose-mode'>
34 Expose Mode Group
35 </a>
36 </li>
37 <li>
38 <a href='#frame-colors'>
39 Frame Colors Group
40 </a>
41 </li>
42 <li>
43 <a href='#gimp-layout'>
44 Gimp Layout Group
45 </a>
46 </li>
47 <li>
48 <a href='#hook'>
49 Hook Group
50 </a>
51 </li>
52 <li>
53 <a href='#identify-key'>
54 Identify Key Group
55 </a>
56 </li>
57 <li>
58 <a href='#info-mode'>
59 Info Mode Group
60 </a>
61 </li>
62 <li>
63 <a href='#main-mode'>
64 Main Mode Group
65 </a>
66 </li>
67 <li>
68 <a href='#menu'>
69 Menu Group
70 </a>
71 </li>
72 <li>
73 <a href='#miscellaneous'>
74 Miscellaneous Group
75 </a>
76 </li>
77 <li>
78 <a href='#notify-window'>
79 Notify Window Group
80 </a>
81 </li>
82 <li>
83 <a href='#placement'>
84 Placement Group
85 </a>
86 </li>
87 <li>
88 <a href='#query-string'>
89 Query String Group
90 </a>
91 </li>
92 <li>
93 <a href='#second-mode'>
94 Second Mode Group
95 </a>
96 </li>
97 </ul>
98 <p>
99 <a name='circulate-mode' href='#top'>
100 &lt;= Circulate Mode Group =&gt;
101 </a>
102 </p>
103 <font color='#ff0000'>
104 &nbsp;&nbsp; *circulate-font-string*
105 </font>
106 <font color='#0000ff'>
107 = "fixed" <br>
108 </font>
109 &nbsp; &nbsp; &nbsp; &nbsp; Circulate string window font string <br>
111 <font color='#ff0000'>
112 &nbsp;&nbsp; *circulate-background*
113 </font>
114 <font color='#0000ff'>
115 = "black" <br>
116 </font>
117 &nbsp; &nbsp; &nbsp; &nbsp; Circulate string window background color <br>
119 <font color='#ff0000'>
120 &nbsp;&nbsp; *circulate-foreground*
121 </font>
122 <font color='#0000ff'>
123 = "green" <br>
124 </font>
125 &nbsp; &nbsp; &nbsp; &nbsp; Circulate string window foreground color <br>
127 <font color='#ff0000'>
128 &nbsp;&nbsp; *circulate-border*
129 </font>
130 <font color='#0000ff'>
131 = "red" <br>
132 </font>
133 &nbsp; &nbsp; &nbsp; &nbsp; Circulate string window border color <br>
135 <font color='#ff0000'>
136 &nbsp;&nbsp; *circulate-width*
137 </font>
138 <font color='#0000ff'>
139 = 400 <br>
140 </font>
141 &nbsp; &nbsp; &nbsp; &nbsp; Circulate mode window width <br>
143 <font color='#ff0000'>
144 &nbsp;&nbsp; *circulate-height*
145 </font>
146 <font color='#0000ff'>
147 = 15 <br>
148 </font>
149 &nbsp; &nbsp; &nbsp; &nbsp; Circulate mode window height <br>
151 <font color='#ff0000'>
152 &nbsp;&nbsp; *circulate-transparency*
153 </font>
154 <font color='#0000ff'>
155 = 0.6 <br>
156 </font>
157 &nbsp; &nbsp; &nbsp; &nbsp; Circulate window background transparency <br>
159 <font color='#ff0000'>
160 &nbsp;&nbsp; *circulate-text-limite*
161 </font>
162 <font color='#0000ff'>
163 = 30 <br>
164 </font>
165 &nbsp; &nbsp; &nbsp; &nbsp; Maximum text limite in the circulate window <br>
168 <a name='corner' href='#top'>
169 &lt;= Corner Group =&gt;
170 </a>
171 </p>
172 <font color='#ff0000'>
173 &nbsp;&nbsp; *corner-size*
174 </font>
175 <font color='#0000ff'>
176 = 3 <br>
177 </font>
178 &nbsp; &nbsp; &nbsp; &nbsp; The size of the corner square <br>
180 <font color='#ff0000'>
181 &nbsp;&nbsp; *corner-main-mode-left-button*
182 </font>
183 <font color='#0000ff'>
184 = ((:TOP-LEFT OPEN-MENU) <br>
185 </font>
186 &nbsp; &nbsp; &nbsp; &nbsp; (:TOP-RIGHT PRESENT-VIRTUAL-KEYBOARD) <br>
188 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) <br>
190 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-LEFT NIL)) <br>
192 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the main mode with the left mouse button <br>
194 <font color='#ff0000'>
195 &nbsp;&nbsp; *corner-main-mode-middle-button*
196 </font>
197 <font color='#0000ff'>
198 = ((:TOP-LEFT HELP-ON-CLFSWM) <br>
199 </font>
200 &nbsp; &nbsp; &nbsp; &nbsp; (:TOP-RIGHT <br>
202 &nbsp; &nbsp; &nbsp; &nbsp; ASK-CLOSE/KILL-CURRENT-WINDOW) <br>
204 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL)) <br>
206 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the main mode with the middle mouse button <br>
208 <font color='#ff0000'>
209 &nbsp;&nbsp; *corner-main-mode-right-button*
210 </font>
211 <font color='#0000ff'>
212 = ((:TOP-LEFT PRESENT-CLFSWM-TERMINAL) <br>
213 </font>
214 &nbsp; &nbsp; &nbsp; &nbsp; (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW) <br>
216 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE) <br>
218 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-LEFT NIL)) <br>
220 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the main mode with the right mouse button <br>
222 <font color='#ff0000'>
223 &nbsp;&nbsp; *corner-second-mode-left-button*
224 </font>
225 <font color='#0000ff'>
226 = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) <br>
227 </font>
228 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) <br>
230 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-LEFT NIL)) <br>
232 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the second mode with the left mouse button <br>
234 <font color='#ff0000'>
235 &nbsp;&nbsp; *corner-second-mode-middle-button*
236 </font>
237 <font color='#0000ff'>
238 = ((:TOP-LEFT HELP-ON-CLFSWM) <br>
239 </font>
240 &nbsp; &nbsp; &nbsp; &nbsp; (:TOP-RIGHT NIL) (:BOTTOM-RIGHT NIL) <br>
242 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-LEFT NIL)) <br>
244 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the second mode with the middle mouse button <br>
246 <font color='#ff0000'>
247 &nbsp;&nbsp; *corner-second-mode-right-button*
248 </font>
249 <font color='#0000ff'>
250 = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) <br>
251 </font>
252 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE) <br>
254 &nbsp; &nbsp; &nbsp; &nbsp; (:BOTTOM-LEFT NIL)) <br>
256 &nbsp; &nbsp; &nbsp; &nbsp; Actions on corners in the second mode with the right mouse button <br>
258 <font color='#ff0000'>
259 &nbsp;&nbsp; *virtual-keyboard-cmd*
260 </font>
261 <font color='#0000ff'>
262 = "xvkbd" <br>
263 </font>
264 &nbsp; &nbsp; &nbsp; &nbsp; The command to display the virtual keybaord <br>
266 &nbsp; &nbsp; &nbsp; &nbsp; Here is an ~/.Xresources example for xvkbd: <br>
268 &nbsp; &nbsp; &nbsp; &nbsp; xvkbd.windowGeometry: 300x100-0-0 <br>
270 &nbsp; &nbsp; &nbsp; &nbsp; xvkbd*Font: 6x12 <br>
272 &nbsp; &nbsp; &nbsp; &nbsp; xvkbd.modalKeytop: true <br>
274 &nbsp; &nbsp; &nbsp; &nbsp; xvkbd.customization: -french <br>
276 &nbsp; &nbsp; &nbsp; &nbsp; xvkbd.keypad: false <br>
278 &nbsp; &nbsp; &nbsp; &nbsp; And make it always on top <br>
280 <font color='#ff0000'>
281 &nbsp;&nbsp; *clfswm-terminal-name*
282 </font>
283 <font color='#0000ff'>
284 = "clfswm-terminal" <br>
285 </font>
286 &nbsp; &nbsp; &nbsp; &nbsp; The clfswm terminal name <br>
288 <font color='#ff0000'>
289 &nbsp;&nbsp; *clfswm-terminal-cmd*
290 </font>
291 <font color='#0000ff'>
292 = "xterm -T clfswm-terminal" <br>
293 </font>
294 &nbsp; &nbsp; &nbsp; &nbsp; The clfswm terminal command. <br>
296 &nbsp; &nbsp; &nbsp; &nbsp; This command must set the window title to *clfswm-terminal-name* <br>
298 <font color='#ff0000'>
299 &nbsp;&nbsp; *corner-error-message-color*
300 </font>
301 <font color='#0000ff'>
302 = "red" <br>
303 </font>
304 &nbsp; &nbsp; &nbsp; &nbsp; Error message color <br>
306 <font color='#ff0000'>
307 &nbsp;&nbsp; *corner-error-message-delay*
308 </font>
309 <font color='#0000ff'>
310 = 5 <br>
311 </font>
312 &nbsp; &nbsp; &nbsp; &nbsp; Time to display the error message on commad error <br>
314 <font color='#ff0000'>
315 &nbsp;&nbsp; *corner-command-try-delay*
316 </font>
317 <font color='#0000ff'>
318 = 0.2 <br>
319 </font>
320 &nbsp; &nbsp; &nbsp; &nbsp; Time to wait before checking window in query tree <br>
322 <font color='#ff0000'>
323 &nbsp;&nbsp; *corner-command-try-number*
324 </font>
325 <font color='#0000ff'>
326 = 10 <br>
327 </font>
328 &nbsp; &nbsp; &nbsp; &nbsp; Number of try to wait the window in query tree <br>
331 <a name='expose-mode' href='#top'>
332 &lt;= Expose Mode Group =&gt;
333 </a>
334 </p>
335 <font color='#ff0000'>
336 &nbsp;&nbsp; *expose-font-string*
337 </font>
338 <font color='#0000ff'>
339 = "fixed" <br>
340 </font>
341 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window font string <br>
343 <font color='#ff0000'>
344 &nbsp;&nbsp; *expose-background*
345 </font>
346 <font color='#0000ff'>
347 = "grey10" <br>
348 </font>
349 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window background color <br>
351 <font color='#ff0000'>
352 &nbsp;&nbsp; *expose-foreground*
353 </font>
354 <font color='#0000ff'>
355 = "grey50" <br>
356 </font>
357 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window foreground color <br>
359 <font color='#ff0000'>
360 &nbsp;&nbsp; *expose-foreground-letter*
361 </font>
362 <font color='#0000ff'>
363 = "red" <br>
364 </font>
365 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window foreground color for letters <br>
367 <font color='#ff0000'>
368 &nbsp;&nbsp; *expose-foreground-letter-nok*
369 </font>
370 <font color='#0000ff'>
371 = "grey30" <br>
372 </font>
373 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window foreground color for letter not selected <br>
375 <font color='#ff0000'>
376 &nbsp;&nbsp; *expose-background-letter-match*
377 </font>
378 <font color='#0000ff'>
379 = "green" <br>
380 </font>
381 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window background color for matching letters <br>
383 <font color='#ff0000'>
384 &nbsp;&nbsp; *expose-border*
385 </font>
386 <font color='#0000ff'>
387 = "grey20" <br>
388 </font>
389 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window border color <br>
391 <font color='#ff0000'>
392 &nbsp;&nbsp; *expose-valid-on-key*
393 </font>
394 <font color='#0000ff'>
395 = T <br>
396 </font>
397 &nbsp; &nbsp; &nbsp; &nbsp; Valid expose mode when an accel key is pressed <br>
399 <font color='#ff0000'>
400 &nbsp;&nbsp; *expose-show-window-title*
401 </font>
402 <font color='#0000ff'>
403 = T <br>
404 </font>
405 &nbsp; &nbsp; &nbsp; &nbsp; Show the window title on accel window <br>
407 <font color='#ff0000'>
408 &nbsp;&nbsp; *expose-transparency*
409 </font>
410 <font color='#0000ff'>
411 = 0.6 <br>
412 </font>
413 &nbsp; &nbsp; &nbsp; &nbsp; Expose string window background transparency <br>
416 <a name='frame-colors' href='#top'>
417 &lt;= Frame Colors Group =&gt;
418 </a>
419 </p>
420 <font color='#ff0000'>
421 &nbsp;&nbsp; *frame-background*
422 </font>
423 <font color='#0000ff'>
424 = "Black" <br>
425 </font>
426 &nbsp; &nbsp; &nbsp; &nbsp; Frame background <br>
428 <font color='#ff0000'>
429 &nbsp;&nbsp; *frame-foreground*
430 </font>
431 <font color='#0000ff'>
432 = "Green" <br>
433 </font>
434 &nbsp; &nbsp; &nbsp; &nbsp; Frame foreground <br>
436 <font color='#ff0000'>
437 &nbsp;&nbsp; *frame-foreground-root*
438 </font>
439 <font color='#0000ff'>
440 = "Red" <br>
441 </font>
442 &nbsp; &nbsp; &nbsp; &nbsp; Frame foreground when the frame is the root frame <br>
444 <font color='#ff0000'>
445 &nbsp;&nbsp; *frame-foreground-hidden*
446 </font>
447 <font color='#0000ff'>
448 = "Darkgreen" <br>
449 </font>
450 &nbsp; &nbsp; &nbsp; &nbsp; Frame foreground for hidden windows <br>
452 <font color='#ff0000'>
453 &nbsp;&nbsp; *frame-transparency*
454 </font>
455 <font color='#0000ff'>
456 = 0.6 <br>
457 </font>
458 &nbsp; &nbsp; &nbsp; &nbsp; Frame background transparency <br>
461 <a name='gimp-layout' href='#top'>
462 &lt;= Gimp Layout Group =&gt;
463 </a>
464 </p>
465 <font color='#ff0000'>
466 &nbsp;&nbsp; *gimp-layout-notify-window-delay*
467 </font>
468 <font color='#0000ff'>
469 = 30 <br>
470 </font>
471 &nbsp; &nbsp; &nbsp; &nbsp; Time to display the GIMP layout notify window help <br>
474 <a name='hook' href='#top'>
475 &lt;= Hook Group =&gt;
476 </a>
477 </p>
478 <font color='#ff0000'>
479 &nbsp;&nbsp; *binding-hook*
480 </font>
481 <font color='#0000ff'>
482 = (INIT-*QUERY-KEYS* SET-DEFAULT-QUERY-KEYS <br>
483 </font>
484 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-CIRCULATE-KEYS <br>
486 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*INFO-KEYS* <br>
488 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*INFO-MOUSE* <br>
490 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-INFO-KEYS <br>
492 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-INFO-MOUSE <br>
494 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*MAIN-KEYS* <br>
496 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*MAIN-MOUSE* <br>
498 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-MAIN-KEYS <br>
500 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-MAIN-MOUSE <br>
502 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*SECOND-KEYS* <br>
504 &nbsp; &nbsp; &nbsp; &nbsp; INIT-*SECOND-MOUSE* <br>
506 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-SECOND-KEYS <br>
508 &nbsp; &nbsp; &nbsp; &nbsp; SET-DEFAULT-SECOND-MOUSE) <br>
510 &nbsp; &nbsp; &nbsp; &nbsp; Hook executed when keys/buttons are bounds <br>
512 <font color='#ff0000'>
513 &nbsp;&nbsp; *loop-hook*
514 </font>
515 <font color='#0000ff'>
516 = NIL <br>
517 </font>
518 &nbsp; &nbsp; &nbsp; &nbsp; Hook executed on each event loop <br>
520 <font color='#ff0000'>
521 &nbsp;&nbsp; *main-entrance-hook*
522 </font>
523 <font color='#0000ff'>
524 = NIL <br>
525 </font>
526 &nbsp; &nbsp; &nbsp; &nbsp; Hook executed on the main function entrance after <br>
528 &nbsp; &nbsp; &nbsp; &nbsp; loading configuration file and before opening the display. <br>
530 <font color='#ff0000'>
531 &nbsp;&nbsp; *init-hook*
532 </font>
533 <font color='#0000ff'>
534 = (DEFAULT-INIT-HOOK PLACE-FRAMES-FROM-XINERAMA-INFOS <br>
535 </font>
536 &nbsp; &nbsp; &nbsp; &nbsp; DISPLAY-HELLO-WINDOW) <br>
538 &nbsp; &nbsp; &nbsp; &nbsp; Init hook. This hook is run just after the first root frame is created <br>
540 <font color='#ff0000'>
541 &nbsp;&nbsp; *close-hook*
542 </font>
543 <font color='#0000ff'>
544 = (CLOSE-NOTIFY-WINDOW CLOSE-CLFSWM-TERMINAL <br>
545 </font>
546 &nbsp; &nbsp; &nbsp; &nbsp; CLOSE-VIRTUAL-KEYBOARD) <br>
548 &nbsp; &nbsp; &nbsp; &nbsp; Close hook. This hook is run just before closing the display <br>
550 <font color='#ff0000'>
551 &nbsp;&nbsp; *default-nw-hook*
552 </font>
553 <font color='#0000ff'>
554 = DEFAULT-FRAME-NW-HOOK <br>
555 </font>
556 &nbsp; &nbsp; &nbsp; &nbsp; Default action to do on newly created windows <br>
558 <font color='#ff0000'>
559 &nbsp;&nbsp; *query-key-press-hook*
560 </font>
561 <font color='#0000ff'>
562 = NIL <br>
563 </font>
564 &nbsp; &nbsp; &nbsp; &nbsp; Query hook. Hook called on each key press event in query loop <br>
566 <font color='#ff0000'>
567 &nbsp;&nbsp; *query-button-press-hook*
568 </font>
569 <font color='#0000ff'>
570 = NIL <br>
571 </font>
572 &nbsp; &nbsp; &nbsp; &nbsp; Query hook. Hook called on each button press event in query loop <br>
575 <a name='identify-key' href='#top'>
576 &lt;= Identify Key Group =&gt;
577 </a>
578 </p>
579 <font color='#ff0000'>
580 &nbsp;&nbsp; *identify-font-string*
581 </font>
582 <font color='#0000ff'>
583 = "fixed" <br>
584 </font>
585 &nbsp; &nbsp; &nbsp; &nbsp; Identify window font string <br>
587 <font color='#ff0000'>
588 &nbsp;&nbsp; *identify-background*
589 </font>
590 <font color='#0000ff'>
591 = "black" <br>
592 </font>
593 &nbsp; &nbsp; &nbsp; &nbsp; Identify window background color <br>
595 <font color='#ff0000'>
596 &nbsp;&nbsp; *identify-foreground*
597 </font>
598 <font color='#0000ff'>
599 = "green" <br>
600 </font>
601 &nbsp; &nbsp; &nbsp; &nbsp; Identify window foreground color <br>
603 <font color='#ff0000'>
604 &nbsp;&nbsp; *identify-border*
605 </font>
606 <font color='#0000ff'>
607 = "red" <br>
608 </font>
609 &nbsp; &nbsp; &nbsp; &nbsp; Identify window border color <br>
611 <font color='#ff0000'>
612 &nbsp;&nbsp; *identify-transparency*
613 </font>
614 <font color='#0000ff'>
615 = 0.6 <br>
616 </font>
617 &nbsp; &nbsp; &nbsp; &nbsp; Identify window background transparency <br>
620 <a name='info-mode' href='#top'>
621 &lt;= Info Mode Group =&gt;
622 </a>
623 </p>
624 <font color='#ff0000'>
625 &nbsp;&nbsp; *info-background*
626 </font>
627 <font color='#0000ff'>
628 = "black" <br>
629 </font>
630 &nbsp; &nbsp; &nbsp; &nbsp; Info window background color <br>
632 <font color='#ff0000'>
633 &nbsp;&nbsp; *info-foreground*
634 </font>
635 <font color='#0000ff'>
636 = "green" <br>
637 </font>
638 &nbsp; &nbsp; &nbsp; &nbsp; Info window foreground color <br>
640 <font color='#ff0000'>
641 &nbsp;&nbsp; *info-border*
642 </font>
643 <font color='#0000ff'>
644 = "red" <br>
645 </font>
646 &nbsp; &nbsp; &nbsp; &nbsp; Info window border color <br>
648 <font color='#ff0000'>
649 &nbsp;&nbsp; *info-line-cursor*
650 </font>
651 <font color='#0000ff'>
652 = "white" <br>
653 </font>
654 &nbsp; &nbsp; &nbsp; &nbsp; Info window line cursor color color <br>
656 <font color='#ff0000'>
657 &nbsp;&nbsp; *info-selected-background*
658 </font>
659 <font color='#0000ff'>
660 = "blue" <br>
661 </font>
662 &nbsp; &nbsp; &nbsp; &nbsp; Info selected item background color <br>
664 <font color='#ff0000'>
665 &nbsp;&nbsp; *info-font-string*
666 </font>
667 <font color='#0000ff'>
668 = "fixed" <br>
669 </font>
670 &nbsp; &nbsp; &nbsp; &nbsp; Info window font string <br>
672 <font color='#ff0000'>
673 &nbsp;&nbsp; *info-transparency*
674 </font>
675 <font color='#0000ff'>
676 = 0.6 <br>
677 </font>
678 &nbsp; &nbsp; &nbsp; &nbsp; Info window background transparency <br>
680 <font color='#ff0000'>
681 &nbsp;&nbsp; *info-click-to-select*
682 </font>
683 <font color='#0000ff'>
684 = T <br>
685 </font>
686 &nbsp; &nbsp; &nbsp; &nbsp; If true, click on info window select item. Otherwise, click to drag the menu <br>
688 <font color='#ff0000'>
689 &nbsp;&nbsp; *info-color-title*
690 </font>
691 <font color='#0000ff'>
692 = "Magenta" <br>
693 </font>
694 &nbsp; &nbsp; &nbsp; &nbsp; Colored info title color <br>
696 <font color='#ff0000'>
697 &nbsp;&nbsp; *info-color-underline*
698 </font>
699 <font color='#0000ff'>
700 = "Yellow" <br>
701 </font>
702 &nbsp; &nbsp; &nbsp; &nbsp; Colored info underline color <br>
704 <font color='#ff0000'>
705 &nbsp;&nbsp; *info-color-first*
706 </font>
707 <font color='#0000ff'>
708 = "Cyan" <br>
709 </font>
710 &nbsp; &nbsp; &nbsp; &nbsp; Colored info first color <br>
712 <font color='#ff0000'>
713 &nbsp;&nbsp; *info-color-second*
714 </font>
715 <font color='#0000ff'>
716 = "lightblue" <br>
717 </font>
718 &nbsp; &nbsp; &nbsp; &nbsp; Colored info second color <br>
721 <a name='main-mode' href='#top'>
722 &lt;= Main Mode Group =&gt;
723 </a>
724 </p>
725 <font color='#ff0000'>
726 &nbsp;&nbsp; *color-move-window*
727 </font>
728 <font color='#0000ff'>
729 = "DeepPink" <br>
730 </font>
731 &nbsp; &nbsp; &nbsp; &nbsp; Color when moving or resizing a windows <br>
733 <font color='#ff0000'>
734 &nbsp;&nbsp; *color-selected*
735 </font>
736 <font color='#0000ff'>
737 = "Red" <br>
738 </font>
739 &nbsp; &nbsp; &nbsp; &nbsp; Color of selected window <br>
741 <font color='#ff0000'>
742 &nbsp;&nbsp; *color-unselected*
743 </font>
744 <font color='#0000ff'>
745 = "Blue" <br>
746 </font>
747 &nbsp; &nbsp; &nbsp; &nbsp; Color of unselected color <br>
749 <font color='#ff0000'>
750 &nbsp;&nbsp; *color-maybe-selected*
751 </font>
752 <font color='#0000ff'>
753 = "Yellow" <br>
754 </font>
755 &nbsp; &nbsp; &nbsp; &nbsp; Color of maybe selected windows <br>
758 <a name='menu' href='#top'>
759 &lt;= Menu Group =&gt;
760 </a>
761 </p>
762 <font color='#ff0000'>
763 &nbsp;&nbsp; *xdg-section-list*
764 </font>
765 <font color='#0000ff'>
766 = (TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO <br>
767 </font>
768 &nbsp; &nbsp; &nbsp; &nbsp; VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK <br>
770 &nbsp; &nbsp; &nbsp; &nbsp; OFFICE SETTINGS SYSTEM UTILITY TERMINALEMULATOR <br>
772 &nbsp; &nbsp; &nbsp; &nbsp; SCREENSAVER) <br>
774 &nbsp; &nbsp; &nbsp; &nbsp; Standard menu sections <br>
776 <font color='#ff0000'>
777 &nbsp;&nbsp; *menu-color-submenu*
778 </font>
779 <font color='#0000ff'>
780 = "Cyan" <br>
781 </font>
782 &nbsp; &nbsp; &nbsp; &nbsp; Submenu color in menu <br>
784 <font color='#ff0000'>
785 &nbsp;&nbsp; *menu-color-comment*
786 </font>
787 <font color='#0000ff'>
788 = "Yellow" <br>
789 </font>
790 &nbsp; &nbsp; &nbsp; &nbsp; Comment color in menu <br>
792 <font color='#ff0000'>
793 &nbsp;&nbsp; *menu-color-key*
794 </font>
795 <font color='#0000ff'>
796 = "Magenta" <br>
797 </font>
798 &nbsp; &nbsp; &nbsp; &nbsp; Key color in menu <br>
800 <font color='#ff0000'>
801 &nbsp;&nbsp; *menu-color-menu-key*
802 </font>
803 <font color='#0000ff'>
804 = #<XLIB:COLOR 0.99609375 0.6015625 0.99609375> <br>
805 </font>
806 &nbsp; &nbsp; &nbsp; &nbsp; Menu key color in menu <br>
809 <a name='miscellaneous' href='#top'>
810 &lt;= Miscellaneous Group =&gt;
811 </a>
812 </p>
813 <font color='#ff0000'>
814 &nbsp;&nbsp; *have-to-compress-notify*
815 </font>
816 <font color='#0000ff'>
817 = T <br>
818 </font>
819 &nbsp; &nbsp; &nbsp; &nbsp; Compress event notify? <br>
821 &nbsp; &nbsp; &nbsp; &nbsp; This variable may be useful to speed up some slow version of CLX. <br>
823 &nbsp; &nbsp; &nbsp; &nbsp; It is particulary useful with CLISP/MIT-CLX. <br>
825 <font color='#ff0000'>
826 &nbsp;&nbsp; *transparent-background*
827 </font>
828 <font color='#0000ff'>
829 = T <br>
830 </font>
831 &nbsp; &nbsp; &nbsp; &nbsp; Enable transparent background: one of nil, :pseudo, t (xcompmgr must be started) <br>
833 <font color='#ff0000'>
834 &nbsp;&nbsp; *default-transparency*
835 </font>
836 <font color='#0000ff'>
837 = 0.6 <br>
838 </font>
839 &nbsp; &nbsp; &nbsp; &nbsp; Default transparency for all windows when in xcompmgr transparency mode <br>
841 <font color='#ff0000'>
842 &nbsp;&nbsp; *show-root-frame-p*
843 </font>
844 <font color='#0000ff'>
845 = NIL <br>
846 </font>
847 &nbsp; &nbsp; &nbsp; &nbsp; Show the root frame information or not <br>
849 <font color='#ff0000'>
850 &nbsp;&nbsp; *border-size*
851 </font>
852 <font color='#0000ff'>
853 = 1 <br>
854 </font>
855 &nbsp; &nbsp; &nbsp; &nbsp; Windows and frames border size <br>
857 <font color='#ff0000'>
858 &nbsp;&nbsp; *loop-timeout*
859 </font>
860 <font color='#0000ff'>
861 = 1 <br>
862 </font>
863 &nbsp; &nbsp; &nbsp; &nbsp; Maximum time (in seconds) to wait before calling *loop-hook* <br>
865 <font color='#ff0000'>
866 &nbsp;&nbsp; *default-font-string*
867 </font>
868 <font color='#0000ff'>
869 = "fixed" <br>
870 </font>
871 &nbsp; &nbsp; &nbsp; &nbsp; The default font used in clfswm <br>
873 <font color='#ff0000'>
874 &nbsp;&nbsp; *default-frame-data*
875 </font>
876 <font color='#0000ff'>
877 = ((:TILE-SIZE 0.8) (:TILE-SPACE-SIZE 0.1) <br>
878 </font>
879 &nbsp; &nbsp; &nbsp; &nbsp; (:FAST-LAYOUT (TILE-LEFT-LAYOUT TILE-LAYOUT)) <br>
881 &nbsp; &nbsp; &nbsp; &nbsp; (:MAIN-LAYOUT-WINDOWS NIL)) <br>
883 &nbsp; &nbsp; &nbsp; &nbsp; Default slots set in frame date <br>
885 <font color='#ff0000'>
886 &nbsp;&nbsp; *default-managed-type*
887 </font>
888 <font color='#0000ff'>
889 = (:NORMAL) <br>
890 </font>
891 &nbsp; &nbsp; &nbsp; &nbsp; Default managed window types <br>
893 <font color='#ff0000'>
894 &nbsp;&nbsp; *default-focus-policy*
895 </font>
896 <font color='#0000ff'>
897 = :CLICK <br>
898 </font>
899 &nbsp; &nbsp; &nbsp; &nbsp; Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select. <br>
901 <font color='#ff0000'>
902 &nbsp;&nbsp; *default-modifiers*
903 </font>
904 <font color='#0000ff'>
905 = NIL <br>
906 </font>
907 &nbsp; &nbsp; &nbsp; &nbsp; Default modifiers list to append to explicit modifiers <br>
909 &nbsp; &nbsp; &nbsp; &nbsp; Example: :mod-2 for num_lock, :lock for Caps_lock... <br>
911 <font color='#ff0000'>
912 &nbsp;&nbsp; *never-managed-window-list*
913 </font>
914 <font color='#0000ff'>
915 = ((EQUAL-WM-CLASS-ROX-PINBOARD NIL) <br>
916 </font>
917 &nbsp; &nbsp; &nbsp; &nbsp; (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW) <br>
919 &nbsp; &nbsp; &nbsp; &nbsp; (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW)) <br>
921 &nbsp; &nbsp; &nbsp; &nbsp; CLFSWM will never manage windows of this type. <br>
923 &nbsp; &nbsp; &nbsp; &nbsp; A list of (list match-function handle-function) <br>
925 <font color='#ff0000'>
926 &nbsp;&nbsp; *hide-unmanaged-window*
927 </font>
928 <font color='#0000ff'>
929 = T <br>
930 </font>
931 &nbsp; &nbsp; &nbsp; &nbsp; Hide or not unmanaged windows when a child is deselected. <br>
933 <font color='#ff0000'>
934 &nbsp;&nbsp; *snap-size*
935 </font>
936 <font color='#0000ff'>
937 = 5 <br>
938 </font>
939 &nbsp; &nbsp; &nbsp; &nbsp; Snap size (in % of parent size) when move or resize frame is constrained <br>
941 <font color='#ff0000'>
942 &nbsp;&nbsp; *spatial-move-delay-before*
943 </font>
944 <font color='#0000ff'>
945 = 0.2 <br>
946 </font>
947 &nbsp; &nbsp; &nbsp; &nbsp; Delay to display the current child before doing a spatial move <br>
949 <font color='#ff0000'>
950 &nbsp;&nbsp; *spatial-move-delay-after*
951 </font>
952 <font color='#0000ff'>
953 = 0.5 <br>
954 </font>
955 &nbsp; &nbsp; &nbsp; &nbsp; Delay to display the new child after doing a spatial move <br>
957 <font color='#ff0000'>
958 &nbsp;&nbsp; *create-frame-on-root*
959 </font>
960 <font color='#0000ff'>
961 = NIL <br>
962 </font>
963 &nbsp; &nbsp; &nbsp; &nbsp; Create frame on root. <br>
965 &nbsp; &nbsp; &nbsp; &nbsp; Set this variable to true if you want to allow to create a new frame <br>
967 &nbsp; &nbsp; &nbsp; &nbsp; on the root window in the main mode with the mouse <br>
969 <font color='#ff0000'>
970 &nbsp;&nbsp; *default-window-width*
971 </font>
972 <font color='#0000ff'>
973 = 400 <br>
974 </font>
975 &nbsp; &nbsp; &nbsp; &nbsp; Default window width <br>
977 <font color='#ff0000'>
978 &nbsp;&nbsp; *default-window-height*
979 </font>
980 <font color='#0000ff'>
981 = 300 <br>
982 </font>
983 &nbsp; &nbsp; &nbsp; &nbsp; Default window height <br>
986 <a name='notify-window' href='#top'>
987 &lt;= Notify Window Group =&gt;
988 </a>
989 </p>
990 <font color='#ff0000'>
991 &nbsp;&nbsp; *notify-window-font-string*
992 </font>
993 <font color='#0000ff'>
994 = "fixed" <br>
995 </font>
996 &nbsp; &nbsp; &nbsp; &nbsp; Notify window font string <br>
998 <font color='#ff0000'>
999 &nbsp;&nbsp; *notify-window-background*
1000 </font>
1001 <font color='#0000ff'>
1002 = "black" <br>
1003 </font>
1004 &nbsp; &nbsp; &nbsp; &nbsp; Notify Window background color <br>
1006 <font color='#ff0000'>
1007 &nbsp;&nbsp; *notify-window-foreground*
1008 </font>
1009 <font color='#0000ff'>
1010 = "green" <br>
1011 </font>
1012 &nbsp; &nbsp; &nbsp; &nbsp; Notify Window foreground color <br>
1014 <font color='#ff0000'>
1015 &nbsp;&nbsp; *notify-window-border*
1016 </font>
1017 <font color='#0000ff'>
1018 = "red" <br>
1019 </font>
1020 &nbsp; &nbsp; &nbsp; &nbsp; Notify Window border color <br>
1022 <font color='#ff0000'>
1023 &nbsp;&nbsp; *notify-window-delay*
1024 </font>
1025 <font color='#0000ff'>
1026 = 10 <br>
1027 </font>
1028 &nbsp; &nbsp; &nbsp; &nbsp; Notify Window display delay <br>
1030 <font color='#ff0000'>
1031 &nbsp;&nbsp; *notify-window-transparency*
1032 </font>
1033 <font color='#0000ff'>
1034 = 0.6 <br>
1035 </font>
1036 &nbsp; &nbsp; &nbsp; &nbsp; Notify window background transparency <br>
1039 <a name='placement' href='#top'>
1040 &lt;= Placement Group =&gt;
1041 </a>
1042 </p>
1043 <font color='#ff0000'>
1044 &nbsp;&nbsp; *banish-pointer-placement*
1045 </font>
1046 <font color='#0000ff'>
1047 = BOTTOM-RIGHT-ROOT-PLACEMENT <br>
1048 </font>
1049 &nbsp; &nbsp; &nbsp; &nbsp; Pointer banishment placement <br>
1051 <font color='#ff0000'>
1052 &nbsp;&nbsp; *second-mode-placement*
1053 </font>
1054 <font color='#0000ff'>
1055 = TOP-MIDDLE-ROOT-PLACEMENT <br>
1056 </font>
1057 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window placement <br>
1059 <font color='#ff0000'>
1060 &nbsp;&nbsp; *info-mode-placement*
1061 </font>
1062 <font color='#0000ff'>
1063 = TOP-LEFT-ROOT-PLACEMENT <br>
1064 </font>
1065 &nbsp; &nbsp; &nbsp; &nbsp; Info mode window placement <br>
1067 <font color='#ff0000'>
1068 &nbsp;&nbsp; *query-mode-placement*
1069 </font>
1070 <font color='#0000ff'>
1071 = TOP-LEFT-ROOT-PLACEMENT <br>
1072 </font>
1073 &nbsp; &nbsp; &nbsp; &nbsp; Query mode window placement <br>
1075 <font color='#ff0000'>
1076 &nbsp;&nbsp; *circulate-mode-placement*
1077 </font>
1078 <font color='#0000ff'>
1079 = BOTTOM-MIDDLE-ROOT-PLACEMENT <br>
1080 </font>
1081 &nbsp; &nbsp; &nbsp; &nbsp; Circulate mode window placement <br>
1083 <font color='#ff0000'>
1084 &nbsp;&nbsp; *expose-mode-placement*
1085 </font>
1086 <font color='#0000ff'>
1087 = TOP-LEFT-CHILD-PLACEMENT <br>
1088 </font>
1089 &nbsp; &nbsp; &nbsp; &nbsp; Expose mode window placement (Selection keys position) <br>
1091 <font color='#ff0000'>
1092 &nbsp;&nbsp; *expose-query-placement*
1093 </font>
1094 <font color='#0000ff'>
1095 = BOTTOM-LEFT-ROOT-PLACEMENT <br>
1096 </font>
1097 &nbsp; &nbsp; &nbsp; &nbsp; Expose mode query window placement <br>
1099 <font color='#ff0000'>
1100 &nbsp;&nbsp; *notify-window-placement*
1101 </font>
1102 <font color='#0000ff'>
1103 = BOTTOM-RIGHT-ROOT-PLACEMENT <br>
1104 </font>
1105 &nbsp; &nbsp; &nbsp; &nbsp; Notify window placement <br>
1107 <font color='#ff0000'>
1108 &nbsp;&nbsp; *ask-close/kill-placement*
1109 </font>
1110 <font color='#0000ff'>
1111 = TOP-RIGHT-ROOT-PLACEMENT <br>
1112 </font>
1113 &nbsp; &nbsp; &nbsp; &nbsp; Ask close/kill window placement <br>
1115 <font color='#ff0000'>
1116 &nbsp;&nbsp; *unmanaged-window-placement*
1117 </font>
1118 <font color='#0000ff'>
1119 = MIDDLE-MIDDLE-ROOT-PLACEMENT <br>
1120 </font>
1121 &nbsp; &nbsp; &nbsp; &nbsp; Unmanager window placement <br>
1124 <a name='query-string' href='#top'>
1125 &lt;= Query String Group =&gt;
1126 </a>
1127 </p>
1128 <font color='#ff0000'>
1129 &nbsp;&nbsp; *query-font-string*
1130 </font>
1131 <font color='#0000ff'>
1132 = "fixed" <br>
1133 </font>
1134 &nbsp; &nbsp; &nbsp; &nbsp; Query string window font string <br>
1136 <font color='#ff0000'>
1137 &nbsp;&nbsp; *query-background*
1138 </font>
1139 <font color='#0000ff'>
1140 = "black" <br>
1141 </font>
1142 &nbsp; &nbsp; &nbsp; &nbsp; Query string window background color <br>
1144 <font color='#ff0000'>
1145 &nbsp;&nbsp; *query-message-color*
1146 </font>
1147 <font color='#0000ff'>
1148 = "yellow" <br>
1149 </font>
1150 &nbsp; &nbsp; &nbsp; &nbsp; Query string window message color <br>
1152 <font color='#ff0000'>
1153 &nbsp;&nbsp; *query-foreground*
1154 </font>
1155 <font color='#0000ff'>
1156 = "green" <br>
1157 </font>
1158 &nbsp; &nbsp; &nbsp; &nbsp; Query string window foreground color <br>
1160 <font color='#ff0000'>
1161 &nbsp;&nbsp; *query-cursor-color*
1162 </font>
1163 <font color='#0000ff'>
1164 = "white" <br>
1165 </font>
1166 &nbsp; &nbsp; &nbsp; &nbsp; Query string window foreground cursor color <br>
1168 <font color='#ff0000'>
1169 &nbsp;&nbsp; *query-parent-color*
1170 </font>
1171 <font color='#0000ff'>
1172 = "blue" <br>
1173 </font>
1174 &nbsp; &nbsp; &nbsp; &nbsp; Query string window parenthesis color <br>
1176 <font color='#ff0000'>
1177 &nbsp;&nbsp; *query-parent-error-color*
1178 </font>
1179 <font color='#0000ff'>
1180 = "red" <br>
1181 </font>
1182 &nbsp; &nbsp; &nbsp; &nbsp; Query string window parenthesis color when no match <br>
1184 <font color='#ff0000'>
1185 &nbsp;&nbsp; *query-border*
1186 </font>
1187 <font color='#0000ff'>
1188 = "red" <br>
1189 </font>
1190 &nbsp; &nbsp; &nbsp; &nbsp; Query string window border color <br>
1192 <font color='#ff0000'>
1193 &nbsp;&nbsp; *query-transparency*
1194 </font>
1195 <font color='#0000ff'>
1196 = 0.6 <br>
1197 </font>
1198 &nbsp; &nbsp; &nbsp; &nbsp; Query string window background transparency <br>
1200 <font color='#ff0000'>
1201 &nbsp;&nbsp; *query-max-complet-length*
1202 </font>
1203 <font color='#0000ff'>
1204 = 100 <br>
1205 </font>
1206 &nbsp; &nbsp; &nbsp; &nbsp; Query maximum length of completion list <br>
1208 <font color='#ff0000'>
1209 &nbsp;&nbsp; *query-min-complet-char*
1210 </font>
1211 <font color='#0000ff'>
1212 = 2 <br>
1213 </font>
1214 &nbsp; &nbsp; &nbsp; &nbsp; Query minimum input length for completion <br>
1217 <a name='second-mode' href='#top'>
1218 &lt;= Second Mode Group =&gt;
1219 </a>
1220 </p>
1221 <font color='#ff0000'>
1222 &nbsp;&nbsp; *sm-border-color*
1223 </font>
1224 <font color='#0000ff'>
1225 = "Green" <br>
1226 </font>
1227 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window border color <br>
1229 <font color='#ff0000'>
1230 &nbsp;&nbsp; *sm-background-color*
1231 </font>
1232 <font color='#0000ff'>
1233 = "Black" <br>
1234 </font>
1235 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window background color <br>
1237 <font color='#ff0000'>
1238 &nbsp;&nbsp; *sm-foreground-color*
1239 </font>
1240 <font color='#0000ff'>
1241 = "Red" <br>
1242 </font>
1243 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window foreground color <br>
1245 <font color='#ff0000'>
1246 &nbsp;&nbsp; *sm-font-string*
1247 </font>
1248 <font color='#0000ff'>
1249 = "fixed" <br>
1250 </font>
1251 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window font string <br>
1253 <font color='#ff0000'>
1254 &nbsp;&nbsp; *sm-width*
1255 </font>
1256 <font color='#0000ff'>
1257 = 300 <br>
1258 </font>
1259 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window width <br>
1261 <font color='#ff0000'>
1262 &nbsp;&nbsp; *sm-height*
1263 </font>
1264 <font color='#0000ff'>
1265 = 25 <br>
1266 </font>
1267 &nbsp; &nbsp; &nbsp; &nbsp; Second mode window height <br>
1269 <font color='#ff0000'>
1270 &nbsp;&nbsp; *sm-transparency*
1271 </font>
1272 <font color='#0000ff'>
1273 = 0.6 <br>
1274 </font>
1275 &nbsp; &nbsp; &nbsp; &nbsp; Second mode background transparency <br>
1278 <small>
1279 This documentation was produced with the CLFSWM auto-doc functions. To reproduce it, use the produce-conf-var-doc-html-in-file or
1280 the produce-all-docs function from the Lisp REPL.
1281 </small>
1282 </p>
1284 <small>
1285 Something like this:<br>
1286 LISP> (in-package :clfswm)<br>
1287 CLFSWM> (produce-conf-var-doc-html-in-file "my-variables.html")<br>
1288 or<br> CLFSWM> (produce-all-docs)
1289 </small>
1290 </p>
1291 </body>
1292 </html>