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