Skip to content
variables.txt 16.8 KiB
Newer Older
    * CLFSWM Configuration variables *
      ------------------------------

<= Circulate Mode Group =>

  *CIRCULATE-TEXT-LIMITE* = 30
    Maximum text limite in the circulate window
  *CIRCULATE-TRANSPARENCY* = 0.8
    Circulate window background transparency
  *CIRCULATE-HEIGHT* = 15
    Circulate mode window height
  *CIRCULATE-WIDTH* = 400
    Circulate mode window width
  *CIRCULATE-BORDER* = "red"
    Circulate string window border color
  *CIRCULATE-FOREGROUND* = "green"
    Circulate string window foreground color
  *CIRCULATE-BACKGROUND* = "black"
    Circulate string window background color
  *CIRCULATE-FONT-STRING* = "fixed"
    Circulate string window font string
  *CORNER-COMMAND-TRY-NUMBER* = 10
    Number of try to wait the window in query tree
  *CORNER-COMMAND-TRY-DELAY* = 0.2
    Time to wait before checking window in query tree
  *CORNER-ERROR-MESSAGE-DELAY* = 5
    Time to display the error message on commad error
  *CORNER-ERROR-MESSAGE-COLOR* = "red"
    Error message color
  *CLFSWM-TERMINAL-CMD* = "xterm -T clfswm-terminal"
    
The clfswm terminal command.
This command must set the window title to *clfswm-terminal-name*
  *CLFSWM-TERMINAL-NAME* = "clfswm-terminal"
    The clfswm terminal name
    
The command to display the virtual keybaord
  Here is an ~/.Xresources example for xvkbd:
    xvkbd.windowGeometry: 300x100-0-0
    xvkbd*Font: 6x12
    xvkbd.modalKeytop: true
    xvkbd.customization: -french
    xvkbd.keypad: false
  And make it always on top
  *CORNER-SECOND-MODE-RIGHT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
    Actions on corners in the second mode with the right mouse button
  *CORNER-SECOND-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
    Actions on corners in the second mode with the middle mouse button
  *CORNER-SECOND-MODE-LEFT-BUTTON* = ((:TOP-LEFT NIL) (:TOP-RIGHT NIL) (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
    Actions on corners in the second mode with the left mouse button
  *CORNER-MAIN-MODE-RIGHT-BUTTON* = 
((:TOP-LEFT PRESENT-CLFSWM-TERMINAL) (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW) (:BOTTOM-RIGHT EXPOSE-ALL-WINDOWS-MODE)
 (:BOTTOM-LEFT START-FILE-MANAGER))
    Config(Corner group): Actions on corners in the main mode with the right mouse button
  *CORNER-MAIN-MODE-MIDDLE-BUTTON* = ((:TOP-LEFT HELP-ON-CLFSWM) (:TOP-RIGHT ASK-CLOSE/KILL-CURRENT-WINDOW) (:BOTTOM-RIGHT NIL) (:BOTTOM-LEFT NIL))
    Actions on corners in the main mode with the middle mouse button
  *CORNER-MAIN-MODE-LEFT-BUTTON* = ((:TOP-LEFT OPEN-MENU) (:TOP-RIGHT PRESENT-VIRTUAL-KEYBOARD) (:BOTTOM-RIGHT EXPOSE-WINDOWS-MODE) (:BOTTOM-LEFT NIL))
    Actions on corners in the main mode with the left mouse button
  *CORNER-SIZE* = 3
    The size of the corner square
Philippe Brochard's avatar
Philippe Brochard committed
  *EXPOSE-DIRECT-SELECT* = T
    Immediately select child if they can be directly accessed
  *EXPOSE-TRANSPARENCY* = 0.9
    Expose string window background transparency
  *EXPOSE-SHOW-WINDOW-TITLE* = T
    Show the window title on accel window
  *EXPOSE-VALID-ON-KEY* = T
    Valid expose mode when an accel key is pressed
  *EXPOSE-BORDER* = "grey20"
    Expose string window border color
  *EXPOSE-BACKGROUND-LETTER-MATCH* = "green"
    Expose string window background color for matching letters
  *EXPOSE-FOREGROUND-LETTER-NOK* = "grey30"
    Expose string window foreground color for letter not selected
  *EXPOSE-FOREGROUND-LETTER* = "red"
    Expose string window foreground color for letters
  *EXPOSE-FOREGROUND* = "grey50"
    Expose string window foreground color
  *EXPOSE-BACKGROUND* = "grey10"
    Expose string window background color
  *EXPOSE-FONT-STRING* = "fixed"
    Expose string window font string
Philippe Brochard's avatar
Philippe Brochard committed
  *FRAME-TRANSPARENCY* = 0.6
    Frame background transparency
  *FRAME-FOREGROUND-HIDDEN* = "Darkgreen"
    Frame foreground for hidden windows
  *FRAME-FOREGROUND-ROOT* = "Red"
    Frame foreground when the frame is the root frame
  *FRAME-FOREGROUND* = "Green"
    Frame foreground
  *FRAME-BACKGROUND* = "Black"
    Frame background


<= Gimp Layout Group =>

  *GIMP-LAYOUT-NOTIFY-WINDOW-DELAY* = 30
    Time to display the GIMP layout notify window help


<= Hook Group =>

Philippe Brochard's avatar
Philippe Brochard committed
  *QUERY-BUTTON-PRESS-HOOK* = NIL
    Query hook. Hook called on each button press event in query loop
  *QUERY-KEY-PRESS-HOOK* = (QUERY-MODE-COMPLETE-SUGGEST-RESET)
    Query hook. Hook called on each key press event in query loop
  *DEFAULT-NW-HOOK* = DEFAULT-FRAME-NW-HOOK
    Default action to do on newly created windows
  *CLOSE-HOOK* = (CLOSE-NOTIFY-WINDOW CLOSE-CLFSWM-TERMINAL CLOSE-VIRTUAL-KEYBOARD CLOSE-ALL-TOOLBARS)
    Close hook. This hook is run just before closing the display
  *INIT-HOOK* = (DEFAULT-INIT-HOOK DISPLAY-HELLO-WINDOW OPEN-ALL-TOOLBARS MY-INIT-HOOK MY-WALLPAPER)
    Init hook. This hook is run just after the first root frame is created
  *ROOT-SIZE-CHANGE* = (MY-WALLPAPER)
    Hook executed when the root size has changed for example when adding/removing a monitor
  *MAIN-ENTRANCE-HOOK* = NIL
    
Hook executed on the main function entrance after
loading configuration file and before opening the display.
  *LOOP-HOOK* = NIL
    Hook executed on each event loop
  *BINDING-HOOK* = 
(INIT-*QUERY-KEYS* SET-DEFAULT-QUERY-KEYS SET-DEFAULT-CIRCULATE-KEYS INIT-*INFO-KEYS* INIT-*INFO-MOUSE*
 SET-DEFAULT-INFO-KEYS SET-DEFAULT-INFO-MOUSE INIT-*MAIN-KEYS* INIT-*MAIN-MOUSE* SET-DEFAULT-MAIN-KEYS
 SET-DEFAULT-MAIN-MOUSE INIT-*SECOND-KEYS* INIT-*SECOND-MOUSE* SET-DEFAULT-SECOND-KEYS SET-DEFAULT-SECOND-MOUSE
 MPD-BINDING FR-BINDING REBOOT-HALT-BINDING INIT-*VOLUME-KEYS* SET-DEFAULT-VOLUME-KEYS AMIXER-VOLUME-BIND LOCAL-BINDING)
    Hook executed when keys/buttons are bounds
Philippe Brochard's avatar
Philippe Brochard committed
  *IDENTIFY-TRANSPARENCY* = 0.8
Philippe Brochard's avatar
Philippe Brochard committed
    Identify window background transparency
  *IDENTIFY-BORDER* = "red"
    Identify window border color
  *IDENTIFY-FOREGROUND* = "green"
    Identify window foreground color
  *IDENTIFY-BACKGROUND* = "black"
    Identify window background color
  *IDENTIFY-FONT-STRING* = "fixed"
    Identify window font string


<= Info Mode Group =>

  *INFO-COLOR-SECOND* = "lightblue"
    Colored info second color
  *INFO-COLOR-FIRST* = "Cyan"
    Colored info first color
  *INFO-COLOR-UNDERLINE* = "Yellow"
    Colored info underline color
  *INFO-COLOR-TITLE* = "Magenta"
    Colored info title color
  *INFO-CLICK-TO-SELECT* = T
    If true, click on info window select item. Otherwise, click to drag the menu
  *INFO-TRANSPARENCY* = 0.8
    Info window background transparency
  *INFO-FONT-STRING* = "fixed"
    Info window font string
  *INFO-SELECTED-BACKGROUND* = "blue"
    Info selected item background color
  *INFO-LINE-CURSOR* = "white"
    Info window line cursor color color
  *INFO-BORDER* = "red"
    Info window border color
  *INFO-FOREGROUND* = "green"
    Info window foreground color
  *INFO-BACKGROUND* = "black"
    Info window background color


<= Main Mode Group =>

  *COLOR-MAYBE-SELECTED* = "Yellow"
    Color of maybe selected windows
  *COLOR-UNSELECTED* = "Blue"
    Color of unselected color
  *COLOR-SELECTED* = "Red"
    Color of selected window
  *COLOR-MOVE-WINDOW* = "DeepPink"
    Color when moving or resizing a windows
  *MENU-KEY-BOUND-COLOR* = "gray50"
    Key bound min menu color
  *MENU-COLOR-MENU-KEY* = #<XLIB:COLOR 0.99609375 0.6015625 0.99609375>
    Menu key color in menu
  *MENU-COLOR-KEY* = "Magenta"
    Key color in menu
  *MENU-COLOR-COMMENT* = "Yellow"
    Comment color in menu
  *MENU-COLOR-SUBMENU* = "Cyan"
    Submenu color in menu
  *XDG-SECTION-LIST* = 
(TEXTEDITOR FILEMANAGER WEBBROWSER AUDIOVIDEO AUDIO VIDEO DEVELOPMENT EDUCATION GAME GRAPHICS NETWORK OFFICE SETTINGS
 SYSTEM UTILITY TERMINALEMULATOR SCREENSAVER)
    Standard menu sections
  *DEFAULT-WINDOW-HEIGHT* = 300
    Default window height
  *DEFAULT-WINDOW-WIDTH* = 400
    Default window width
  *SPATIAL-MOVE-DELAY-AFTER* = 0.5
    Delay to display the new child after doing a spatial move
  *SPATIAL-MOVE-DELAY-BEFORE* = 0.2
    Delay to display the current child before doing a spatial move
  *SNAP-SIZE* = 5
    Snap size (in % of parent size) when move or resize frame is constrained
  *HIDE-UNMANAGED-WINDOW* = T
    Hide or not unmanaged windows when a child is deselected.
  *NEVER-MANAGED-WINDOW-LIST* = 
((IS-NOTIFY-WINDOW-P RAISE-WINDOW) (EQUAL-WM-CLASS-ROX-PINBOARD NIL) (EQUAL-WM-CLASS-XVKBD RAISE-WINDOW)
 (EQUAL-CLFSWM-TERMINAL RAISE-AND-FOCUS-WINDOW))
    
CLFSWM will never manage windows of this type.
A list of (list match-function handle-function)
  *DEFAULT-MODIFIERS* = NIL
    
Default modifiers list to append to explicit modifiers
Example: :mod-2 for num_lock, :lock for Caps_lock...
  *SHOW-HIDE-POLICY* = #<SYSTEM-FUNCTION <=>
    
'NIL': always display all children (better with transparency support).
'<': Hide only children less than children above.
'<=': Hide children less or equal to children above (better for performance on slow machine).
  *DEFAULT-FOCUS-POLICY* = :CLICK
    Default mouse focus policy. One of :click, :sloppy, :sloppy-strict or :sloppy-select.
  *DEFAULT-MANAGED-TYPE* = (:NORMAL)
    Default managed window types
  *DEFAULT-FRAME-DATA* = ((:TILE-SIZE 0.8) (:TILE-SPACE-SIZE 0.1) (:MAIN-LAYOUT-WINDOWS NIL) (:FAST-LAYOUT (TILE-SPACE-LAYOUT NO-LAYOUT)))
    Default slots set in frame date
  *DEFAULT-FONT-STRING* = "fixed"
    The default font used in clfswm
  *LOOP-TIMEOUT* = 1
    Maximum time (in seconds) to wait before calling *loop-hook*
  *BORDER-SIZE* = 1
    Windows and frames border size
  *SHOW-ROOT-FRAME-P* = NIL
    Show the root frame information or not
  *DEFAULT-TRANSPARENCY* = 0.8
    Default transparency for all windows when in xcompmgr transparency mode
  *TRANSPARENT-BACKGROUND* = T
    Enable transparent background: one of nil, :pseudo, t (xcompmgr must be started)
    
Compress event notify?
This variable may be useful to speed up some slow version of CLX.
It is particulary useful with CLISP/MIT-CLX.
Philippe Brochard's avatar
Philippe Brochard committed
  *NOTIFY-WINDOW-TRANSPARENCY* = 0.8
Philippe Brochard's avatar
Philippe Brochard committed
    Notify window background transparency
  *NOTIFY-WINDOW-DELAY* = 10
    Notify Window display delay
  *NOTIFY-WINDOW-BORDER* = "red"
    Notify Window border color
  *NOTIFY-WINDOW-FOREGROUND* = "green"
    Notify Window foreground color
  *NOTIFY-WINDOW-BACKGROUND* = "black"
    Notify Window background color
  *NOTIFY-WINDOW-FONT-STRING* = "fixed"
    Notify window font string
  *VOLUME-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
    Volume mode window placement
  *TOOLBAR-WINDOW-PLACEMENT* = TOP-LEFT-PLACEMENT
    Toolbar window placement
Philippe Brochard's avatar
Philippe Brochard committed
  *UNMANAGED-WINDOW-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
    Unmanager window placement
  *ASK-CLOSE/KILL-PLACEMENT* = TOP-RIGHT-ROOT-PLACEMENT
    Ask close/kill window placement
  *NOTIFY-WINDOW-PLACEMENT* = BOTTOM-RIGHT-ROOT-PLACEMENT
    Notify window placement
  *EXPOSE-QUERY-PLACEMENT* = BOTTOM-LEFT-ROOT-PLACEMENT
    Expose mode query window placement
  *EXPOSE-MODE-PLACEMENT* = TOP-LEFT-CHILD-PLACEMENT
    Expose mode window placement (Selection keys position)
  *CIRCULATE-MODE-PLACEMENT* = BOTTOM-MIDDLE-ROOT-PLACEMENT
    Circulate mode window placement
  *QUERY-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
    Query mode window placement
  *INFO-MODE-PLACEMENT* = TOP-LEFT-ROOT-PLACEMENT
    Info mode window placement
  *SECOND-MODE-PLACEMENT* = TOP-MIDDLE-ROOT-PLACEMENT
    Second mode window placement
  *BANISH-POINTER-PLACEMENT* = MIDDLE-RIGHT-ROOT-PLACEMENT
    Pointer banishment placement


<= Power Management Group =>

  *POWER-HALT-CMD* = "sudo /sbin/halt"
    Halt command
  *POWER-REBOOT-CMD* = "sudo /sbin/reboot"
    Reboot command
  *POWER-SUSPEND-TO-DISK-CMD* = "sudo pm-hibernate"
    Suspend to disk command
  *POWER-SUSPEND-TO-RAM-CMD* = "sudo pm-suspend"
    Suspend to ram command
Philippe Brochard's avatar
Philippe Brochard committed
  *QUERY-MIN-COMPLET-CHAR* = 2
    Query minimum input length for completion
  *QUERY-MAX-COMPLET-LENGTH* = 100
    Query maximum length of completion list
  *QUERY-TRANSPARENCY* = 0.8
    Query string window background transparency
  *QUERY-BORDER* = "red"
    Query string window border color
  *QUERY-PARENT-ERROR-COLOR* = "red"
    Query string window parenthesis color when no match
  *QUERY-PARENT-COLOR* = "blue"
    Query string window parenthesis color
  *QUERY-CURSOR-COLOR* = "white"
    Query string window foreground cursor color
  *QUERY-FOREGROUND* = "green"
    Query string window foreground color
  *QUERY-MESSAGE-COLOR* = "yellow"
    Query string window message color
  *QUERY-BACKGROUND* = "black"
    Query string window background color
  *QUERY-FONT-STRING* = "fixed"
    Query string window font string
Philippe Brochard's avatar
Philippe Brochard committed
<= Root Group =>

  *SHOW-CURRENT-ROOT-MESSAGE* = "Current root"
    Current root notify window message
  *SHOW-CURRENT-ROOT-PLACEMENT* = MIDDLE-MIDDLE-ROOT-PLACEMENT
    Current root notify window placement
  *SHOW-CURRENT-ROOT-DELAY* = 1
    Delay to show the current root
  *HAVE-TO-SHOW-CURRENT-ROOT* = T
    Show the current root if true
Philippe Brochard's avatar
Philippe Brochard committed
  *CREATE-FRAME-ON-ROOT* = NIL
    
Create frame on root.
Philippe Brochard's avatar
Philippe Brochard committed
Set this variable to true if you want to allow to create a new frame
on the root window in the main mode with the mouse


Philippe Brochard's avatar
Philippe Brochard committed
  *SM-TRANSPARENCY* = 0.8
Philippe Brochard's avatar
Philippe Brochard committed
    Second mode background transparency
  *SM-HEIGHT* = 25
    Second mode window height
  *SM-WIDTH* = 300
    Second mode window width
  *SM-FONT-STRING* = "fixed"
    Second mode window font string
  *SM-FOREGROUND-COLOR* = "Red"
    Second mode window foreground color
  *SM-BACKGROUND-COLOR* = "Black"
    Second mode window background color
  *SM-BORDER-COLOR* = "Green"
    Second mode window border color


<= Toolbar Group =>

  *TOOLBAR-VOLUME-MODE-BUTTON-COLOR* = "green"
    Volume mode color
  *TOOLBAR-MPD-BUTTONS-COLOR* = "green"
    MPD - Music Player Daemon buttons color
  *TOOLBAR-MPD-INFO-COLOR* = "green"
    MPD - Music Player Daemon information color
  *MPD-TOOLBAR-CLIENT* = "gmpc"
    MPD client
  *MPD-TOOLBAR* = ((MPD-BUTTONS 1) (MPD-INFO 60))
    MPD toolbar modules
  *TOOLBAR-EXPOSE-MODE-BUTTON-COLOR* = "green"
    Expose-mode button
  *TOOLBAR-SYSTEM-INFO-URGENT-COLOR* = "Red"
    System information colors (CPU+Mem+Battery)
  *TOOLBAR-SYSTEM-INFO-ALERT-COLOR* = "Magenta"
    System information colors (CPU+Mem+Battery)
  *TOOLBAR-SYSTEM-INFO-LOW-COLOR* = "Yellow"
    System information colors (CPU+Mem+Battery)
  *TOOLBAR-SYSTEM-INFO-COLOR* = "green"
    System information colors (CPU+Mem+Battery)
  *TOOLBAR-MEM-COLOR* = "green"
    Memory color
  *TOOLBAR-CPU-COLOR* = "green"
    CPU color
  *TOOLBAR-CLFSWM-MENU-COLOR* = "green"
    CLFSWM menu color
  *TOOLBAR-CLOCK-ACTION* = "xclock -analog"
    Toolbar clickable clock module action on click
  *TOOLBAR-CLICKABLE-CLOCK-COLOR* = "green"
    Clickable clock color
  *TOOLBAR-CLICKABLE-LABEL-COLOR* = "green"
    Clickable label color
  *TOOLBAR-LABEL-COLOR* = "green"
    Label color
  *TOOLBAR-CLOCK-COLOR* = "green"
    Clock color
  *TOOLBAR-SENSIBILITY* = 3
    Toolbar sensibility in pixels
  *TOOLBAR-DEFAULT-AUTOHIDE* = NIL
    Toolbar default autohide value
  *TOOLBAR-DEFAULT-REFRESH-DELAY* = 30
    Toolbar default refresh delay
  *TOOLBAR-DEFAULT-THICKNESS* = 20
    Toolbar default thickness
  *TOOLBAR-WINDOW-TRANSPARENCY* = 0.8
    Toolbar window background transparency
  *TOOLBAR-DEFAULT-BORDER-SIZE* = 0
    Toolbar Window border size
  *TOOLBAR-WINDOW-BORDER* = "red"
    Toolbar Window border color
  *TOOLBAR-WINDOW-FOREGROUND* = "green"
    Toolbar Window foreground color
  *TOOLBAR-WINDOW-BACKGROUND* = "black"
    Toolbar Window background color
  *TOOLBAR-WINDOW-FONT-STRING* = "fixed"
    Toolbar window font string
  *DEFAULT-TOOLBAR* = ((CLFSWM-MENU 1) (EXPOSE-MODE-BUTTON 10) (SYSTEM-USAGE 90) (CLICKABLE-CLOCK 99))
    Default toolbar modules


<= Volume Mode Group =>

  *VOLUME-EXTERNAL-MIXER-CMD* = "/usr/bin/gnome-alsamixer"
    Command to start an external mixer program
  *VOLUME-TEXT-LIMIT* = 30
    Maximum text limit in the volume window
  *VOLUME-HEIGHT* = 15
    Volume mode window height
  *VOLUME-WIDTH* = 400
    Volume mode window width
  *VOLUME-BORDER-SIZE* = 1
    Volume window border size
  *VOLUME-BORDER* = "red"
    Volume window border color
  *VOLUME-FOREGROUND* = "green"
    Volume window foreground color
  *VOLUME-BACKGROUND* = "black"
    Volume window background color
  *VOLUME-FONT-STRING* = "fixed"
    Volume window font string


<= Wallpaper Group =>

  *WALLPAPER-COMMAND* = "Esetroot -scale"
    Command to install the wallpaper

 Those variables can be changed in clfswm.
Maybe you'll need to restart clfswm to take care of new values

This documentation was produced with the CLFSWM auto-doc functions.
To reproduce it, use the produce-conf-var-doc-in-file or
the produce-all-docs function from the Lisp REPL.

Something like this:
LISP> (in-package :clfswm)
CLFSWM> (produce-conf-var-doc-in-file "my-variables.txt")