doc/variables.txt

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