DOKK / manpages / debian 12 / icewm-common / icewm-preferences.5.en
ICEWM-PREFERENCES(5) Standards, Environments and Macros ICEWM-PREFERENCES(5)

NAME

 icewm-preferences - icewm preferences configuration file

SYNOPSIS

 $ICEWM_PRIVCFG/preferences
 $XDG_CONFIG_HOME/icewm/preferences
 $HOME/.icewm/preferences
 /etc/X11/icewm/preferences
 /usr/share/icewm/preferences

DESCRIPTION

Contains general settings like paths, colors and fonts, but also options to control the icewm focus behaviour and the applets which are started in the task bar. The icewm installation will provide a default preferences file, which can be copied to the icewm user configuration directory and modified.

FORMAT

FOCUS AND BEHAVIOR

The following preferences affect focus and general behavior of icewm(1):

Use a 32-bit visual for alpha blending
Synchronize X11 for debugging (slow)
Enable event logging for debugging
Splash image on startup (IceWM.jpg)
Enable tracing for the given list of modules. Modules which are traceable include conf, font, icon, prog, systray.
Focus windows by clicking in them.
Focus windows when applications request that they be raised.
Request focus (flashing in taskbar) when application requests raise.
Raise windows when focused.
Focus window when client area clicked.
Raise window when client area clicked.
Raise window when title bar is clicked.
Raise window when frame button is clicked.
Raise window when frame border is clicked.
Lower the active window when clicked again.
Pass focusing click on client area to client.
Change to the workspace of newly focused windows.
Move newly focused windows to current workspace.
Focus normal window when initially mapped.
Focus dialog window when initially mapped.
Focus dialog window when initially mapped only if parent frame focused.
Put new windows on top even if not focusing them.
Colormap focus follows pointer.
Don't rotate the cursor for popup menus.
Limit size of windows to screen.
Limit position of windows to screen.
Let the Dock layer limit the workspace (incompatible with GNOME Panel).
Consider border frames when maximizing horizontally.
Consider border frames when maximizing vertically.
Consider XSizeHints if frame is maximized. Turning this off allows the titlebar to cover the width of the screen.
Center maximized windows which can't fit the screen (like terminals).
Hide window borders if window is maximized.
Maximized windows can be resized.
Show position status window during move/resize.
Show name of current workspace while switching.
Display mini-icons on desktop for minimized windows.
Place the mini-icons horizontal instead of vertical.
Place new mini-icons from right to left.
Place new mini-icons from bottom to top.
Always maintain focus under mouse window (makes some keyboard support non-functional or unreliable.
Opaque window move.
Opaque window resize.
Windows initially placed manually by user.
Smart window placement (minimal overlap).
Hide title bar when maximized.
Center large windows.
Center dialogs on owner window.
Menus track mouse even with no mouse buttons held.
Raise windows when the mouse pointer enters, after a delay of AutoRaiseDelay milliseconds. Note that "RaiseOnFocus=1" may interfere.
Delay pointer focusing when mouse moves.
Support the Windows/Super key modifier to activate special functions. The left Super key toggles the Start menu, while the right Super key toggles the Window list window.
Treat the Super/Win key modifier as a synonym for the Ctrl+Alt modifier combination. The default key bindings have many occurrences of Ctrl+Alt. If you enable this, then the Super modifier is an alternative way to activate them.
Support mouse wheel. When pressing Ctrl+Alt rotating the mouse wheel on the root window will cycle the focus over the windows.
Group applications with the same class name under a single task button. 0 disables it, 1 shows the number of windows, 2 shows bread crumbs, 3 shows a number + bread crumbs.
Show popup menus above mouse pointer.
Send the clicks outside menus to target window.
Allow mouse actions on client windows (buggy with some programs).
Manage root window (EXPERIMENTAL - normally enabled!).
Snap to nearest screen edge/window when moving windows.
Distance in pixels before windows snap together.
Automatically arrange windows when screen size changes.
Allow to switch a window to fullscreen.
Span over all available screens if window goes into fullscreen.
Preselect to Cancel (0) or the OK (1) button in message boxes.
NET_WORKAREA behaviour: 0 (single/multi-monitor with STRUT information, like metacity), 1 (always full desktop), 2 (single monitor with STRUT, multi-monitor without STRUT).

QUICK SWITCH

Enable Alt+Tab window switching.
Enable Alt+Tab to minimized windows.
Enable Alt+Tab to hidden windows.
Prioritize Alt+Tab to urgent windows.
Include windows from all workspaces in Alt+Tab.
Group windows by workspace together in Alt+Tab.
Time in seconds to remember the state of Alt+Tab.
Raise a selected window while Alt+Tabbing in the QuickSwitch.
Show all reachable icons when quick switching.
Show the window title above (all reachable) icons.
Create a smaller QuickSwitch window of 1/3 screen width.
Go trough all window titles and choose width of the longest one.
Place the icons and titles vertical instead of horizontal.
Show the huge (48x48) of the window icon for the active window.
Fill the rectangle highlighting the current icon.

EDGE SWITCHING

Workspace switches by moving mouse to left/right screen edge.
Workspace switches by moving mouse to left/right screen edge.
Workspace switches by moving mouse to top/bottom screen edge.
Workspace switches continuously when moving mouse to screen edge.
Resistance in pixels when trying to move windows off the screen (10000 = infinite).

TASK BAR

The following preferences affect the icewm(1) task bar:

Show task bar.
Task bar at top of the screen.
Keep the task bar below regular windows.
Auto hide task bar after delay.
Auto show task bar when fullscreen window active.
Show clock on task bar.
Show battery status monitor on task bar.
Enable TaskBarShowAPMStatus if a battery is present.
Show battery status on task bar in time-format
Show battery status in graph mode.
Show mailbox status on task bar.
Beep when new mail arrives.
Count messages in mailbox.
Show workspace switching buttons on task bar.
Show windows on the taskbar.
Show 'show desktop' button on taskbar. If set to 2, it will move the icon to the right side, after the clock.
Show Ellipsis in taskbar items.
Show windows in the tray.
Enable the system tray in the taskbar.
Show windows from all workspaces on tray.
Show transient (dialogs, ...) windows on task bar.
Show windows from all workspaces on task bar.
Show icons of windows on the task bar.
Show 'Start' menu on task bar.
Show 'window list' menu on task bar.
Show CPU status on task bar (Linux & Solaris).
Show RAM usage in CPU status tool tip.
Show swap usage in CPU status tool tip.
Show ACPI temperature in CPU status tool tip.
Show ACPI temperature in CPU status bar.
Show CPU frequency in CPU status tool tip.
Show network status only for connected devices, such as an active ethernet link or associated wireless interface. If false, any network interface that has been brought up will be displayed.
Show memory usage status on task bar (Linux only).
Show network status on task bar (Linux only).
Show a button to collapse the taskbar.
Use double-height task bar.
Place workspace pager on left, not right.
Place workspace pager on top row when using dual-height taskbar.
Limit the number of taskbar workspaces buttons which are shown on the workspaces pane of the taskbar. If the numeric value has a "p" suffix then the limitation is in pixels. A "%" suffix limits by percentage of desktop width. By default a "B" suffix is assumed for number of buttons.
Enable mouse wheel cycling over workspaces and task buttons in taskbar.
Show a mini desktop preview on each workspace button.
Draw window icons inside large enough preview windows on pager (if PagerShowPreview=1).
Draw even minimized windows as unfilled rectangles (if PagerShowPreview=1).
Draw border around workspace buttons (if PagerShowPreview=1).
Show workspace name label on workspace button (if PagerShowPreview=1)
Show number of workspace on workspace button (if PagerShowPreview=1).
Execute taskbar applet commands (like MailCommand, ClockCommand, ...) on single click.
Enable address bar functionality in taskbar.
Show address bar in task bar.
Overrides automatic multiple byte detection.
Confirm logout.
Don't cut client windows by shapes set trough frame corner pixmap.
Use double buffering when redrawing the display.
Disable use of new XRANDR API for dual head (nvidia workaround).
Favour Xft fonts over core X11 fonts where possible.
A colon separated list of paths of your mailboxes. If this is empty, $MAILPATH or $MAIL is used instead.

Path to a mbox file. Remote mail boxes are accessed by specifying an URL using the Common Internet Scheme Syntax (RFC 1738):

    `scheme://[user[:password]@]server[:port][/path]`.

Supported schemes are "pop3", "imap" and "file". When the scheme is omitted file:// is prepended silently. IMAP subfolders can be accessed by using the path component. Reserved characters like slash ("/"), at ("@") and colon (":") can be specified using escape sequences with a hexadecimal encoding like %2f for the slash or %40 for the at sign. For example:

    file:///var/spool/mail/captnmark
    pop3://markus:%2f%40%3a@maol.ch/
    imap://mathias@localhost/INBOX.Maillisten.icewm-user
Network device for which to show status.
The clock time format. See the strftime manpage for the meaning of all the percent options. It is possible to define multiple clocks for different time zones in a single TimeFormat. A new clock is defined by the beginning of the string, and by each time zone specification which starts with "TZ=...", followed by a space. For example, TimeFormat="%X TZ=Asia/Aden %T TZ=Asia/Baku %T" defines 3 clocks.
Alternate Clock Time format shown every other second.
Clock Date format for tooltip (strftime format string).
Support DockApps (right, left, center, down, high, above, below, desktop, or empty to disable). Control with Ctrl+Mouse.
Screen/output name of the primary screen.
List of battery names (directories) in /proc/acpi/battery to ignore. Useful when more slots are built-in, but only one battery is used.
The width of the CPU Monitor applet in pixels.
The width of the Memory Monitor applet in pixels.
The width of the Net Monitor applet in pixels.
Default number of tasks in taskbar.
Task bar width as percentage of the screen width.
Taskbar justify left, right or center.
Width of battery Monitor.
Primary screen for xinerama (taskbar, ...).
A comma-separated list of keyboard layouts. A layout may be enclosed in double quotes. Each layout is a name with optional arguments, which is to be parsed by the "setxkbmap" program. To support changing keyboard layouts, the "setxkbmap" program must be installed. The first in the list is the default layout. Programs may have their own keyboard layout defined in the winoptions file. The first two letters of a layout are used to locate an icon image file.

MENUS

Reload menu files automatically.
Show programs submenu.
Show settings submenu.
Show focus mode submenu.
Show themes submenu.
Show logout menu.
Show the help menu item.
Show logout submenu.
Show the about menu item.
Show the run menu item.
Show the window menu item.
Maximal width of popup menus, 2/3 of the screen's width if set to zero.
Minimal number of themes after which the Themes menu becomes nested (0=disabled).

TIMINGS

Delay fuzziness, to allow merging of multiple timer timeouts into one (notebook power saving).
Pointer motion distance before click gets interpreted as drag.
Delay before click gets interpreted as drag.
Multiple click time.
Delay before activating menu items.
Delay before activating menu submenus.
Show an application icon in toolbar and tray tooltips.
Delay before tooltip window is displayed.
Time before tooltip window is hidden (0 means never.
Delay before task bar is hidden.
Delay before task bar is shown.
Delay before windows are auto raised if "AutoRaise=1".
Delay for pointer focus switching.
Screen edge workspace switching delay.
Initial scroll bar autoscroll delay.
Scroll bar autoscroll delay.
Auto scroll start delay.
Auto scroll delay.
Time before workspace status window is hidden.
Delay between new-mail checks. (seconds).
Delay between CPU Monitor samples in ms.
Delay between Memory Monitor samples in ms.
Delay between Net Monitor samples in ms.
Number of seconds the taskbar app will blink when requesting focus (0 = forever).
Taskbar blink interval (ms) when requesting focus (0 = blinking disabled).
Delay between power status updates (seconds).
Timeout in seconds for applications to respond to the _NET_WM_PING protocol.

BUTTONS AND KEYS

Bitmask of root window button click to use in window manager.
Bitmask of buttons that raise the window when pressed.
Desktop mouse-button click to show the window list menu.
Desktop mouse-button click to show the window list
Desktop mouse-button click to show the root menu.
Title bar mouse-button double click to maximize the window to full screen with the frame border visible. Press Shift to maximize only in the vertical direction. Press Alt+Shift to maximize only in the horizontal direction.
Title bar mouse-button double click to rollup the window. Press Shift to maximize in the horizontal direction.

WORKSPACES

Create four workspaces with names 1 , 2 , 3 and 4 .

PATHS

Icon search path (colon separated). Also, the icons/ subdirectory in IceWM resource folders are searched first.
List of icon themes (colon separated), acting as additional filter of icon subdirectories in any of the IconPath folders. Expressions can be wildcards, also special wildcards (starting with -) can exclude matched themes from selection.
A colon separated list of paths of your mailboxes. If this is empty, $MAILPATH or $MAIL is used instead.

PROGRAMS

Command to run on mailbox.
WM_CLASS to allow runonce for MailCommand.
Command to run when new mail arrives.
Command to lock display/screensaver.
Command to run on clock.
WM_CLASS to allow runonce for ClockCommand.
Command to select and run a program.
Open command.
Terminal emulator must accept -e option.
Command to start logout.
Command to cancel logout.
Command to shutdown the system.
Command to reboot the system.
Command to send the system to standby mode
Command to run on CPU status.
WM_CLASS to allow runonce for CPUStatusCommand.
Combine all CPUs to one.
Command to run on Net status.
WM_CLASS to allow runonce for NetStatusCommand.
Command to run for address bar entries.

WINDOW MENUS

Items supported in menu window (rmsnxfhualytieckw)
Does it support the 'O' title bar button images (for mouse rollover).
Show application icon over menu button

THEME SETTINGS

The following sections show settings that can be set in theme files. They can also be set in the preferences file, but themes will override the values set there. To override the theme values, the settings should be set in prefoverrides file: see icewm-prefoverrides(5). Default values are shown following the equal sign.

THEME DESCRIPTION

Theme author, e-mail address, credits.
Description of the theme, credits.
Choose a theme look from one of: "win95", "motif", "warp3", "warp4", "nice", "metal2", "gtk2", and some others.
List of gradient pixmaps in the current theme.

THEME BORDERS, ICONS, MARGINS AND BUTTONS

Horizontal window border.
Vertical window border.
Horizontal dialog window border.
Vertical dialog window border.
Resize corner width.
Resize corner height.
Title bar height.
Justification of the window title.
Horizontal offset for the window title text.
Vertical offset for the window title text.
Vertical offset for the menu button icon.
Scrollbar width.
Scrollbar (button) height.
Menu icon size.
Dimension of the small icons.
Dimension of the large icons.
Dimension of the large icons.
Horizontal margin of the quickswitch window.
Vertical margin of the quickswitch window.
Vertical margin in the quickswitch window.
Distance between the active icon and it's border.
Height of the separator between (all reachable) icons and text, 0 to avoid it.
Titlebar buttons from left to right (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth).
Titlebar buttons from right to left (x=close, m=max, i=min, h=hide, r=rollup, s=sysmenu, d=depth).
Titlebar buttons supported by theme (x,m,i,r,h,s,d).
Draw window title centered (obsoleted by TitleBarJustify).
Join title*S and title*T.
Join title*T and title*B.
Task bar clock/battery monitor uses nice pixmap LCD display (but then it doesn't display correctly in many languages anymore, e.g., for Japanese and Korean it works only when a real font is used and not the LCD pixmaps.
Height of taskbar monitoring applets.
Width of taskbutton side icons.
Maximum scaled width of tray icons.
Maximum scaled height of tray icons.
Surround the tray with plastic border.

THEME FONTS

Name of the title bar font.
Name of the menu font.
Name of the status display font.
Name of the font for Alt+Tab switcher window.
Name of the normal button font.
Name of the active button font.
Name of the normal task bar item font.
Name of the active task bar item font.
Name of the tool button font (fallback: NormalButtonFontName).
Name of the normal workspace button font (fallback: NormalButtonFontName).
Name of the active workspace button font (fallback: ActiveButtonFontName).
Name of the mini-window font.
Name of the window list font.
Name of the tool tip font.
Name of the task bar clock font.
Name of the task bar temperature font.
Name of the task bar battery font.
Name of the input field font.
Name of the label font.

THEME COLORS

Background of dialog windows.
Border of inactive windows.
Border of active windows.
Background of regular buttons.
Text color of regular buttons.
Background of pressed buttons.
Text color of pressed buttons.
Background of titlebar buttons.
Text color of titlebar buttons.
Background of toolbar buttons, ColorNormalButton is used if empty.
Text color of toolbar buttons, ColorNormalButtonText is used if empty.
Background of workspace buttons, ColorNormalButton is used if empty.
Text color of workspace buttons, ColorNormalButtonText is used if empty.
Background of the active workspace button, ColorActiveButton is used if empty.
Text color of the active workspace button, ColorActiveButtonText is used if empty.
Background of the titlebar of regular windows.
Text color of the titlebar of regular windows.
Text shadow of the titlebar of regular windows.
Background of the titlebar of active windows.
Text color of the titlebar of active windows.
Text shadow of the titlebar of active windows.
Background for mini icons of regular windows.
Text color for mini icons of regular windows.
Background for mini icons of active windows.
Text color for mini icons of active windows.
Background of pop-up menus.
Text color of regular menu items.
Background of selected menu item, leave empty to force transparency.
Text color of selected menu items.
Text color of disabled menu items.
Shadow of regular menu items.
Background of move/resize status window.
Text color of move/resize status window.
Background of the quick switch window.
Text color in the quick switch window.
Rectangle around the active icon in the quick switch window.
Background of the taskbar.
Background for task buttons of regular windows.
Text color for task buttons of regular windows.
Background for task buttons of the active window.
Text color for task buttons of the active window.
Background for task buttons of minimized windows.
Text color for task buttons of minimized windows.
Background for task buttons of windows on other workspaces.
Text color for task buttons of windows on other workspaces.
Scrollbar background (sliding area).
Background of the slider button in scrollbars.
Background of the arrow buttons in scrollbars.
Background of the arrow buttons in scrollbars (obsolete).
Color of active arrows on scrollbar buttons.
Color of inactive arrows on scrollbar buttons.
Background of listboxes.
Text color in listboxes.
Background of selected listbox items.
Text color of selected listbox items.
Background of tooltips.
Text color of tooltips.
Background of labels, leave empty to force transparency.
Text color of labels.
Background of text entry fields (e.g., the addressbar).
Text color of text entry fields (e.g., the addressbar).
Background of selected text in an entry field.
Selected text in an entry field.
Background of non-LCD clock, leave empty to force transparency.
Text color of non-LCD clock.
Color of keyboard layout indicator.
Background of battery monitor, leave empty to force transparency.
Text color of battery monitor.
Color of battery monitor when discharging.
Color of battery monitor when charging.
Background color for graph mode.
User load on the CPU monitor.
System load on the CPU monitor.
Interrupts on the CPU monitor.
IO Wait on the CPU monitor.
Soft Interrupts on the CPU monitor.
Nice load on the CPU monitor.
Idle (non) load on the CPU monitor, leave empty to force transparency.
Involuntary Wait on the CPU monitor.
Temperature of the CPU.
User program usage in the memory monitor.
OS buffers usage in the memory monitor.
OS cached usage in the memory monitor.
Free memory in the memory monitor.
Outgoing load on the network monitor.
Incoming load on the network monitor.
Idle (non) load on the network monitor, leave empty to force transparency.
Desktop background color(s).
Color(s) to announce for semitransparent windows.

DESKTOP BACKGROUND

The following preferences are read by icewmbg(1):

Display desktop background centered and not tiled.
Resize desktop background to full screen.
Desktop background color(s).
Desktop background image(s).
Choose a random selection from the list of background images.
Support for semitransparent terminals like Eterm or gnome-terminal.
Color(s) to announce for semitransparent windows.
Image(s) to announce for semitransparent windows.
Paint the background image over all multihead monitors combined.
Seconds between cycling over all background images, default zero is off.

EXAMPLES

    Alpha=1
    Splash="IceWM.jpg"
    LimitSize=0
    LimitPosition=0
    LimitByDockLayer=1
    QuickSwitchToAllWorkspaces=1
    QuickSwitchHugeIcon=1
    QuickSwitchFillSelection=1
    TaskBarMailboxStatusBeepOnNewMail=1
    TaskBarMailboxStatusCountMessages=1
    TaskBarShowMEMStatus=0
    TaskBarShowCollapseButton=1
    TaskBarWorkspacesLimit="8"
    ShowProgramsMenu=1
    ShowAddressBar=0
    ToolTipDelay=200
    ToolTipTime=5000
    AutoHideDelay=900
    AutoShowDelay=100
    EdgeResistance=3
    KeySysWinMenu=""
    KeySysWinListMenu="Shift+Ctrl+Esc"

The above example shows how to tell icewm to not bind a specific key: KeySysWinMenu in this case.

FILES

Locations for the preferences file are as follows:

 $ICEWM_PRIVCFG/preferences
 $XDG_CONFIG_HOME/icewm/preferences
 $HOME/.icewm/preferences
 /etc/X11/icewm/preferences
 /usr/share/icewm/preferences

The locations are searched in the order listed; the first file found is read and the remainder ignored.

SEE ALSO

icewm(1), icewm-prefoverride(5).

AUTHOR

Brian Bidulock <mailto:bidulock@openss7.org>.

LICENSE

IceWM is licensed under the GNU Library General Public License. See the COPYING file in the distribution.

2023-02-05 icewm 3.3.1