doc/variables.txt

   1     * CLFSWM Configuration variables *
   2       ------------------------------
   3
   4 <= Circulate Mode Group =>
   5
   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
  22
  23
  24 <= Corner Group =>
  25
  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 NIL))
  59     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
  66
  67
  68 <= Expose Mode Group =>
  69
  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
  92
  93
  94 <= Frame Colors Group =>
  95
  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
 106
 107
 108 <= Gimp Layout Group =>
 109
 110   *GIMP-LAYOUT-NOTIFY-WINDOW-DELAY* = 30
 111     Time to display the GIMP layout notify window help
 112
 113
 114 <= Hook Group =>
 115
 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)
 123     Close hook. This hook is run just before closing the display
 124   *INIT-HOOK* = (DEFAULT-INIT-HOOK DISPLAY-HELLO-WINDOW)
 125     Init hook. This hook is run just after the first root frame is created
 126   *ROOT-SIZE-CHANGE-HOOK* = NIL
 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     Hook executed when keys/buttons are bounds
 139
 140
 141 <= Identify Key Group =>
 142
 143   *IDENTIFY-TRANSPARENCY* = 0.8
 144     Identify window background transparency
 145   *IDENTIFY-BORDER* = "red"
 146     Identify window border color
 147   *IDENTIFY-FOREGROUND* = "green"
 148     Identify window foreground color
 149   *IDENTIFY-BACKGROUND* = "black"
 150     Identify window background color
 151   *IDENTIFY-FONT-STRING* = "fixed"
 152     Identify window font string
 153
 154
 155 <= Info Mode Group =>
 156
 157   *INFO-COLOR-SECOND* = "lightblue"
 158     Colored info second color
 159   *INFO-COLOR-FIRST* = "Cyan"
 160     Colored info first color
 161   *INFO-COLOR-UNDERLINE* = "Yellow"
 162     Colored info underline color
 163   *INFO-COLOR-TITLE* = "Magenta"
 164     Colored info title color
 165   *INFO-CLICK-TO-SELECT* = T
 166     If true, click on info window select item. Otherwise, click to drag the menu
 167   *INFO-TRANSPARENCY* = 0.8
 168     Info window background transparency
 169   *INFO-FONT-STRING* = "fixed"
 170     Info window font string
 171   *INFO-SELECTED-BACKGROUND* = "blue"
 172     Info selected item background color
 173   *INFO-LINE-CURSOR* = "white"
 174     Info window line cursor color color
 175   *INFO-BORDER* = "red"
 176     Info window border color
 177   *INFO-FOREGROUND* = "green"
 178     Info window foreground color
 179   *INFO-BACKGROUND* = "black"
 180     Info window background color
 181
 182
 183 <= Main Mode Group =>
 184
 185   *COLOR-MAYBE-SELECTED* = "Yellow"
 186     Color of maybe selected windows
 187   *COLOR-UNSELECTED* = "Blue"
 188     Color of unselected color
 189   *COLOR-SELECTED* = "Red"
 190     Color of selected window
 191   *COLOR-MOVE-WINDOW* = "DeepPink"
 192     Color when moving or resizing a windows
 193
 194
 195 <= Menu Group =>
 196
 197   *MENU-KEY-BOUND-COLOR* = "gray50"
 198     Key bound min menu color
 199   *MENU-COLOR-MENU-KEY* = #<XLIB:COLOR 0.99609375 0.6015625 0.99609375>
 200     Menu key color in menu
 201   *MENU-COLOR-KEY* = "Magenta"
 202     Key color in menu
 203   *MENU-COLOR-COMMENT* = "Yellow"
 204     Comment color in menu
 205   *MENU-COLOR-SUBMENU* = "Cyan"
 206     Submenu color in menu
 207   *XDG-SECTION-LIST* =
 208 (TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK OFFICE SETTINGS
 209  SYSTEM UTILITY TERMINALEMULATOR SCREENSAVER)
 210     Standard menu sections
 211
 212
 213 <= Miscellaneous Group =>
 214
 215   *DEFAULT-WINDOW-HEIGHT* = 300
 216     Default window height
 217   *DEFAULT-WINDOW-WIDTH* = 400
 218     Default window width
 219   *SPATIAL-MOVE-DELAY-AFTER* = 0.5
 220     Delay to display the new child after doing a spatial move
 221   *SPATIAL-MOVE-DELAY-BEFORE* = 0.2
 222     Delay to display the current child before doing a spatial move
 223   *SNAP-SIZE* = 5
 224     Snap size (in % of parent size) when move or resize frame is constrained
 225   *HIDE-UNMANAGED-WINDOW* = T
 226     Hide or not unmanaged windows when a child is deselected.
 227   *NEVER-MANAGED-WINDOW-LIST* =
 228 ((IS-NOTIFY-WINDOW-P RAISE-WINDOW) (EQUAL-WM-CLASS-ROX-PINBOARD NIL) (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW)
 229  (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW))
 230
 231 CLFSWM will never manage windows of this type.
 232 A list of (list match-function handle-function)
 233   *DEFAULT-MODIFIERS* = NIL
 234
 235 Default modifiers list to append to explicit modifiers
 236 Example: :mod-2 for num_lock, :lock for Caps_lock...
 237   *SHOW-HIDE-POLICY* = #<SYSTEM-FUNCTION <=>
 238
 239 'NIL': always display all children (better with transparency support).
 240 '<': Hide only children less than children above.
 241 '<=': Hide children less or equal to children above (better for performance on slow machine).
 242   *DEFAULT-FOCUS-POLICY* = :CLICK
 243     Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select.
 244   *DEFAULT-MANAGED-TYPE* = (:NORMAL)
 245     Default managed window types
 246   *DEFAULT-FRAME-DATA* = ((:TILE-SIZE 0.8) (:TILE-SPACE-SIZE 0.1) (:FAST-LAYOUT (TILE-LEFT-LAYOUT TILE-LAYOUT)) (:MAIN-LAYOUT-WINDOWS NIL))
 247     Default slots set in frame date
 248   *DEFAULT-FONT-STRING* = "fixed"
 249     The default font used in clfswm
 250   *LOOP-TIMEOUT* = 1
 251     Maximum time (in seconds) to wait before calling *loop-hook*
 252   *BORDER-SIZE* = 1
 253     Windows and frames border size
 254   *SHOW-ROOT-FRAME-P* = NIL
 255     Show the root frame information or not
 256   *DEFAULT-TRANSPARENCY* = 0.8
 257     Default transparency for all windows when in xcompmgr transparency mode
 258   *TRANSPARENT-BACKGROUND* = T
 259     Enable transparent background: one of nil, :pseudo, t (xcompmgr must be started)
 260   *HAVE-TO-COMPRESS-NOTIFY* = T
 261
 262 Compress event notify?
 263 This variable may be useful to speed up some slow version of CLX.
 264 It is particulary useful with CLISP/MIT-CLX.
 265
 266
 267 <= Notify Window Group =>
 268
 269   *NOTIFY-WINDOW-TRANSPARENCY* = 0.8
 270     Notify window background transparency
 271   *NOTIFY-WINDOW-DELAY* = 10
 272     Notify Window display delay
 273   *NOTIFY-WINDOW-BORDER* = "red"
 274     Notify Window border color
 275   *NOTIFY-WINDOW-FOREGROUND* = "green"
 276     Notify Window foreground color
 277   *NOTIFY-WINDOW-BACKGROUND* = "black"
 278     Notify Window background color
 279   *NOTIFY-WINDOW-FONT-STRING* = "fixed"
 280     Notify window font string
 281
 282
 283 <= Placement Group =>
 284
 285   *UNMANAGED-WINDOW-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
 286     Unmanager window placement
 287   *ASK-CLOSE/KILL-PLACEMENT* = TOP-RIGHT-ROOT-PLACEMENT
 288     Ask close/kill window placement
 289   *NOTIFY-WINDOW-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
 290     Notify window placement
 291   *EXPOSE-QUERY-PLACEMENT* = BOTTOM-LEFT-ROOT-PLACEMENT
 292     Expose mode query window placement
 293   *EXPOSE-MODE-PLACEMENT* = TOP-LEFT-CHILD-PLACEMENT
 294     Expose mode window placement (Selection keys position)
 295   *CIRCULATE-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
 296     Circulate mode window placement
 297   *QUERY-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
 298     Query mode window placement
 299   *INFO-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
 300     Info mode window placement
 301   *SECOND-MODE-PLACEMENT* = TOP-MIDDLE-ROOT-PLACEMENT
 302     Second mode window placement
 303   *BANISH-POINTER-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
 304     Pointer banishment placement
 305
 306
 307 <= Query String Group =>
 308
 309   *QUERY-MIN-COMPLET-CHAR* = 2
 310     Query minimum input length for completion
 311   *QUERY-MAX-COMPLET-LENGTH* = 100
 312     Query maximum length of completion list
 313   *QUERY-TRANSPARENCY* = 0.8
 314     Query string window background transparency
 315   *QUERY-BORDER* = "red"
 316     Query string window border color
 317   *QUERY-PARENT-ERROR-COLOR* = "red"
 318     Query string window parenthesis color when no match
 319   *QUERY-PARENT-COLOR* = "blue"
 320     Query string window parenthesis color
 321   *QUERY-CURSOR-COLOR* = "white"
 322     Query string window foreground cursor color
 323   *QUERY-FOREGROUND* = "green"
 324     Query string window foreground color
 325   *QUERY-MESSAGE-COLOR* = "yellow"
 326     Query string window message color
 327   *QUERY-BACKGROUND* = "black"
 328     Query string window background color
 329   *QUERY-FONT-STRING* = "fixed"
 330     Query string window font string
 331
 332
 333 <= Root Group =>
 334
 335   *SHOW-CURRENT-ROOT-MESSAGE* = "Current root"
 336     Current root notify window message
 337   *SHOW-CURRENT-ROOT-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
 338     Current root notify window placement
 339   *SHOW-CURRENT-ROOT-DELAY* = 1
 340     Delay to show the current root
 341   *HAVE-TO-SHOW-CURRENT-ROOT* = T
 342     Show the current root if true
 343   *CREATE-FRAME-ON-ROOT* = NIL
 344
 345 Create frame on root.
 346 Set this variable to true if you want to allow to create a new frame
 347 on the root window in the main mode with the mouse
 348
 349
 350 <= Second Mode Group =>
 351
 352   *SM-TRANSPARENCY* = 0.8
 353     Second mode background transparency
 354   *SM-HEIGHT* = 25
 355     Second mode window height
 356   *SM-WIDTH* = 300
 357     Second mode window width
 358   *SM-FONT-STRING* = "fixed"
 359     Second mode window font string
 360   *SM-FOREGROUND-COLOR* = "Red"
 361     Second mode window foreground color
 362   *SM-BACKGROUND-COLOR* = "Black"
 363     Second mode window background color
 364   *SM-BORDER-COLOR* = "Green"
 365     Second mode window border color
 366
 367  Those variables can be changed in clfswm.
 368 Maybe you'll need to restart clfswm to take care of new values
 369
 370 This documentation was produced with the CLFSWM auto-doc functions.
 371 To reproduce it, use the produce-conf-var-doc-in-file or
 372 the produce-all-docs function from the Lisp REPL.
 373
 374 Something like this:
 375 LISP> (in-package :clfswm)
 376 CLFSWM> (produce-conf-var-doc-in-file "my-variables.txt")
 377 or
 378 CLFSWM> (produce-all-docs)
 379
 380
 381