Print usage text.

This option specifies the X server to use.

This option indicates that it is not an error if a window manager is already running. In that case, the existing window manager is asked to quit, and ctwm takes its place. Available only if ctwm is built with the \f(CRUSE_EWMH flag. First appeared in 4.0.0.

This option indicates that only the default screen (as specified by \f(CR--display or by the \f(CRDISPLAY environment variable) should be managed. By default, ctwm will attempt to manage all screens on the display.

This option causes ctwm to only try to parse the config file, and indicate whether errors are found.

This option causes ctwm to print out the compiled-in fallback config. First appeared in 4.0.0.

This option specifies the name of the startup file to use. ctwm will first try to load filename.num, where \f(CRnum is the screen number. If it fails, it will try to load filename. By default, ctwm will look in the user\(cqs home directory for files named \f(CR.ctwmrc.num, \f(CR.ctwmrc, \f(CR.twmrc.num, or \f(CR.twmrc (where \f(CRnum is a screen number).

This option indicates that ctwm should print error messages whenever an unexpected X Error event is received. This can be useful when debugging applications but can be distracting in regular use.

Disables \f(CR--verbose (useful for overriding aliases, etc).

This option indicates that ctwm should not filter the startup file through \f(CRm4. Available only if ctwm is built with the \f(CRUSE_M4 flag.

This option indicates that ctwm should keep the definitions it prepends to your startup file when filtering through \f(CRm4 in /tmp. Available only if ctwm is built with the \f(CRUSE_M4 flag.

This option indicates that ctwm should keep the result of filtering your startup file through \f(CRm4 in the named file. Available only if ctwm is built with the \f(CRUSE_M4 flag.

Run in monochrome mode.

ctwm just prints its version number.

ctwm prints its detailed version and compile time options.

This option tells ctwm not to display any welcome when starting.

Something to do with session management

Ignored.

The \f(CRscreennumber is a small positive number (e.g. 0, 1, etc.) representing the screen number (e.g. the last number in the DISPLAY environment variable \f(CRhost:displaynum.screennum) that would be used to contact that screen of the display. This is intended for displays with multiple screens of differing visual types.

This is the usual name for an individual user\(cqs startup file.

The users twm startup file.

If none of the preceding files are found, ctwm will look in this file for a default configuration. This is often tailored by the site administrator to provide convenient menus or familiar bindings for novice users.

This variable is set to the name of the machine that is running the X server.

The machine that is running the clients. (ie, ctwm)

As of 4.0.2, this is a duplicate of \f(CRCLIENTHOST. In prior versions, \f(CRgethostbyname() was used to attempt to derive a canonical or fully-qualified version of the hostname.

The name of the user running the program. Value taken from environmental variables \f(CR$USER and \f(CR$LOGNAME, or from the passwd lookup for your uid if they don\(cqt exist. Falls back to "unknown" if all methods fail.

The user\(cqs home directory. Gotten from the environment var \f(CR$HOME.

Tells which \f(CRtwm offshoot is running. It will always be set to the string "ctwm" in this program. This is useful for protecting parts of your \f(CR.twmrc file that twm proper won\(cqt understand (like \f(CRWorkSpaces) so that it is still usable with other \f(CRtwm programs.

Tells which ctwm version is running in the form of a floating point number.

Gives the ctwm version split out. e.g., for a version like "3.8.2-beta1", the \f(CR_MAJOR will be "3", \f(CR_MINOR "8", \f(CR_PATCH "2", and \f(CR_ADDL "-beta1". Final releases will generally have an empty \f(CRCTWM_VERSION_ADDL; it\(cqs mostly meaningful in dev and betas. For comparison, in this situation, TWM_VERSION will be "3.8.2". The \f(CRCTWM_VERSION_* variables first appeared in 4.0.0.

The X major protocol version. As seen by ProtocolVersion(3).

The X minor protocol revision. As seen by ProtocolRevision(3).

The vendor of your X server. For example: \f(CRMIT X Consortium.

The release number of your X server. For MIT X11R5, this is \f(CR5.

The width of your display in pixels.

The height of your display in pixels.

The X resolution of your display in pixels per meter.

The Y resolution of your display in pixels per meter.

The number of bit planes your display supports in the default root window.

The number of significant bits in an RGB color. (log base 2 of the number of distinct colors that can be created. This is often different from the number of colors that can be displayed at once.)

Your visual class. Will return one of \f(CRStaticGray, \f(CRGrayScale, \f(CRStaticColor, \f(CRPseudoColor, \f(CRTrueColor, \f(CRDirectColor, or, if it cannot determine what you have, \f(CRNonStandard.

This will be either "Yes" or "No". This is just a wrapper around the above definition. Returns "Yes" on \f(CR*Color, and "No" on \f(CRStaticGray and \f(CRGrayScale.

Is defined only if ctwm was compiled with XPM support.

The directory where the ctwm pictures are installed.

Is defined only if ctwm was compiled with JPEG support.

Is defined only if ctwm was compiled with SOUND support.

Is defined only if ctwm was compiled with EWMH support. First appeared in 4.0.0.

Is defined if ctwm was compiled with I18N support. This is no longer optional since 3.8 and is always compiled in. The definition will be removed in a future version.

Defined when ctwm was compiled with GNOME1 support. Removed after 3.8.2.

This was either "Yes" or "No". "Yes" if the current ctwm is captive (flag -w), "No" in the other case. Removed in 4.1.0.

Defined only if TWM_CAPTIVE is also defined. Contains the name of the captive ctwm (flag --name). Removed in 4.1.0.

This variable specifies a list of windows (all windows if the list is defaulted) that ctwm will try its best to maintain on top of others. This doesn\(cqt work in all case.

When \f(CRReallyMoveInWorkspaceManager is present and the user is moving a window from the WorkSpaceMap, ctwm display the actual window only if it crosses the current active workspace. If \f(CRAlwaysShowWindowWhenMovingFromWorkspaceManager is present, the actual window is always visible during the move, regardless of whether it crosses the current workspace or not. The Shift key toggles this behaviour.

This variable indicates that ctwm should obey window gravity when squeezing a window even when the window has a titlebar. Normally, ctwm will always squeeze a window that has a titlebar toward the north. The optional \f(CRwin-list may be used to control which windows this applies on.

The \f(CRspeed argument is a non-negative integer. It determines the number of times a second animations (if any) are updated. If \f(CRspeed is 0, animations are freezed. The default value is 0.

Transient windows get focus automatically when created. Useful with programs that have keyboard shortcuts that pop up windows.

This variable specifies a list of windows (all windows if the list is defaulted) to be automatically lowered whenever the pointer leaves a window. This action can be interactively enabled or disabled on individual windows using the function \f(CRf.autolower.

This variable specifies that clients will automatically change their occupation when their name or icon name changes. The new occupation will be recalculated from the Occupy and OccupyAll fields in the \f(CR.ctwmrc file.

This variables specifies a list of windows which will be deiconified whenever their name changes. Can be used for xconsole, for instance,which adds a "*" to its name whenever something gets displayed on the console, or for various mail readers who change their icons depending on the presence of unread mail. First appeared in 4.0.0.

This variable specifies that ctwm should automatically recompute the priority of a window (and its associated icon) when its name changes. See also \f(CROnTopPriority. First appeared in 4.0.0.

This variable specifies a list of windows (all windows if the list is defaulted) to be automatically raised whenever the pointer has come to rest in a window for the amount of time specified by the \f(CRRaiseDelay variable. This action can be interactively enabled or disabled on individual windows using the function \f(CRf.autoraise.

Icons are raised when the cursor enters it. Useful with ShrinkIconTitles.

This variable indicates that dragging out a window size (either when initially sizing the window with pointer Button2 or when resizing it) should not wait until the pointer has crossed the window edges. Instead, moving the pointer automatically causes the nearest edge or edges to move by the same amount. This allows the resizing of windows that extend off the edge of the screen. If the pointer is in the center of the window, or if the resize is begun by pressing a titlebutton, ctwm will still wait for the pointer to cross a window edge (to prevent accidents). This option is particularly useful for people who like the press-drag-release method of sweeping out window sizes.

These windows will be auto-squeezed (see f.squeeze). i.e. automatically unsqueezed when they get focus, and squeezed when they loose it. Useful for the workspace manager. Not authorized for icon managers.

Enable usage of backing store on menus and workspace map windows. See also \f(CRNoBackingStore. Added in 4.0.0; in previous versions this was the default.

By defaults new colors are allocated for shadows when a 3D look is used, but when you specify \f(CRBeNiceToColormap ctwm uses stipling instead of new colors, the effect is less beautiful, but acceptable. In this case ClearShadowContrast and DarkShadowContrast have no effects.

This variable specifies the width in pixels of a forbidden zone at the bottom of the screen. All constrained window functions (f.movepack, f.move with DontMoveOff, etc...) will consider this zone as offscreen. Default is 0.

This variable specifies the default color of the border to be placed around all non-iconified windows, and may only be given within a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwincolorlist specifies a list of window and color name pairs for specifying particular border colors for different types of windows. For example:

.fam C
BorderColor "gray50"
{
 "XTerm" "red"
 "xmh" "green"
}
.fam

This variable specifies the width in pixels of a forbidden zone at the left of the screen. All constrained window functions (f.movepack, f.move with DontMoveOff, etc...) will consider this zone as offscreen. Default is 0.

This variable specifies that ctwm should use resizing cursors when the pointer is on the window border. To be used preferably when you have bound a button to f.resize in the frame context.

This variable specifies the width in pixels of a forbidden zone at the right of the screen. All constrained window functions (f.movepack, f.move with DontMoveOff, etc...) will consider this zone as offscreen. Default is 0.

This variable specifies the depth of the shadow ctwm uses for 3D window borders, when UseThreeDBorders is selected.

This variable specifies the default background color in the gray pattern used in unhighlighted borders (only if \f(CRNoHighlight hasn\(cqt been set), and may only be given within a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwincolorlist allows per-window colors to be specified. The default is "white".

This variable specifies the default foreground color in the gray pattern used in unhighlighted borders (only if \f(CRNoHighlight hasn\(cqt been set), and may only be given within a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwincolorlist allows per-window colors to be specified. The default is "black".

This variable specifies the width in pixels of a forbidden zone at the top of the screen. All constrained window functions (f.movepack, f.move with DontMoveOff, etc...) will consider this zone as offscreen. Default is 0.

This variable specifies the width in pixels of the border surrounding all client window frames if \f(CRClientBorderWidth has not been specified. This value is also used to set the border size of windows created by ctwm (such as the icon manager). The default is 2.

This variable specifies the amount by which titlebuttons should be indented on all sides. Positive values cause the buttons to be smaller than the window text and highlight area so that they stand out. Setting this and the \f(CRTitleButtonBorderWidth variables to 0 makes titlebuttons be as tall and wide as possible. The default is 1 if \f(CRUseThreeDTitles is not set, 0 if it is set.

The moving and resizing information window is centered in the middle of the screen instead of the top left corner.

Indicates to ctwm how to calculate the clear shadow color for 3D items. The value is a comprised between 0 and 100. The formula used is :

.fam C
 clear.{RGB} = (65535 - color.{RGB}) * (contrast / 100).
.fam

Focus windows by clicking on them, rather than merely mousing over them.

This variable indicates that border width of a window\(cqs frame should be set to the initial border width of the window, rather than to the value of \f(CRBorderWidth. If \f(CRUse3DBorders is set this variable is automatically unset.

This variable specifies a list of color assignments to be made if the default display is capable of displaying more than simple black and white. The \f(CRcolors-list is made up of the following color variables and their values: \f(CRDefaultBackground, \f(CRDefaultForeground, \f(CRMenuBackground, \f(CRMenuForeground, \f(CRMenuTitleBackground, \f(CRMenuTitleForeground, and \f(CRMenuShadowColor. The following color variables may also be given a list of window and color name pairs to allow per-window colors to be specified (see \f(CRBorderColor for details): \f(CRBorderColor, \f(CRIconManagerHighlight, \f(CRBorderTileBackground, \f(CRBorderTileForeground, \f(CRTitleBackground, \f(CRTitleForeground, \f(CRIconBackground, \f(CRIconForeground, \f(CRIconBorderColor, \f(CRIconManagerBackground, and \f(CRIconManagerForeground. For example:

.fam C
Color
{
 MenuBackground "gray50"
 MenuForeground "blue"
 BorderColor "red" { "XTerm" "yellow" }
 TitleForeground "yellow"
 TitleBackground "blue"
}
.fam

This variable specifies the length of time between button clicks needed to begin a constrained move operation. Double clicking within this amount of time when invoking \f(CRf.move or other similar moving functions will cause the window only be moved in a horizontal or vertical direction. Setting this value to 0 will disable constrained moves. The default is 400 milliseconds. Note that this also affects double clicking in \f(CRf.raiseorsqueeze, and potentially other places that need to track double clicks. It should probably be renamed.

This variable specifies the glyphs that ctwm should use for various pointer cursors. Each cursor may be defined either from the \f(CRcursor font or from two bitmap files. Shapes from the \f(CRcursor font may be specified directly as:

.fam C
 cursorname "string"
.fam

.fam C
 cursorname "image" "mask"
.fam

.fam C
Cursors
{
 Frame "top_left_arrow"
 Title "top_left_arrow"
 Icon "top_left_arrow"
 IconMgr "top_left_arrow"
 Move "fleur"
 Resize "fleur"
 Menu "sb_left_arrow"
 Button "hand2"
 Wait "watch"
 Select "dot"
 Destroy "pirate"
}
.fam

Indicates to ctwm how to calculate the dark shadow color for 3D items. The value is a comprised between 0 and 100. The formula used is :

.fam C
 dark.{RGB} = color.{RGB} * ((100 - contrast) / 100),
.fam

This variable indicates that transient windows (those containing a \f(CRWM_TRANSIENT_FOR property) should have titlebars. As of 4.0.0 this is the default.

This variable specifies the background color to be used for sizing and information windows. The default is "white".

This variable specifies the foreground color to be used for sizing and information windows. The default is "black".

This variable specifies a list of windows that should not be iconified by simply unmapping the window (as would be the case if \f(CRIconifyByUnmapping had been set). This is frequently used to force some windows to be treated as icons while other windows are handled by the icon manager.

This variable indicates that windows should not be allowed to be moved off the screen. It can be overridden by the \f(CRf.forcemove function.

Disable setting \f(CRWM_NAME properties on the various decoration windows ctwm puts around the windows it manages. These are handy to keep track of what\(cqs what when poking through the list of windows on the screen, but can confuse some tools that don\(cqt expect to find them there (xwit is known to be one of them). First appeared in 4.0.2.

This variable tells ctwm not to paint the root window, whatever you told in the Workspaces specification. This is useful to have pixmaps in the Workspace Map but not on the root window.

These windows won\(cqt have their characteristics saved for the session manager.

These windows won\(cqt be set to InactiveState when they become invisible due to a change workspace. This has been added because some ill-behaved clients (Frame5) don\(cqt like this.

Indicates the same as the \f(CR-W option: the welcome window is not shown.

This variable indicates that titlebars should not be squeezed to their minimum size as described under \f(CRSqueezeTitle below. If the optional window list is supplied, only those windows will be prevented from being squeezed.

Turns off the feature toggling the workspace manager state to/from map/button state when you press ctrl and the workspace manager window is in focus.

Tells ctwm not to warp the cursor to the corresponding actual window when you click in a small window in the workspace map.

Sets EWMH message types that ctwm will ignore. This is only valid if built with \f(CRUSE_EWMH (currently on by default). The following example shows all the valid options:

.fam C
EWMHIgnore
{
 # Window states
 "STATE_MAXIMIZED_VERT"
 "STATE_MAXIMIZED_HORZ"
 "STATE_FULLSCREEN"
 "STATE_SHADED"
 "STATE_ABOVE"
 "STATE_BELOW"
}
.fam

Give focus to windows whether they asked for it or not. This may occasionally be useful with windows that tell us not to give them focus, but still need it and fail to work right without us doing so. The optional window list allows specifying which windows will get such treatment. First appeared in 4.0.0. In prior versions, a variant of this functionality was unconditionally enabled.

This variable indicates that icon pixmaps specified in the \f(CRIcons variable should override any client-supplied pixmaps.

This variable specifies the distance between the titlebar decorations (the button and text) and the window frame. The default is 2 pixels if \f(CRUseThreeDTitles is not set, 0 if it is set.

Specifies that ctwm should grab the X server (blocking all events other than ours) when popping up menus and moving opaque windows. See also \f(CRNoGrabServer. Added in 4.0.0; in previous versions this was the default.

This variable specifies the background color of icons, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "white".

This variable specifies the color of the border used for icon windows, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "black".

This variable specifies the width in pixels of the border surrounding icon windows. The default is 2.

This variable specifies the directory that should be searched if a bitmap file cannot be found in any of the directories in the \f(CRbitmapFilePath resource.

This variable specifies the font to be used to display icon names within icons. The default is "variable".

This variable specifies the foreground color to be used when displaying icons, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "black".

This variable indicates that windows should be iconified by being unmapped without trying to map any icons. This assumes that the user is will remap the window through the icon manager, the \f(CRf.warpto function, or the \f(CRTwmWindows menu. If the optional \f(CRwin-list is provided, only those windows will be iconified by simply unmapping. Windows that have both this and the \f(CRIconManagerDontShow options set may not be accessible if no binding to the \f(CRTwmWindows menu is set in the user\(cqs startup file.

Where string is either \f(CR"normal", \f(CR"mosaic", \f(CR"zoomin", \f(CR"zoomout" or \f(CR"sweep". Tells ctwm to use some fancy graphical effects when iconifying windows.

Where string is either \f(CR"left", \f(CR"center" or \f(CR"right". Tells ctwm how to justify the icon image against the icon title (if any).

This variable specifies the background color to use for icon manager entries, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "white".

This variable indicates that the icon manager should not display any windows. If the optional \f(CRwin-list is given, only those windows will not be displayed. This variable is used to prevent windows that are rarely iconified (such as \f(CRxclock or \f(CRxload) from taking up space in the icon manager.

This variable specifies the font to be used when displaying icon manager entries. The default is "variable".

This variable specifies the foreground color to be used when displaying icon manager entries, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "black".

This variable specifies the geometry of the icon manager window. The \f(CRstring argument is standard geometry specification that indicates the initial full size of the icon manager. The icon manager window is then broken into \f(CRcolumns pieces and scaled according to the number of entries in the icon manager. Extra entries are wrapped to form additional rows. The default number of columns is 1. When XrandR is compiled, the geometry can be relative to a monitor, by prefixing its name (visible with \f(CRxrandr(1) command line) followed by \f(CR:. This name is ignored when XrandR is not available.

This variable specifies the border color to be used when highlighting the icon manager entry that currently has the focus, and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. See the \f(CRBorderColor variable for a complete description of the \f(CRwin-list. The default is "black".

This variable specifies a list of icon managers to create. Each item in the \f(CRiconmgr-list has the following format:

.fam C
 "winname" ["iconname"] "geometry" columns
.fam

.fam C
IconManagers
{
 "XTerm" "=300x5+800+5" 5
 "myhost" "HDMI2:400x5+100+5" 2
}
.fam

This variable specifies the depth of the shadow ctwm uses for 3D IconManager entries, when UseThreeDIconManagers is selected.

This variable specifies a list of windows that should appear in the icon manager. When used in conjunction with the \f(CRIconManagerDontShow variable, only the windows in this list will be shown in the icon manager.

Don\(cqt show the name of these windows in the TwmIcons menu.

This variable specifies an area on the root window in which icons are placed if no specific icon location is provided by the client. The \f(CRgeomstring is a quoted string containing a standard geometry specification. When XrandR is compiled, the geometry can be relative to a monitor, by prefixing its name (visible with \f(CRxrandr(1) command line) followed by \f(CR:. This name is ignored when XrandR is not available. If more than one \f(CRIconRegion lines are given, icons will be put into the succeeding icon regions when the first is full. The \f(CRvgrav argument should be either \f(CRNorth or \f(CRSouth and is used to control whether icons are first filled in from the top or bottom of the icon region. Similarly, the \f(CRhgrav argument should be either \f(CREast or \f(CRWest and is used to control whether icons should be filled in from left or from the right. Icons are laid out within the region in a grid with cells \f(CRgridwidth pixels wide and \f(CRgridheight pixels high. The optional win-list argument tells ctwm that if such a window is iconified, and there is enough room in this icon region for its icon, then place it here. The optional \f(CRiconjust, \f(CRiconregjust and \f(CRiconregalign can be used to give specific values of IconJustification, IconRegionJustification and IconRegionAlignement for this IconRegion.

Where string is either \f(CR"top", \f(CR"center" \f(CR"bottom" or \f(CR"border". Tells ctwm how to align icons inside their place in the IconRegion. If "border" is given, the justification will be "top" if the icon region gravity is "north" and "bottom" if the icon region gravity is "south".

Where string is either \f(CR"left", \f(CR"center" \f(CR"right" or \f(CR"border". Tells ctwm how to justify icons inside their place in the IconRegion. If "border" is given, the justification will be "left" if the icon region gravity is "west" and "right" if the icon region gravity is "east".

This variable specifies a list of window names and the bitmap filenames that should be used as their icons. For example:

.fam C
Icons
{
 "XTerm" "xterm.icon"
 "xfd" "xfd_icon"
}
.fam

(Only if built with \f(CRUSE_EWMH) string is of the form "\f(CR<width>x<height>" or "\f(CRsize" for a square size. This indicates the preferred size of icons selected from the EWMH window property \f(CR_NET_WM_ICON. If an icon with the exact size is not available, one with the nearest (area) size will be chosen. First appeared in 4.0.0.

Used when moving the pointer inside a menu with the keyboard. When you type a letter, the pointer goes to the next entry beginning with this letter. If IgnoreCaseInMenuSelection is present, this selection ignores the case of this first letter.

If present, all bindings (buttons and keys) will ignore the LockMask. Useful if you often use caps lock, and don\(cqt want to define twice all your bindings.

All bindings (buttons and keys) will ignore the modifiers you specified. It is useful when you use caps locks or num locks. You don\(cqt need IgnoreLockModifier any more with this option.

.fam C
IgnoreModifier { lock m2 }
.fam

List of windows for which to ignore transients.

.fam C
IgnoreTransient { "Wine" }
.fam

This variable indicates that menu entry colors should be interpolated between entry specified colors. In the example below:

.fam C
Menu "mymenu"
{
 "Title" ("black":"red") f.title
 "entry1" f.nop
 "entry2" f.nop
 "entry3" ("white":"green") f.nop
 "entry4" f.nop
 "entry5" ("red":"white") f.nop
}
.fam

This variable specifies a list of windows on which a titlebar should be placed and is used to request titles on specific windows when \f(CRNoTitle has been set.

This variable specifies the background colors to use for small windows in the workspace map window and may only be specified inside of a Color or Monochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. If there is neither MapWindowBackground, nor MapWindowForeground the window title colors are used.

Specify the appearence of the map window corresponding to the current workspace.

Specify the appearence of the map window corresponding to the workspaces other than the current workspace when no root background information has been provided to ctwm in the WorkSpace command. Not used in others cases.

This variable specifies the foreground colors to use for small windows in the workspace map window and may only be specified inside of a Color or Monochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. If there is neither MapWindowBackground, nor MapWindowForeground the window title colors are used.

The integer argument tells ctwm the maximun width to use for an icon title. If an icon title is larger than \f(CRwidth, it is truncated.

This variable specifies a geometry in which the width and height give the maximum size for a given window. This is typically used to restrict windows to the size of the screen. The default is "30000x30000".

This variable specifies the background color used for menus, and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The default is "white".

This variable specifies the font to use when displaying menus. The default is "variable".

This variable specifies the foreground color used for menus, and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The default is "black".

This variable specifies the color of the shadow behind pull-down menus and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The default is "black".

This variable specifies the depth of the shadow ctwm uses for 3D menus, when UseThreeDMenus is selected.

This variable specifies the background color for \f(CRf.title entries in menus, and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The default is "white".

This variable specifies the foreground color for \f(CRf.title entries in menus and can only be specified inside of a \f(CRColor or \f(CRMonochrome list. The default is "black".

This allows manually configuring what ctwm will consider as the list of monitors. If \f(CRXRANDR support is compiled in (the default as of 4.1.0), and the \f(CRRANDR extension is available on your server, then \f(CRctwm will use that to determine the size and layout of your monitors. However, if either is not the case, or you want to override the results it returns, you can specify the names and layouts of your desired "monitors" with this. For instance, if you have a very wide monitor, and would prefer to treat it as several narrower side-by-side monitors, you could use this to tell ctwm to treat it that way.

.fam C
MonitorLayout
{
 # Imagine a 5000x1000 monitor, that we want to split into two 2k wide
 # sections at the far left and right, with a 1k wide section in the
 # middle.
 "Left:2000x1000+0+0"
 "1000x1000+2000+0" # Middle section unnamed
 "Right:2000x1000+3000+0"
}
.fam

.fam C
define(LeftWidth, eval(WIDTH / 2))dnl
define(RightWidth, eval(WIDTH - LeftWidth))dnl
MonitorLayout
{
 "`AutoL:\*(AqLeftWidth`x\*(AqHEIGHT`+0+0\*(Aq"
 "`AutoR:\*(AqRightWidth`x\*(AqHEIGHT`+\*(AqLeftWidth`+0\*(Aq"
}
.fam

This variable specifies a list of color assignments that should be made if the screen has a depth of 1. See the description of \f(CRColor.

This variable specifies the number of pixels the pointer must move before the \f(CRf.move function starts working. Also see the \f(CRf.deltastop function. The default is zero pixels.

This variable specifies the number of pixels of the movepack and movepush resistance. See \f(CRf.movepack and \f(CRf.movepush.

This variable specifies the number of pixels of the moveoff resistance. If \f(CRpixels is positive, \f(CRDontMoveOff will only prevent you from going off the edge if you\(cqre within n pixels off the edge. If you go further, \f(CRDontMoveOff gives up and lets you go as far as you wish. \f(CRf.forcemove still allows you to totally ignore \f(CRDontMoveOff. A negative value puts you back into "never moveoff" mode (it\(cqs the default).

Sets Motif window manager hints ctwm will ignore. The following example shows all the valid options:

.fam C
MWMIgnore
{
 # en/disable window borders
 "DECOR_BORDER"

 # en/disable titlebars
 "DECOR_TITLE"
}
.fam

This variable indicates that ctwm\(cqs menus should not request backing store to minimize repainting of menus. This is typically used with servers that can repaint faster than they can handle backing store. See also \f(CRBackingStore. As of 4.0.0 this is the default.

These windows won\(cqt have borders. If you want no borders on all windows, use the BorderWidth keyword.

This variable indicates that case should be ignored when sorting icon names in an icon manager. This option is typically used with applications that capitalize the first letter of their icon name.

Specify that transient windows (i.e., windows with a \f(CRWM_TRANSIENT_FOR property set) should be ignored (not given decorations) by ctwm. See also \f(CRDecorateTransients. Added in 4.0.0; in previous versions this was the default.

This variable indicates that ctwm should not supply the default titlebuttons and bindings. This option should only be used if the startup file contains a completely new set of bindings and definitions.

This variable indicates that ctwm should not grab the server when popping up menus and moving opaque windows. As of 4.0.0 this is the default.

This variable indicates that borders should not be highlighted to track the location of the pointer. If the optional \f(CRwin-list is given, highlighting will only be disabled for those windows. When the border is highlighted, it will be drawn in the current \f(CRBorderColor. When the border is not highlighted, it will be stippled with an gray pattern using the current \f(CRBorderTileForeground and \f(CRBorderTileBackground colors.

This variable indicates that icons should not display the icon name of the client. If the optional \f(CRwin-list is given, only those clients will not have icon titles.

This variable indicates that ctwm will not set the focus on the corresponding window when the pointer is in an IconManager.

This variable indicates that no icon manager should be created.

This variable turns off displaying of background images in the WorkSpaceMap. Instead only the colors defined in \f(CRWorkSpaces will be used as background in the WorkSpaceMap.

This variable indicates that menus should not have drop shadows drawn behind them. This is typically used with slower servers since it speeds up menu drawing at the expense of making the menu slightly harder to read.

The counterpart of \f(CROpaqueMove. See \f(CROpaqueMove.

The counterpart of \f(CROpaqueResize. See \f(CROpaqueResize.

This variable indicates that windows that are deiconified should not be raised.

This variable indicates that windows should not be raised when moved. This is typically used to allow windows to slide underneath each other.

This variable indicates that windows should not be raised when resized. This is typically used to allow windows to be resized underneath each other.

This variable indicates that windows should not be raised when the pointer is warped into them with the \f(CRf.warpto function. If this option is set, warping to an occluded window may result in the pointer ending up in the occluding window instead the desired window (which causes unexpected behavior with \f(CRf.warpring).

Don\(cqt attempt to regenerate the state the screen was in before the previous window manager was shut down. See \f(CRRestartPreviousState for details. Added in 4.0.0; in previous versions this was the default.

This variable indicates that menus should not request save-unders to minimize window repainting following menu selection. It is typically used with displays that can repaint faster than they can handle save-unders.

This variable specifies that OccupyAll windows won\(cqt be displayed in the WorkSpaceMap window.

Specifies that entries in the icon manager should be appended in the order they show up. See also \f(CRSortIconManager. Added in 4.0.0; in previous versions this was the default.

This variable indicates that client window requests to change stacking order should be ignored. If the optional \f(CRwin-list is given, only requests on those windows will be ignored. This is typically used to prevent applications from relentlessly popping themselves to the front of the window stack.

This variable indicates that windows should not have titlebars. If the optional \f(CRwin-list is given, only those windows will not have titlebars. \f(CRMakeTitle may be used with this option to force titlebars to be put on specific windows.

This variable indicates that ctwm should not set keyboard input focus to each window as it is entered. Normally, ctwm sets the focus so that focus and key events from the titlebar and icon managers are delivered to the application. If the pointer is moved quickly and ctwm is slow to respond, input can be directed to the old window instead of the new. This option is typically used to prevent this "input lag" and to work around bugs in older applications that have problems with focus events.

This variable indicates that the highlight area of the titlebar, which is used to indicate the window that currently has the input focus, should not be displayed. If the optional \f(CRwin-list is given, only those windows will not have highlight areas. This and the \f(CRSqueezeTitle options can be set to substantially reduce the amount of screen space required by titlebars.

This variable indicates that the cursor should not be warped to the title of a menu which does not have room to drop down below the current cursor position.

This variable specifies which windows occupy which workspaces at startup. \f(CRoccupy-list consists of entries of the form :

.fam C
 [Window] win-name { wspc1 wspc2 ... }
or Workspace wspc-name { win1 win2 ... }
.fam

.fam C
Occupy
{
 "xload" {"all"}
 Window "xterm" {"here" "there" "elsewhere"}
 "xv" {"images"}
 WorkSpace "images" {"xloadimage"}
}
.fam

This variable specifies a list of windows that will occupy all workspaces at startup. \f(CRwindow-list is a list of window names. Example :

.fam C
OccupyAll
{
 "xload"
 "xbiff"
 "xconsole"
}
.fam

ctwm allows you to put windows in several overlapping priority planes going from -8 to +8, which makes it possible to have windows that stay on top or that are kept in the background. If \f(CRwin-list is present, it specifies which windows should be put in the \f(CRpriority plane. Else the \f(CRpriority sets the default value to use (the default default is 0). The \f(CRIcons parameter, if present, indicates that the preference described applies to icons rather than to windows. Example:

.fam C
OnTopPriority Icons -1 # place icons a little in the background
OnTopPriority Icons 1 # place mail icons on top of normal windows
{
 "Exmh"
 "xbiff"
}

OnTopPriority 8 # keep these always on top of other windows
{
 "Emacs Icon Manager" "WorkSpaceManager"
 "TWM Icon Manager" "XDaliClock"
}
.fam

This variable indicates that the \f(CRf.move function should actually move the window instead of just an outline so that the user can immediately see what the window will look like in the new position. This option is typically used on fast displays (particularly if \f(CRNoGrabServer is set). The optional window list parameter indicates that only windows in this list should actually be moved in opaque mode. The \f(CRNoOpaqueMove counterpart is also available. As of 4.0.0 this is enabled by default.

The integer parameter is a percentage and indicates that only windows (elligible for opaque moving) with a surface smaller than this percentage of the surface of the screen should actually be moved in opaque mode. The default is 200. Since 4.0.0, values >= 200 are treated as infinity, causing windows to always \f(CROpaqueMove if eligible.

The opaque version of resize. Extremely resource intensive, but beautiful with fast server/client/network. See \f(CROpaqueMove. The \f(CRNoOpaqueResize counterpart is also available. As of 4.0.0 this is enabled by default.

The resize version of \f(CROpaqueMoveThreshold. The default is 1000. Since 3.8.1, values >= 1000 are treated as infinity, causing windows to always \f(CROpaqueResize if eligible.

seconds is an integer representing a number of second. When a window tries to open on an unattended display, it will be automatically mapped after this number of seconds.

Use f.movepack algorithm instead of f.move when opening a new window.

This variable specifies a list of pixmaps that define the appearance of various images. Each entry is a keyword indicating the pixmap to set, followed by a string giving the name of the bitmap file. The following pixmaps may be specified:

.fam C
Pixmaps
{
 TitleHighlight "gray1"
# TitleHighlight "supman%.xbm"
}
.fam

This variable specifies the path where ctwm looks to find non-X11 bitmap files. Whenever you want to use a image file that is not an X11 bitmap, specify : \f(CRxpm:filename for xpm files, \f(CRxwd:filename for xwd files, \f(CRjpeg:file for jpeg file, or \f(CR|command for an on the fly generated xwd file. Use the % character to specify an animation. \f(CRpath can be a colon separated list of directories. Example :

.fam C
PixmapDirectory "/usr/lib/X11/twm"
Icons
{
 "Axe" "xpm:edit.xpm"
 "xterm" "xpm:ball%.xpm"
}
.fam

Specifies that the windows in \f(CRwin-list can switch priority. This means that they can be in plane \f(CRpriority or \f(CR-priority depending on the situation. For instance a window whose \f(CRpriority is 2 will be put into plane 2 when raised and plane -2 when lowered, which means that it will usually stay on top if you raise another window, but can still be lowered if its priority is temporarily too high for your liking. If \f(CRIcons is specified, it means that the preference applies to icons rather than windows. See also the \f(CRf.priorityswitching function for dynamically adding/removing windows at runtime. First appeared in 4.0.0.

As above except that it declares that the default should be for windows to be able to switch priority except for the windows in \f(CRwin-list which can\(cqt. First appeared in 4.0.0.

For windows that are to be automatically raised when the pointer enters (see the \f(CRAutoRaise variable and the \f(CRf.autoraise function) this variable specifies the length of time the pointer should rest in the window before it is raised. The default is 0 milliseconds.

If present a window will be raised on top of others when clicked on, and the ButtonPress event will be correctly forwarded to the client that owns this window (if it asked to). See \f(CRRaiseOnClickButton.

Where \f(CRbutton_number is a valid button number (currently 1 to 11). Specify the button to use for RaiseOnClick.

Windows are raised when auto-unsqueezed (See AutoSqueeze).

This variable indicates that windows with no specified geometry should be placed in a pseudo-random location instead of having the user drag out an outline. If no argument is given, it is interpreted as \f(CRRandomPlacement "on". \f(CRstring1 may be "on", "off", "all" or "unmapped", and \f(CRstring2 is a displacement for the pseudo-randomly placed window compared to the previous one. The argument "on" or "all" are equivalent, and tell ctwm to do this for all such windows, "off", not to do this, and "unmapped", only for unmapped windows, e.g. iconified or not visible in the current workspace. If the second argument isn\(cqt given, the displacement +30+30 (30 pixels right and down) is used. As of 4.0.0, "on" is the default if no \f(CRRandomPlacement is specified in the config. Previously "off" was default.

This keyword tells ctwm to move the actual window when the user is moving the small windows in the WorkSpaceMap window. If not present the WorkSpaceMap can be used only to modify the occupation of a window. Pressing the \f(CRshift key while dragging a window in the workspace manager temporarily toggles this option.

This variable specifies the font to be used for in the dimensions window when resizing windows. The default is "fixed".

This variable indicates that properties on client windows to attempt to regenerate the state that the screen was in before the previous window manager was shutdown. This includes using the \f(CRWM_STATE property to tell which windows should be iconified and which should be left visible, and the \f(CRWM_OCCUPATION property to determine in which workspaces a window should be visible. As of 4.0.0 this is the default.

This variable tells ctwm to reverse the background and foreground colors in the small windows in the workspace map for the current workspace.

The host on which sounds should be played. Only meaningful when ctwm is built with \f(CRUSE_SOUND; will give a warning otherwise. See the SOUNDS section. Added in 4.0.0; prior versions used the \f(CRSoundHost parameter instead.

Define what sounds to play on various events through rplayd. It contains entries of the form

.fam C
 "EventName" "/file/to/play.wav"
.fam

This variable indicates a list of color assignments to be stored as pixel values in the root window property _MIT_PRIORITY_COLORS. Clients may elect to preserve these values when installing their own colormap. Note that use of this mechanism is a way for an application to avoid the "technicolor" problem, whereby useful screen objects such as window borders and titlebars disappear when a program\(cqs custom colors are installed by the window manager. For example:

.fam C
SaveColor
{
 BorderColor
 TitleBackground
 TitleForeground
 "red"
 "green"
 "blue"
}
.fam

A la Motif shrinking of icon titles, and expansion when mouse is inside icon. The old incorrect spelling \f(CRSchrinkIconTitles is also still accepted.

Don\(cqt show WorkSpaceManager and IconManagers in the TwmWindows and TwmAllWindows menus.

This variable indicates that the icon manager window should be displayed when ctwm is started. It can always be brought up using the \f(CRf.showiconmgr function.

This variable specifies that the WorkSpaceManager should be visible.

Use sloppy focus.

When changing to a workspace, restore the focus to the last window that had the focus when you left the workspace by warping the mouse into it. This essentially saves the focus window with the workspace and restores it automatically when you switch. In many cases, it avoids having to reach for the mouse after moving to a new workspace.

This variable indicates that entries in the icon manager should be sorted alphabetically rather than by simply appending new windows to the end. As of 4.0.0 this is the default.

Alias for \f(CRRplaySoundHost, used in versions prior to 4.0.0. Unless you need backward compatibility with them, use \f(CRRplaySoundHost instead. This alias will be removed in a future version.

This variable indicates that ctwm should attempt to use the SHAPE extension to make titlebars occupy only as much screen space as they need, rather than extending all the way across the top of the window. The optional \f(CRsqueeze-list may be used to control the location of the squeezed titlebar along the top of the window. It contains entries of the form:

.fam C
 "name" justification num denom
.fam

.fam C
SqueezeTitle
{
 "XTerm" left 0 0
 "xterm1" left 1 3
 "xterm2" left 2 3
 "oclock" center 1 2
 "emacs" right 2 2
}
.fam

This variable indicates that client windows should initially be left as icons until explicitly deiconified by the user. If the optional \f(CRwin-list is given, only those windows will be started iconic. This is useful for programs that do not support an \f(CR-iconic command line option or resource.

Start the WorkSpaceManage in button form. See also \f(CRStartInMapState. Added in 4.0.0.

This variable specifies that the WorkSpaceManager should be started in its map form when created. See also \f(CRStartInButtonState. As of 4.0.0 this is the default.

These windows will first show up squeezed (see f.squeeze).

Tells ctwm to use stayup menus. These menus will stay on the screen when ButtonUp, if either the menu has not yet been entered by the pointer, or the current item is a f.title.

Whether to be strict about what encodings we accept for window naming properties. Added in 4.0.2. This is used when translating properties relating to naming windows, like \f(CRWM_NAME. For example, according to the ICCCM, \f(CRWM_NAME can only be a \f(CRSTRING or \f(CRCOMPOUND_TEXT type. However, sloppy programs like Chrome may set it to a \f(CRUTF8_STRING instead. If this var is set, ctwm will reject that, as was standard behavior prior to 4.0.2.

This variable specifies that the title of the focus window (if exists) should be sunken instead of raised. Only valid if UseThreeDTitles is set.

The width of the 3D border in pixels, if any.

This variable specifies the background color used in titlebars, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. The default is "white".

This variable specifies the width in pixels of the border surrounding titlebuttons. This is typically set to 0 to allow titlebuttons to take up as much space as possible and to not have a border. The default is 1 if \f(CRUseThreeDTitles is not set, 0 if it is set.

This variable specifies the depth of the shadow ctwm uses for 3D title buttons, when UseThreeDTitles is selected.

This variable specifies the font used for displaying window names in titlebars. The default is "variable".

This variable specifies the foreground color used in titlebars, and may only be specified inside of a \f(CRColor or \f(CRMonochrome list. The optional \f(CRwin-list is a list of window names and colors so that per-window colors may be specified. The default is "black".

This keyword needs a string value. The acceptable values are : "left", "center" and "right". The window titles will be justified according to this in the title window.

This variable specifies the distance between the various buttons, text, and highlight areas in the titlebar. The default is 8 pixels if \f(CRUseThreeDTitles is not set, 0 if it is set.

This variable specifies the depth of the shadow ctwm uses for 3D titles, when UseThreeDTitles is selected.

This variable specifies that transient-for and non-group leader windows can have their own occupation potentially different from their leader window. The default case is that these windows follow their leader, use this keyword if the default action doesn\(cqt please you.

The parameter (required) is a percentage and tells ctwm to put transient (and non-group leader) windows always on top of their leader if and only if their surface is smaller than this fraction of the surface of their leader. The surface of a window is its width times its weight. The default is 30%. Added in 3.0.

This variable specifies the filename of a bitmap file to be used as the default icon. This bitmap will be used as the icon of all clients which do not provide an icon bitmap and are not listed in the \f(CRIcons list.

These windows will be moved out of the screen instead of being unmapped when they become invisible due to a change workspace. This has been added because some ill-behaved clients (Frame5) don\(cqt like to be unmapped.

This variable specifies whether or not ctwm should honor program-requested locations (given by the \f(CRPPosition flag in the \f(CRWM_NORMAL_HINTS property) in the absence of a user-specified position. The argument \f(CRstring may have one of three values: \f(CR"off" (the default) indicating that ctwm should ignore the program-supplied position, \f(CR"on" indicating that the position should be used, and \f(CR"non-zero" indicating that the position should used if it is other than (0,0). The latter option is for working around a bug in older toolkits.

This makes it so the shadows are inversed for title pixmaps when focus is lost. This is similar to having the SunkFocusWindowTitle, but it makes your xbm or 3d XPM (if any) sink instead of just the whole bar.

Tells ctwm to use 3D-looking window borders. The width ot the 3D borders is \f(CRThreeDBorderWidth. The color of the 3D border is \f(CRBorderTileBackground, and if NoHighlight is not selected, the border of the Focus window is \f(CRBorderColor. Setting this automatically unsets \f(CRClientBorderWidth.

Tells ctwm to use 3D-looking IconManagers if any.

Tells ctwm to use 3D-looking menus.

Tells ctwm to use 3D-looking windows titles. In which case the default values of \f(CRTitleButtonBorderWidth, \f(CRFramePadding, \f(CRTitlePadding and \f(CRButtonIndent are set to 0. There are plenty of built-in scalable pixmaps for buttons: \f(CR:xpm:menu, \f(CR:xpm:dot, \f(CR:xpm:cross, \f(CR:xpm:bar, \f(CR:xpm:vbar, \f(CR:xpm:iconify, \f(CR:xpm:resize, \f(CR:xmp:sunkresize, and \f(CR:xpm:box. There are several built-in scalable animations for buttons: \f(CR%xpm:resize, \f(CR%xpm:menu-up, \f(CR%xpm:menu-down, \f(CR%xpm:resize-out-top, \f(CR%xpm:resize-in-top, \f(CR%xpm:resize-out-bot, \f(CR%xpm:resize-in-bot, \f(CR%xpm:maze-out, \f(CR%xpm:maze-in, \f(CR%xpm:zoom-out, \f(CR%xpm:zoom-in, and \f(CR%xpm:zoom-inout. Try them to see what they look like.

Tells ctwm to use 3D for the small windows in the workspace map.

This variable indicates that the pointer should be warped into windows when they are deiconified. If the optional \f(CRwin-list is given, the pointer will only be warped when those windows are deiconified.

When ctwm receives a request to map a window, it normally just deiconifies it, but if the window is in \f(CRwin-list, it will additionally bring it into the current workspace, if necessary. For example

.fam C
WarpOnDeIconify { "Emacs" }
.fam

Tells ctwm that f.warpring warps pointer only to windows visible in the current workspace.

(Useful only with StayUpMenus) When using StayUpMenus, and a menu does stays up, the pointer is warped to the default entry of the menu.

This variable indicates that that the \f(CRf.warpto function should deiconify any iconified windows it encounters. This is typically used to make a key binding that will pop a particular window (such as \f(CRxmh), no matter where it is. The default is for \f(CRf.warpto to ignore iconified windows.

Used to give a default geometry to some clients. When XrandR is compiled, the geometry can be relative to a monitor, by prefixing its name (visible with \f(CRxrandr(1) command line) followed by \f(CR:. This name is ignored when XrandR is not available:

.fam C
WindowGeometries {
 "Mozilla*" "1000x800+10+10"
 "jpilot*" "HDMI1:800x600-0-0"
}
.fam

Similar to IconRegion, but for windows. Note that the \f(CRwin-list is not optional.

This variable specifies a list of windows along which the \f(CRf.warpring function cycles. If no argument is given, all the windows are in the ring.

All listed windows will be excluded from the WarpRing.

Control the depth of the shadow of the workspace manager buttons.

Sets the style of the workspace manager buttons (when in button rather than map state), as well as the buttons in the Occupy window. Available options are \f(CRnormal (the default 3d look), \f(CRstyle1, \f(CRstyle2, and \f(CRstyle3 (which are slightly different 2d looks).

Specifies the horizontal space, in pixel, between the buttons of the workspace manager (in button mode).

Specifies the vertical space, in pixel, between the buttons of the workspace manager (in button mode).

This allows you to specify the font to use for the small windows in the workspace manager map. (Try \f(CR-adobe-times-*-r-*--10-*-*-*-*-*-*-*).

This variable specifies the geometry of the workspace manager window. The \f(CRstring argument is standard geometry specification that indicates the initial full size of the workspace manager. When XrandR is compiled, the geometry can be relative to a monitor, by prefixing its name (visible with \f(CRxrandr(1) command line) followed by \f(CR:. This name is ignored when XrandR is not available. The \f(CRcolumns argument indicates the number of columns to use for the workspace manager window.

.fam C
WorkSpaceManagerGeometry "360x60+60-0" 8
WorkSpaceManagerGeometry "HDMI1:600x30+1235+0" 12
.fam

This variable specifies a list of workspaces that are created at startup, Where \f(CRworkspace-list is :

.fam C
name [{bg-button [fg-button] [bg-root] [fg-root] [pixmap-root]}]
.fam

.fam C
WorkSpaces
{
 "One" {"#686B9F" "white" "DeepSkyBlue3" "white" "jpeg:shark.jpg"}
 "Two" {"#619AAE" "white" "firebrick"}
 "Three" {"#727786" "white" "MidnightBlue" "white" "xpm:ball%.xpm"}
 "Four" {"#727786" "white" "white" "white"
 "|(giftoppm | pnmtoxwd) < 2010.gif"}

 "Five" {"#727786" "white" "DeepSkyBlue3" "white" "plaid"}
 "Six" {"#619AAE" "white" "DeepSkyBlue3" "white" "xpm:background1"}
 "Seven" {"#8C5b7A" "white" "chartreuse4"}
 "Eight" {"#686B9F" "white" "MidnightBlue"}
}
.fam

This variable specifies the value to use to constrain window movement. When moving windows around, the x coordinate will always be a multiple of this variable. Default is 1. f.forcemove ignores this variable.

This variable specifies the value to use when drawing window outlines for moving and resizing. This should be set to a value that will result in a variety of distinguishable colors when exclusive-or\(cqed with the contents of the user\(cqs typical screen. Setting this variable to 1 often gives nice results if adjacent colors in the default colormap are distinct. By default, ctwm will attempt to cause temporary lines to appear at the opposite end of the colormap from the graphics.

This variable specifies the value to use to constrain window movement. When moving windows around, the y coordinate will always be a multiple of this variable. Default is 1. f.forcemove ignores this variable.

This variable indicates that outlines suggesting movement of a window to and from its iconified state should be displayed whenever a window is iconified or deiconified. The optional \f(CRcount argument specifies the number of outlines to be drawn. The default count is 8.

This variable specifies the function to be executed when the user change the current workspace (zap).

This variable specifies the function to be executed when a key or button event is received for which no binding is provided. This is typically bound to \f(CRf.nop, \f(CRf.beep, or a menu containing window operations.

This variable specifies the function to be executed when a window is deiconified.

This variable specifies the function to be executed when a window is iconified.

This variable specifies the function to execute when a window is selected from the \f(CRTwmWindows menu. If this variable is not set, the window will be deiconified and raised.

This is an abbreviation for \f(CRf.exec \f(CRstring.

This function adds the selected window to the workspace whose name is \f(CRstring.

Set the alternate context. The next key or button event ctwm receives will be interpreted using the alternate context. To define bindings in the alternate context, use the keyword \f(CRalter in the context field of the binding command. For example:

.fam C
"Return" = m : all : f.altcontext
"n" = : alter : f.nextworkspace
"p" = : alter : f.prevworkspace
.fam

Set the alternate keymap \f(CRnumber, where \f(CRnumber is an integer between 1 and 5 inclusive. The next key or button event ctwm receives will be interpreted using this alternate keymap. To define bindings in an alternate keymap, use the keyword \f(CRa followed by \f(CRnumber in the modifier field of the binding command. For example:

.fam C
"Return" = c : all : f.altkeymap "1"
"i" = a1 : window|icon|iconmgr : f.iconify
"z" = a1 : window : f.zoom
"d" = a1 : window|icon : f.delete
"o" = a1 : window|icon : f.occupy
"r" = a1 : window|icon : f.refresh
.fam

This function toggles whether or not the selected window is lowered whenever the pointer leaves it. See the description of the variable \f(CRAutoLower.

This function toggles whether or not the selected window is raised whenever entered by the pointer. See the description of the variable \f(CRAutoRaise.

This function warps the pointer to the previous column in the current icon manager, wrapping back to the previous row if necessary.

This function warps the pointer in the same manner as \f(CRf.backiconmgr but only stops at windows that are mapped.

This function sounds the keyboard bell.

This function stretches the bottom side of the window out to the bottom edge of the current monitor, or restores the original size if the window was already bottomzoom\(cqd.

Change the priority of a window by \f(CRrel-value (enclosed within double quotes). For instance, to bury a window one level down, you would use f.changepriority "-1". See \f(CROnTopPriority variable. First appeared in 4.0.0.

This function allows you to change the size of the focused window. The format of the string must be either \f(CR"<border> <+|-><sizechange>" (where \f(CR<border> must be one of \f(CRtop, \f(CRbottom, \f(CRleft or \f(CRright) or \f(CR"<x size>x<y size>" (where the size is the requested new window size). The height of the window can never be set/changed to less than the title height + 1 (or 1 if the window has no title) and the width can never be set/changed to less than 1.

.fam C
"Right" = c|s : all : f.changesize "right +10"
"Left" = c|s : all : f.changesize "right -10"
"Down" = c|s : all : f.changesize "bottom +10"
"Up" = c|s : all : f.changesize "bottom -10"

"F1" = c|s : all : f.changesize "640x480"
"F2" = c|s : all : f.changesize "800x600"
"F3" = c|s : all : f.changesize "1024x768"
.fam

This function lowers the top-most window that occludes another window.

This function raises the bottom-most window that is occluded by another window.

This function rotates the colormaps (obtained from the \f(CRWM_COLORMAP_WINDOWS property on the window) that ctwm will display when the pointer is in this window. The argument \f(CRstring may have one of the following values: \f(CR"next", \f(CR"prev", and \f(CR"default". It should be noted here that in general, the installed colormap is determined by keyboard focus. A pointer driven keyboard focus will install a private colormap upon entry of the window owning the colormap. Using the click to type model, private colormaps will not be installed until the user presses a mouse button on the target window.

This function deiconifies the selected window. If the window is not an icon, this function does nothing.

This function sends the \f(CRWM_DELETE_WINDOW message to the selected window if the client application has requested it through the \f(CRWM_PROTOCOLS window property. The application is supposed to respond to the message by removing the indicated window. If the window has not requested \f(CRWM_DELETE_WINDOW messages, the keyboard bell will be rung indicating that the user should choose an alternative method. Note this is very different from f.destroy. The intent here is to delete a single window, not necessarily the entire application.

First tries to delete the window (send it \f(CRWM_DELETE_WINDOW message), or kills it, if the client doesn\(cqt accept such message.

This function allows a user-defined function to be aborted if the pointer has been moved more than \f(CRMoveDelta pixels. See the example definition given for \f(CRFunction "move-or-raise" at the beginning of the section.

This function instructs the X server to close the display connection of the client that created the selected window. This should only be used as a last resort for shutting down runaway clients. See also f.delete.

This function warps the pointer to the next row in the current icon manger, wrapping to the beginning of the next column if necessary.

Goto the workspace immediately underneath the current workspace in the workspace manager. If the current workspace is the bottom one, goto the top one in the same column. The result depends on the layout of the workspace manager.

This function passes the argument \f(CRstring to \f(CR/bin/sh for execution. In multiscreen mode, if \f(CRstring starts a new X client without giving a display argument, the client will appear on the screen from which this function was invoked. If the string "$currentworkspace" is present inside the string argument, it will be substituted with the current workspace name.

Where string is either : "right", "left", "top", "bottom" or "vertical". The current window is resized in the specified direction until it reaches an obstacle (either another window, or the screen border). f.fill "vertical" sets the window status to "zoomed" and toggles, ie calling it again will reset the previous window size.

This function toggles the keyboard focus of the server to the selected window, changing the focus rule from pointer-driven if necessary. If the selected window already was focused, this function executes an \f(CRf.unfocus.

This function is like \f(CRf.move except that it ignores the \f(CRDontMoveOff variable.

This function warps the pointer to the next column in the current icon manager, wrapping to the beginning of the next row if necessary.

This function warps the pointer in the same manner as \f(CRf.forwiconmgr but only stops at windows that are mapped.

This function is similar to the \f(CRf.fullzoom function, except that it makes the client window (the part inside the frame) the size of the current monitor, so the window decorations are off-screen. This gives the same visual effect as the window covering the whole screen with no decorations. If the window is already fullscreenzoom\(cqd, it restores the original size.

This function resizes the selected window to the full size of the current monitor, or restores the original size if the window was already fullzoom\(cqd.

This function executes the user-defined function whose name is specified by the argument \f(CRstring.

This function warps you to the workspace whose name is \f(CRworkspace_name.

This function is a synonym for \f(CRf.bottomzoom.

This function unmaps the current icon manager.

Unmap the WorkSpace manager.

This function stretches the window so that it covers the whole width of the current monitor, or restores the original size if the window was already horizoom\(cqd.

This function is a synonym for \f(CRf.topzoom.

This function is a synonym for \f(CRf.horizoom.

This function iconifies or deiconifies the selected window or icon, respectively.

This function displays a summary of the name and geometry of the selected window. Clicking the pointer or pressing a key in the window will dismiss it.

This function resets a window to its initial size given by the \f(CRWM_NORMAL_HINTS hints.

This function is designed to be bound to a key, it moves the current window (step * {X,Y}MoveGrid) pixels downward. stopping if the window encounters another window or the screen border (ala f.pack).

Leftward equivalent of f.jumpdown.

Rightward equivalent of f.jumpdown.

Upward equivalent of f.jumpdown.

This function similar to \f(CRf.backiconmgr except that wrapping does not change rows.

Goto the workspace immediately on the left of the current workspace in the workspace manager. If the current workspace is the leftest one, goto the rightest one in the same row. The result depends on the layout of the workspace manager.

This function stretches the left side of the window out to the left edge of the current monitor, or restores the original size if the window was already leftzoom\(cqd.

This function lowers the selected window.

This function invokes the menu specified by the argument \f(CRstring. Cascaded menus may be built by nesting calls to \f(CRf.menu. When a menu is popped up, you can use the arrow keys to move the cursor around it. "Down" or space goes down, "Up" goes up, "Left" pops down the menu, and "Right" activates the current entry. The first letter of an entry name activates this entry (the first one if several entries match). If the first letter is ~ then Meta-the-second-letter activates it, if this first letter is ^ then Control-the-second-letter activates it, and if this first letter is space, then the second letter activates it.

This function drags an outline of the selected window (or the window itself if the \f(CROpaqueMove variable is set) until the invoking pointer button is released. Double clicking within the number of milliseconds given by \f(CRConstrainedMoveTime warps the pointer to the center of the window and constrains the move to be either horizontal or vertical depending on which grid line is crossed. To abort a move, press another button before releasing the first button.

This function is like \f(CRf.move except that it tries to avoid overlapping of windows. When the moving window begin to overlap with another window, the move is stopped. If you go too far over the other window (more that \f(CRMovePackResistance pixels), the move is resumed and the moving window can overlap with the other window. Useful to pack windows closely.

This function is like \f(CRf.move except that it tries to avoid overlapping of windows. When the moving window begins to overlap with another window, the other window is pushed. If you go too far over the other window (more that \f(CRMovePackResistance pixels), there is no push and the moving window can overlap with the other window. Only available if \f(CROpaqueMove is active.

Takes one string argument which is a geometry with the standard X geometry syntax (e.g. 200x300+150-0). Sets the current window to the specified geometry. The width and height are to be given in pixel, no base size or resize increment are used. When XrandR is compiled, the geometry can be relative to a monitor, by prefixing its name (visible with \f(CRxrandr(1) command line) followed by \f(CR: (e.g. HDMI1:200x300+150-0). This name is ignored when XrandR is not available.

If applied to a squeezed titlebar (see \f(CRSqueezeTitle) you can drag it along the top of the window (a feature which was first found in BeOS). The existing justification type is preserved, as is the positioning (relative or absolute). This means that a relatively positioned titlebar will move when the width of a window changes, whereas an absolutely positioned title will not. The default positioning is left-justified, absolute at 0 pixels.

.fam C
Button1 = m1 : title : f.movetitlebar
.fam

Move the window to the next workspace, and optionally switch view over to that workspace.

Move the window to the previous workspace, and optionally switch view over to that workspace.

This function warps the pointer to the next icon manager containing any windows on the current or any succeeding screen.

Goto the next workspace in the list, using the order given in the \f(CR.ctwmrc file.

This function does nothing and is typically used with the \f(CRDefaultFunction or \f(CRWindowFunction variables or to introduce blank lines in menus.

This function pops up a window for the user to choose which workspaces a window belongs to.

This function makes the specified window occupy all the workspaces.

Where string is either : "right", "left", "top" or "bottom" The current window is moved in the specified direction until it reaches an obstacle (either another window, or the screen border). The pointer follows the window.

Valid only in a root menu. Make a menu permanent on the screen. This is a toggle function, if you select it while the menu is already permanent, it becomes non-permanent.

This function warps the pointer to the previous icon manager containing any windows on the current or preceding screens.

Goto the previous workspace in the list, using the order given in the \f(CR.ctwmrc file.

Toggle the window\(cqs switching ability. X-ref \f(CRPrioritySwitching and \f(CROnTopPriority variables. First appeared in 4.0.0.

This function causes ctwm to restore the window\(cqs borders and exit. If ctwm is the first client invoked from \f(CRxdm, this will result in a server reset.

This function raises the selected window.

This function raises all the icons in the current workspace.

This function raises the selected window to the top of the stacking order if it is occluded by any windows, otherwise the window will be lowered.

Raise the window or squeeze it if it\(cqs a double click. The time that defines a double click is given by the \f(CRConstrainedMoveTime variable. First appeared in 4.0.0.

This function causes all windows to be refreshed.

This function removes the selected window from the workspace whose name is \f(CRstring.

This function causes the \f(CR.ctwm-sounds file to be re-read. Note that this will not re-read sounds set in \f(CRRplaySounds in the config file. As a result, this function will probably go away in the future when \f(CR.ctwm-sounds support is removed. See the SOUNDS section.

If you somehow managed to move a window out of sight, calling this function will check all windows and icons on currently visible virtual screens, and those that are (nearly) out of the bounds of their virtual screen will be brought completely inside (if that fits). First appeared in 4.0.0.

This function displays an outline of the selected window. Crossing a border (or setting \f(CRAutoRelativeResize) will cause the outline to begin to rubber band until the invoking button is released. To abort a resize, press another button before releasing the first button.

This function kills and restarts ctwm.

Restore the current window geometry to what was saved in the last call to f.savegeometry.

This function is similar to \f(CRf.nexticonmgr except that wrapping does not change rows.

Goto the workspace immediately on the right of the current workspace in the workspace manager. If the current workspace is the rightest one, goto the leftest one in the same row. The result depends on the layout of the workspace manager.

This function stretches the right side of the window out to the right edge of the current monitor, or restores the original size if the window was already rightzoom\(cqd.

Selects a window and adds it to the WarpRing, or removes it if it was already in the ring. This command makes \f(CRf.warpring much more useful, by making its configuration dynamic.

The geometry of the current window is saved. The next call to f.restoregeometry will restore this window to this geometry.

This function sends a \f(CRWM_SAVEYOURSELF message to the selected window if it has requested the message in its \f(CRWM_PROTOCOLS window property. Clients that accept this message are supposed to checkpoint all state associated with the window and update the \f(CRWM_COMMAND property as specified in the ICCCM. If the selected window has not selected for this message, the keyboard bell will be rung.

Valid only in menus. The effect is to add a line separator between the previous and the following entry. The name selector part in the menu is not used (but must be present).

Set the WorkSpace manager in button state.

Set the WorkSpace manager in map state.

Set the window\(cqs priority to \f(CRvalue (enclosed between double quotes). If \f(CRvalue is directly followed by \f(CR< or \f(CRb, the window is placed below other windows of the given priority. Otherwise it is placed above. See \f(CROnTopPriority variable for details. First appeared in 4.0.0.

This function unmaps all windows in the current workspace. This is a toggle function, if all windows are unmapped, they are all remapped. Better bind this function in the root context.

This function maps the current icon manager.

Map the WorkSpace manager.

Decrease \f(CRAnimationSpeed by 1.

This function sorts the entries in the current icon manager alphabetically. See the variable \f(CRSortIconManager.

Increase \f(CRAnimationSpeed by 1.

f.squeeze squeezes a window to a null vertical size. Works only for windows with either a title, or a 3D border (in order to have something left on the screen). If the window is already squeezed, it is unsqueezed.

Restart freezed animations (if any).

Freeze animations (if any).

Switch the window\(cqs priority, independently of its ability to switch automatically. X-ref \f(CROnTopPriority and \f(CRPrioritySwitching variables. First appeared in 4.0.0.

These two functions allow you to raise/lower a window "one step" at a time. For instance, \f(CRf.tinyraise will bring the current window just above the lowest one that\(cqs hiding it. These two functions are not subject to priority-switching. First appeared in 4.0.0.

This function provides a centered, unselectable item in a menu definition. It should not be used in any other context.

This function adds the selected window to the workspace whose name is \f(CRstring if it doesn\(cqt already belongs to it, and removes it from this workspace if not.

Toggle sound on/off. See the SOUNDS section.

Toggle the state of the WorkSpace manager.

Toggle the presence of the WorkSpaceManager. If it is mapped, it will be unmapped and vice versa.

This function stretches the top side of the window out to the top edge of the current monitor, or restores the original size if the window was already topzoom\(cqd.

Used for handling dumping debug output. If a filename is given in \f(CRstring, begins writing output to that file; if \f(CRstring is \f(CR"stderr" writes to stderr. If debug file is already open, calling f.trace again closes it. This is probably only useful if you\(cqre doing development on ctwm.

Alias for \f(CRf.restart.

This function resets the focus back to pointer-driven. This should be used when a focused window is no longer desired.

Is to \f(CRf.squeeze what \f(CRf.deiconify is to \f(CRf.iconify. First appeared in 4.0.0.

This function warps the pointer to the previous row in the current icon manager, wrapping to the last row in the same column if necessary.

Goto the workspace immediately above the current workspace in the workspace manager. If the current workspace is the top one, goto the bottom one in the same column. The result depends on the layout of the workspace manager.

The specified window vanishes from the current workspace if it occupies at least one other WorkSpace. Do nothing in the others cases.

This function causes the ctwm version window to be displayed. This window will be displayed until a pointer button is pressed or the pointer is moved from one window to another.

This function is a synonym for \f(CRf.leftzoom.

This function is a synonym for \f(CRf.rightzoom.

This function adds the window which has a name or class that matches string to the current workspace and warps the pointer to it. If the window is iconified, it will be deiconified if the variable WarpUnmapped is set or else ignored.

This function warps the pointer to the next or previous window (as indicated by the argument \f(CRstring, which may be \f(CR"next" or \f(CR"prev") specified in the \f(CRWindowRing variable.

This function warps the pointer to the window which has a name or class that matches \f(CRstring. If the window is iconified, it will be deiconified if the variable \f(CRWarpUnmapped is set or else ignored.

This function warps the pointer to the icon manager entry associated with the window containing the pointer in the icon manager specified by the argument \f(CRstring. If \f(CRstring is empty (i.e. ""), the current icon manager is chosen.

This function warps the pointer to the screen specified by the argument \f(CRstring. The argument may be a number (e.g. \f(CR"0" or \f(CR"1"), the word \f(CR"next" (indicating the current screen plus 1, skipping over any unmanaged screens), the word \f(CR"back" (indicating the current screen minus 1, skipping over any unmanaged screens), or the word \f(CR"prev" (indicating the last screen visited).

This function is similar to the \f(CRf.refresh function except that only the selected window is refreshed.

This function is similar to the \f(CRf.bottomzoom function, but will cross monitors.

This function is similar to the \f(CRf.fullscreenzoom function, but will cross monitors.

This function is similar to the \f(CRf.fullzoom function, but will cross monitors.

This function is similar to the \f(CRf.horizoom function, but will cross monitors.

This function is similar to the \f(CRf.leftzoom function, but will cross monitors.

This function is similar to the \f(CRf.rightzoom function, but will cross monitors.

This function is similar to the \f(CRf.topzoom function, but will cross monitors.

This function is similar to the \f(CRf.zoom function, but will cross monitors.

This function stretches the window so that it covers the whole height of the current monitor, or restores the original size if the window was already zoom\(cqd. It\(cqs the vertical counterpart fo \f(CRf.horizoom; perhaps \f(CRf.vertzoom would be a better name...

This variable is used to determine which X server to use. It is also set during \f(CRf.exec so that programs come up on the proper screen.

This variable is used as the prefix for files that begin with a tilde and for locating the ctwm startup file.