doc/variables.txt

   1     * CLFSWM Configuration variables *
   2       ------------------------------
   3
   4 <= Circulate Mode Group =>
   5
   6   *CIRCULATE-FONT-STRING* = "fixed"
   7     Circulate string window font string
   8   *CIRCULATE-BACKGROUND* = "black"
   9     Circulate string window background color
  10   *CIRCULATE-FOREGROUND* = "green"
  11     Circulate string window foreground color
  12   *CIRCULATE-BORDER* = "red"
  13     Circulate string window border color
  14   *CIRCULATE-WIDTH* = 400
  15     Circulate mode window width
  16   *CIRCULATE-HEIGHT* = 15
  17     Circulate mode window height
  18   *CIRCULATE-TRANSPARENCY* = 0.8
  19     Circulate window background transparency
  20   *CIRCULATE-TEXT-LIMITE* = 30
  21     Maximum text limite in the circulate window
  22
  23
  24 <= Corner Group =>
  25
  26   *CORNER-SIZE* = 3
  27     The size of the corner square
  28   *CORNER-MAIN-MODE-LEFT-BUTTON* = ((:TOP-LEFT OPEN-MENU)
  29                                     (:TOP-RIGHT PRESENT-VIRTUAL-KEYBOARD)
  30                                     (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE)
  31                                     (:BOTTOM-LEFT NIL))
  32     Actions on corners in the main mode with the left mouse button
  33   *CORNER-MAIN-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM)
  34                                       (:TOP-RIGHT
  35                                        ASK-CLOSE/KILL-CURRENT-WINDOW)
  36                                       (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
  37     Actions on corners in the main mode with the middle mouse button
  38   *CORNER-MAIN-MODE-RIGHT-BUTTON* = ((:TOP-LEFT PRESENT-CLFSWM-TERMINAL)
  39                                      (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW)
  40                                      (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
  41                                      (:BOTTOM-LEFT NIL))
  42     Actions on corners in the main mode with the right mouse button
  43   *CORNER-SECOND-MODE-LEFT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL)
  44                                       (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE)
  45                                       (:BOTTOM-LEFT NIL))
  46     Actions on corners in the second mode with the left mouse button
  47   *CORNER-SECOND-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM)
  48                                         (:TOP-RIGHT NIL) (:BOTTOM-RIGHT NIL)
  49                                         (:BOTTOM-LEFT NIL))
  50     Actions on corners in the second mode with the middle mouse button
  51   *CORNER-SECOND-MODE-RIGHT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL)
  52                                        (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
  53                                        (:BOTTOM-LEFT NIL))
  54     Actions on corners in the second mode with the right mouse button
  55   *VIRTUAL-KEYBOARD-CMD* = "xvkbd"
  56     The command to display the virtual keybaord
  57   Here is an ~/.Xresources example for xvkbd:
  58     xvkbd.windowGeometry: 300x100-0-0
  59     xvkbd*Font: 6x12
  60     xvkbd.modalKeytop: true
  61     xvkbd.customization: -french
  62     xvkbd.keypad: false
  63   And make it always on top
  64   *CLFSWM-TERMINAL-NAME* = "clfswm-terminal"
  65     The clfswm terminal name
  66   *CLFSWM-TERMINAL-CMD* = "xterm -T clfswm-terminal"
  67     The clfswm terminal command.
  68 This command must set the window title to *clfswm-terminal-name*
  69   *CORNER-ERROR-MESSAGE-COLOR* = "red"
  70     Error message color
  71   *CORNER-ERROR-MESSAGE-DELAY* = 5
  72     Time to display the error message on commad error
  73   *CORNER-COMMAND-TRY-DELAY* = 0.2
  74     Time to wait before checking window in query tree
  75   *CORNER-COMMAND-TRY-NUMBER* = 10
  76     Number of try to wait the window in query tree
  77
  78
  79 <= Expose Mode Group =>
  80
  81   *EXPOSE-FONT-STRING* = "fixed"
  82     Expose string window font string
  83   *EXPOSE-BACKGROUND* = "grey10"
  84     Expose string window background color
  85   *EXPOSE-FOREGROUND* = "grey50"
  86     Expose string window foreground color
  87   *EXPOSE-FOREGROUND-LETTER* = "red"
  88     Expose string window foreground color for letters
  89   *EXPOSE-FOREGROUND-LETTER-NOK* = "grey30"
  90     Expose string window foreground color for letter not selected
  91   *EXPOSE-BACKGROUND-LETTER-MATCH* = "green"
  92     Expose string window background color for matching letters
  93   *EXPOSE-BORDER* = "grey20"
  94     Expose string window border color
  95   *EXPOSE-VALID-ON-KEY* = T
  96     Valid expose mode when an accel key is pressed
  97   *EXPOSE-SHOW-WINDOW-TITLE* = T
  98     Show the window title on accel window
  99   *EXPOSE-TRANSPARENCY* = 0.9
 100     Expose string window background transparency
 101   *EXPOSE-DIRECT-SELECT* = T
 102     Immediately select child if they can be directly accessed
 103
 104
 105 <= Frame Colors Group =>
 106
 107   *FRAME-BACKGROUND* = "Black"
 108     Frame background
 109   *FRAME-FOREGROUND* = "Green"
 110     Frame foreground
 111   *FRAME-FOREGROUND-ROOT* = "Red"
 112     Frame foreground when the frame is the root frame
 113   *FRAME-FOREGROUND-HIDDEN* = "Darkgreen"
 114     Frame foreground for hidden windows
 115   *FRAME-TRANSPARENCY* = 0.6
 116     Frame background transparency
 117
 118
 119 <= Gimp Layout Group =>
 120
 121   *GIMP-LAYOUT-NOTIFY-WINDOW-DELAY* = 30
 122     Time to display the GIMP layout notify window help
 123
 124
 125 <= Hook Group =>
 126
 127   *BINDING-HOOK* = (SET-DEFAULT-CIRCULATE-KEYS INIT-*QUERY-KEYS*
 128                                                SET-DEFAULT-QUERY-KEYS
 129                                                INIT-*INFO-KEYS*
 130                                                INIT-*INFO-MOUSE*
 131                                                SET-DEFAULT-INFO-KEYS
 132                                                SET-DEFAULT-INFO-MOUSE
 133                                                INIT-*MAIN-KEYS*
 134                                                INIT-*MAIN-MOUSE*
 135                                                SET-DEFAULT-MAIN-KEYS
 136                                                SET-DEFAULT-MAIN-MOUSE
 137                                                INIT-*SECOND-KEYS*
 138                                                INIT-*SECOND-MOUSE*
 139                                                SET-DEFAULT-SECOND-KEYS
 140                                                SET-DEFAULT-SECOND-MOUSE)
 141     Hook executed when keys/buttons are bounds
 142   *LOOP-HOOK* = NIL
 143     Hook executed on each event loop
 144   *MAIN-ENTRANCE-HOOK* = NIL
 145     Hook executed on the main function entrance after
 146 loading configuration file and before opening the display.
 147   *INIT-HOOK* = (DEFAULT-INIT-HOOK PLACE-FRAMES-FROM-XINERAMA-INFOS
 148                                    DISPLAY-HELLO-WINDOW)
 149     Init hook. This hook is run just after the first root frame is created
 150   *CLOSE-HOOK* = (CLOSE-NOTIFY-WINDOW CLOSE-CLFSWM-TERMINAL
 151                                       CLOSE-VIRTUAL-KEYBOARD)
 152     Close hook. This hook is run just before closing the display
 153   *DEFAULT-NW-HOOK* = DEFAULT-FRAME-NW-HOOK
 154     Default action to do on newly created windows
 155   *QUERY-KEY-PRESS-HOOK* = NIL
 156     Query hook. Hook called on each key press event in query loop
 157   *QUERY-BUTTON-PRESS-HOOK* = NIL
 158     Query hook. Hook called on each button press event in query loop
 159
 160
 161 <= Identify Key Group =>
 162
 163   *IDENTIFY-FONT-STRING* = "fixed"
 164     Identify window font string
 165   *IDENTIFY-BACKGROUND* = "black"
 166     Identify window background color
 167   *IDENTIFY-FOREGROUND* = "green"
 168     Identify window foreground color
 169   *IDENTIFY-BORDER* = "red"
 170     Identify window border color
 171   *IDENTIFY-TRANSPARENCY* = 0.8
 172     Identify window background transparency
 173
 174
 175 <= Info Mode Group =>
 176
 177   *INFO-BACKGROUND* = "black"
 178     Info window background color
 179   *INFO-FOREGROUND* = "green"
 180     Info window foreground color
 181   *INFO-BORDER* = "red"
 182     Info window border color
 183   *INFO-LINE-CURSOR* = "white"
 184     Info window line cursor color color
 185   *INFO-SELECTED-BACKGROUND* = "blue"
 186     Info selected item background color
 187   *INFO-FONT-STRING* = "fixed"
 188     Info window font string
 189   *INFO-TRANSPARENCY* = 0.8
 190     Info window background transparency
 191   *INFO-CLICK-TO-SELECT* = T
 192     If true, click on info window select item. Otherwise, click to drag the menu
 193   *INFO-COLOR-TITLE* = "Magenta"
 194     Colored info title color
 195   *INFO-COLOR-UNDERLINE* = "Yellow"
 196     Colored info underline color
 197   *INFO-COLOR-FIRST* = "Cyan"
 198     Colored info first color
 199   *INFO-COLOR-SECOND* = "lightblue"
 200     Colored info second color
 201
 202
 203 <= Main Mode Group =>
 204
 205   *COLOR-MOVE-WINDOW* = "DeepPink"
 206     Color when moving or resizing a windows
 207   *COLOR-SELECTED* = "Red"
 208     Color of selected window
 209   *COLOR-UNSELECTED* = "Blue"
 210     Color of unselected color
 211   *COLOR-MAYBE-SELECTED* = "Yellow"
 212     Color of maybe selected windows
 213
 214
 215 <= Menu Group =>
 216
 217   *XDG-SECTION-LIST* = (TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO
 218                         VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK
 219                         OFFICE SETTINGS SYSTEM UTILITY TERMINALEMULATOR
 220                         SCREENSAVER)
 221     Standard menu sections
 222   *MENU-COLOR-SUBMENU* = "Cyan"
 223     Submenu color in menu
 224   *MENU-COLOR-COMMENT* = "Yellow"
 225     Comment color in menu
 226   *MENU-COLOR-KEY* = "Magenta"
 227     Key color in menu
 228   *MENU-COLOR-MENU-KEY* = #<XLIB:COLOR 0.99609375 0.6015625 0.99609375>
 229     Menu key color in menu
 230
 231
 232 <= Miscellaneous Group =>
 233
 234   *HAVE-TO-COMPRESS-NOTIFY* = T
 235     Compress event notify?
 236 This variable may be useful to speed up some slow version of CLX.
 237 It is particulary useful with CLISP/MIT-CLX.
 238   *TRANSPARENT-BACKGROUND* = T
 239     Enable transparent background: one of nil, :pseudo, t (xcompmgr must be started)
 240   *DEFAULT-TRANSPARENCY* = 0.8
 241     Default transparency for all windows when in xcompmgr transparency mode
 242   *SHOW-ROOT-FRAME-P* = NIL
 243     Show the root frame information or not
 244   *BORDER-SIZE* = 1
 245     Windows and frames border size
 246   *LOOP-TIMEOUT* = 1
 247     Maximum time (in seconds) to wait before calling *loop-hook*
 248   *DEFAULT-FONT-STRING* = "fixed"
 249     The default font used in clfswm
 250   *DEFAULT-FRAME-DATA* = ((:TILE-SIZE 0.8) (:TILE-SPACE-SIZE 0.1)
 251                           (:FAST-LAYOUT (TILE-LEFT-LAYOUT TILE-LAYOUT))
 252                           (:MAIN-LAYOUT-WINDOWS NIL))
 253     Default slots set in frame date
 254   *DEFAULT-MANAGED-TYPE* = (:NORMAL)
 255     Default managed window types
 256   *DEFAULT-FOCUS-POLICY* = :CLICK
 257     Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select.
 258   *SHOW-HIDE-POLICY* = #<Function <= {10500641}>
 259     'NIL': always display all children (better with transparency support).
 260 '<': Hide only children less than children above.
 261 '<=': Hide children less or equal to children above (better for performance on slow machine).
 262   *DEFAULT-MODIFIERS* = NIL
 263     Default modifiers list to append to explicit modifiers
 264 Example: :mod-2 for num_lock, :lock for Caps_lock...
 265   *NEVER-MANAGED-WINDOW-LIST* = ((IS-NOTIFY-WINDOW-P RAISE-WINDOW)
 266                                  (EQUAL-WM-CLASS-ROX-PINBOARD NIL)
 267                                  (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW)
 268                                  (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW))
 269     CLFSWM will never manage windows of this type.
 270 A list of (list match-function handle-function)
 271   *HIDE-UNMANAGED-WINDOW* = T
 272     Hide or not unmanaged windows when a child is deselected.
 273   *SNAP-SIZE* = 5
 274     Snap size (in % of parent size) when move or resize frame is constrained
 275   *SPATIAL-MOVE-DELAY-BEFORE* = 0.2
 276     Delay to display the current child before doing a spatial move
 277   *SPATIAL-MOVE-DELAY-AFTER* = 0.5
 278     Delay to display the new child after doing a spatial move
 279   *DEFAULT-WINDOW-WIDTH* = 400
 280     Default window width
 281   *DEFAULT-WINDOW-HEIGHT* = 300
 282     Default window height
 283
 284
 285 <= Notify Window Group =>
 286
 287   *NOTIFY-WINDOW-FONT-STRING* = "fixed"
 288     Notify window font string
 289   *NOTIFY-WINDOW-BACKGROUND* = "black"
 290     Notify Window background color
 291   *NOTIFY-WINDOW-FOREGROUND* = "green"
 292     Notify Window foreground color
 293   *NOTIFY-WINDOW-BORDER* = "red"
 294     Notify Window border color
 295   *NOTIFY-WINDOW-DELAY* = 10
 296     Notify Window display delay
 297   *NOTIFY-WINDOW-TRANSPARENCY* = 0.8
 298     Notify window background transparency
 299
 300
 301 <= Placement Group =>
 302
 303   *BANISH-POINTER-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
 304     Pointer banishment placement
 305   *SECOND-MODE-PLACEMENT* = TOP-MIDDLE-ROOT-PLACEMENT
 306     Second mode window placement
 307   *INFO-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
 308     Info mode window placement
 309   *QUERY-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
 310     Query mode window placement
 311   *CIRCULATE-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
 312     Circulate mode window placement
 313   *EXPOSE-MODE-PLACEMENT* = TOP-LEFT-CHILD-PLACEMENT
 314     Expose mode window placement (Selection keys position)
 315   *EXPOSE-QUERY-PLACEMENT* = BOTTOM-LEFT-ROOT-PLACEMENT
 316     Expose mode query window placement
 317   *NOTIFY-WINDOW-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
 318     Notify window placement
 319   *ASK-CLOSE/KILL-PLACEMENT* = TOP-RIGHT-ROOT-PLACEMENT
 320     Ask close/kill window placement
 321   *UNMANAGED-WINDOW-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
 322     Unmanager window placement
 323
 324
 325 <= Query String Group =>
 326
 327   *QUERY-FONT-STRING* = "fixed"
 328     Query string window font string
 329   *QUERY-BACKGROUND* = "black"
 330     Query string window background color
 331   *QUERY-MESSAGE-COLOR* = "yellow"
 332     Query string window message color
 333   *QUERY-FOREGROUND* = "green"
 334     Query string window foreground color
 335   *QUERY-CURSOR-COLOR* = "white"
 336     Query string window foreground cursor color
 337   *QUERY-PARENT-COLOR* = "blue"
 338     Query string window parenthesis color
 339   *QUERY-PARENT-ERROR-COLOR* = "red"
 340     Query string window parenthesis color when no match
 341   *QUERY-BORDER* = "red"
 342     Query string window border color
 343   *QUERY-TRANSPARENCY* = 0.8
 344     Query string window background transparency
 345   *QUERY-MAX-COMPLET-LENGTH* = 100
 346     Query maximum length of completion list
 347   *QUERY-MIN-COMPLET-CHAR* = 2
 348     Query minimum input length for completion
 349
 350
 351 <= Root Group =>
 352
 353   *CREATE-FRAME-ON-ROOT* = NIL
 354     Create frame on root.
 355 Set this variable to true if you want to allow to create a new frame
 356 on the root window in the main mode with the mouse
 357   *HAVE-TO-SHOW-CURRENT-ROOT* = T
 358     Show the current root if true
 359   *SHOW-CURRENT-ROOT-DELAY* = 1
 360     Delay to show the current root
 361   *SHOW-CURRENT-ROOT-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
 362     Current root notify window placement
 363   *SHOW-CURRENT-ROOT-MESSAGE* = "Current root"
 364     Current root notify window message
 365
 366
 367 <= Second Mode Group =>
 368
 369   *SM-BORDER-COLOR* = "Green"
 370     Second mode window border color
 371   *SM-BACKGROUND-COLOR* = "Black"
 372     Second mode window background color
 373   *SM-FOREGROUND-COLOR* = "Red"
 374     Second mode window foreground color
 375   *SM-FONT-STRING* = "fixed"
 376     Second mode window font string
 377   *SM-WIDTH* = 300
 378     Second mode window width
 379   *SM-HEIGHT* = 25
 380     Second mode window height
 381   *SM-TRANSPARENCY* = 0.8
 382     Second mode background transparency
 383
 384  Those variables can be changed in clfswm.
 385 Maybe you'll need to restart clfswm to take care of new values
 386
 387 This documentation was produced with the CLFSWM auto-doc functions.
 388 To reproduce it, use the produce-conf-var-doc-in-file or
 389 the produce-all-docs function from the Lisp REPL.
 390
 391 Something like this:
 392 LISP> (in-package :clfswm)
 393 CLFSWM> (produce-conf-var-doc-in-file "my-variables.txt")
 394 or
 395 CLFSWM> (produce-all-docs)
 396
 397
 398