Blame doc/man/man4/mwmrc.4

Packit b099d7
'\" t
Packit b099d7
...\" mwmrc.sgm /main/8 1996/09/08 21:43:59 rws $
Packit b099d7
.de P!
Packit b099d7
.fl
Packit b099d7
\!!1 setgray
Packit b099d7
.fl
Packit b099d7
\\&.\"
Packit b099d7
.fl
Packit b099d7
\!!0 setgray
Packit b099d7
.fl			\" force out current output buffer
Packit b099d7
\!!save /psv exch def currentpoint translate 0 0 moveto
Packit b099d7
\!!/showpage{}def
Packit b099d7
.fl			\" prolog
Packit b099d7
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
Packit b099d7
\!!psv restore
Packit b099d7
.
Packit b099d7
.de pF
Packit b099d7
.ie     ?\\*(f1?? .ds f1 \\n(.f
Packit b099d7
.el .ie ?\\*(f2?? .ds f2 \\n(.f
Packit b099d7
.el .ie ?\\*(f3?? .ds f3 \\n(.f
Packit b099d7
.el .ie ?\\*(f4?? .ds f4 \\n(.f
Packit b099d7
.el .tm ? font overflow
Packit b099d7
.ft \\$1
Packit b099d7
..
Packit b099d7
.de fP
Packit b099d7
.ie     !?\\*(f4?? \{\
Packit b099d7
.	ft \\*(f4
Packit b099d7
.	ds f4\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f3?? \{\
Packit b099d7
.	ft \\*(f3
Packit b099d7
.	ds f3\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f2?? \{\
Packit b099d7
.	ft \\*(f2
Packit b099d7
.	ds f2\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f1?? \{\
Packit b099d7
.	ft \\*(f1
Packit b099d7
.	ds f1\"
Packit b099d7
'	br \}
Packit b099d7
.el .tm ? font underflow
Packit b099d7
..
Packit b099d7
.ds f1\"
Packit b099d7
.ds f2\"
Packit b099d7
.ds f3\"
Packit b099d7
.ds f4\"
Packit b099d7
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
Packit b099d7
.TH "mwmrc" "special file"
Packit b099d7
.SH "NAME"
Packit b099d7
\fBmwmrc\fP \(em the
Packit b099d7
Motif Window Manager Resource Description File
Packit b099d7
.SH "DESCRIPTION"
Packit b099d7
.PP
Packit b099d7
The \fBmwmrc\fP file is a supplementary resource
Packit b099d7
file that controls much of the behavior of the Motif window manager \fBmwm\fP\&. 
Packit b099d7
It contains descriptions of resources that cannot easily be
Packit b099d7
written using standard X Window System, Version 11 resource syntax\&. The resource
Packit b099d7
description file contains entries that are referred to by X resources in
Packit Service 1f15c3
defaults files (for example, \fB/usr/X11R6/lib/X11/app-defaults/Mwm\fP)
Packit b099d7
or in the \fBRESOURCE_MANAGER\fP property on the
Packit b099d7
root window\&. For example, the resource description file enables you to specify
Packit b099d7
different types of window menus; however, an X resource is used to specify
Packit b099d7
which of these window menus \fBmwm\fP should use for a particular
Packit b099d7
window\&. 
Packit b099d7
.SS "Location"
Packit b099d7
.PP
Packit b099d7
The window manager searches for one of the following resource description
Packit b099d7
files, where \fI$LANG\fP is the value of the language environment
Packit b099d7
on a per-user basis:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW$HOME/$LANG/\&.mwmrc
Packit b099d7
$HOME/\&.mwmrc
Packit Service 1f15c3
/usr/X11R6/lib/X11/$LANG/system\&.mwmrc
Packit Service 1f15c3
/usr/X11R6/lib/X11/system\&.mwmrc\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The first file found is the first used\&. If no file is found, a
Packit b099d7
set of built-in specifications is used\&. A particular resource description
Packit b099d7
file can be selected using the \fIconfigFile\fP
Packit b099d7
resource\&. The following shows how a different resource description file can
Packit b099d7
be specified from the command line:
Packit b099d7
.PP
Packit b099d7
.nf
Packit Service 1f15c3
\f(CW/usr/X11R6/bin/X11/mwm -xrm "mwm*configFile: mymwmrc"\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.SS "Resource Types"
Packit b099d7
.PP
Packit b099d7
The following types of resources can be described in the mwm resource
Packit b099d7
description file:
Packit b099d7
.IP "\fBButtons\fP" 10
Packit b099d7
Window manager functions can be bound (associated) with button events\&.
Packit b099d7
.IP "\fBKeys\fP" 10
Packit b099d7
Window manager functions can be bound (associated) with key press
Packit b099d7
events\&.
Packit b099d7
.IP "\fBMenus\fP" 10
Packit b099d7
Menu panes can be used for the window menu and other menus posted with
Packit b099d7
key bindings and button bindings\&.
Packit b099d7
.SH "MWM RESOURCE DESCRIPTION FILE SYNTAX"
Packit b099d7
.PP
Packit b099d7
The \fBmwm\fP resource description file is a standard
Packit b099d7
text file that contains items of information separated by blanks, tabs, and
Packit b099d7
new lines characters\&. Blank lines are ignored\&. Items or characters can be
Packit b099d7
quoted to avoid special interpretation (for example, the comment character
Packit b099d7
can be quoted to prevent it from being interpreted as the comment character)\&.
Packit b099d7
A quoted item can be contained in double quotes (\fB" "\fP)\&.
Packit b099d7
Single characters can be quoted by preceding them by the back-slash character
Packit b099d7
(\fB\\\fP)\&. If a line ends with a back-slash, the next line is considered
Packit b099d7
a continuation of that line\&. All text from an unquoted \fB#\fP
Packit b099d7
to the end of the line is regarded as a comment and is not interpreted as
Packit b099d7
part of a resource description\&. If \fB!\fP is the first character
Packit b099d7
in a line, the line is regarded as a comment\&.
Packit b099d7
.SS "Window Manager Functions"
Packit b099d7
.PP
Packit b099d7
Window manager functions can be accessed with button and key bindings,
Packit b099d7
and with window manager menus\&. Functions are indicated as part of the specifications
Packit b099d7
for button and key binding sets, and menu panes\&. The function specification
Packit b099d7
has the following syntax:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fBfunction\fP = \fBfunction_name\fP [\fBfunction_args\fP]
Packit b099d7
\fBfunction_name\fP = \fBwindow manager function\fP
Packit b099d7
\fBfunction_args\fP = {\fBquoted_item\fP | \fBunquoted_item\fP}\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The following functions are supported\&. If a function is specified that
Packit b099d7
isn\&'t one of the supported functions then it is interpreted by \fBmwm\fP as \fBf\&.nop\fP\&.
Packit b099d7
.IP "\fBf\&.beep\fP" 10
Packit b099d7
This function causes a beep\&.
Packit b099d7
.IP "\fBf\&.circle_down\fP [ \fIicon\fP | \fIwindow\fP]" 10
Packit b099d7
This function causes the window or icon that is on the top of the window
Packit b099d7
stack to be put on the bottom of the window stack (so that it is no longer
Packit b099d7
obscuring any other window or icon)\&. This function affects only those windows
Packit b099d7
and icons that are obscuring other windows and icons, or that are obscured
Packit b099d7
by other windows and icons\&. Secondary windows (that is, transient windows)
Packit b099d7
are restacked with their associated primary window\&. Secondary windows always
Packit b099d7
stay on top of the associated primary window and there can be no other primary
Packit b099d7
windows between the secondary windows and their primary window\&. If an
Packit b099d7
\fIicon\fP function argument is specified, then the function
Packit b099d7
applies only to icons\&. If a \fIwindow\fP function
Packit b099d7
argument is specified then the function applies only to windows\&.
Packit b099d7
.IP "\fBf\&.circle_up\fP [ \fIicon\fP | \fIwindow\fP]" 10
Packit b099d7
This function raises the window or icon on the bottom of the window
Packit b099d7
stack (so that it is not obscured by any other windows)\&. This function affects
Packit b099d7
only those windows and icons that are obscuring other windows and icons, or
Packit b099d7
that are obscured by other windows and icons\&. Secondary windows (that is,
Packit b099d7
transient windows) are restacked with their associated primary window\&. If
Packit b099d7
an \fIicon\fP function argument is specified then
Packit b099d7
the function applies only to icons\&. If an \fIwindow\fP
Packit b099d7
function argument is specified then the function applies only to windows\&.
Packit b099d7
.IP "\fBf\&.exec\fP \fBcommand\fP (or \fI!\fP \fBcommand\fP)" 10
Packit b099d7
This function causes \fIcommand\fP to be
Packit b099d7
executed (using the value of the \fI$MWMSHELL\fP or \fI$SHELL\fP environment variable if set; otherwise, \fB/bin/sh\fP )\&. The \fI!\fP notation can be used in place of the \fBf\&.exec\fP function name\&.
Packit b099d7
.IP "\fBf\&.focus_color\fP" 10
Packit b099d7
This function sets the colormap focus to a client window\&. If this function
Packit b099d7
is done in a root context, then the default colormap (setup by the X Window
Packit b099d7
System for the screen where \fBmwm\fP is running) is installed
Packit b099d7
and there is no specific client window colormap focus\&. This function is treated
Packit b099d7
as \fBf\&.nop\fP if \fIcolormapFocusPolicy\fP
Packit b099d7
is not explicit\&.
Packit b099d7
.IP "\fBf\&.focus_key\fP" 10
Packit b099d7
This function sets the keyboard input focus to a client window or icon\&.
Packit b099d7
This function is treated as \fBf\&.nop\fP if \fIkeyboardFocusPolicy\fP is not explicit or the function is executed in a root context\&.
Packit b099d7
.IP "\fBf\&.kill\fP" 10
Packit b099d7
This function is used to close application windows\&. The actual processing
Packit b099d7
that occurs depends on the protocols that the application observes\&. The application
Packit b099d7
lists the protocols it observes in the \fBWM_PROTOCOLS\fP property
Packit b099d7
on its top level window\&. If the application observes the \fBWM_DELETE_WINDOW\fP protocol, it is sent a message that requests the window be deleted\&.
Packit b099d7
If the application observes both \fBWM_DELETE_WINDOW\fP and \fBWM_SAVE_YOURSELF\fP, it is sent one message requesting the window
Packit b099d7
be deleted and another message advising it to save its state\&. If the application
Packit b099d7
observes only the \fBWM_SAVE_YOURSELF\fPprotocol \fI,\fP it is sent a message advising it to save its state\&. After a
Packit b099d7
delay (specified by the resource \fIquitTimeout\fP), the application\&'s
Packit b099d7
connection to the X server is terminated\&. If the application observes neither
Packit b099d7
of these protocols, its connection to the X server is terminated\&.
Packit b099d7
.IP "\fBf\&.lower\fP\ [\fI-\fP \fBclient\fP | \fIwithin\fP\ | \fIfreeFamily\fP]" 10
Packit b099d7
This function lowers a primary window to the bottom of the global window
Packit b099d7
stack (where it obscures no other window) and lowers the secondary window
Packit b099d7
(transient window or dialog box) within the client family\&. The arguments to
Packit b099d7
this function are mutually exclusive\&. The \fIclient\fP
Packit b099d7
argument indicates the name or class of a client to lower\&. The name or class
Packit b099d7
of a client appears in the \fBWM_CLASS\fP property on the
Packit b099d7
client\&'s top-level window\&. If the \fIclient\fP
Packit b099d7
argument is not specified, the context that the function was invoked in indicates
Packit b099d7
the window or icon to lower\&. Specifying \fIwithin\fP
Packit b099d7
lowers the secondary window within the family (staying above the parent) but
Packit b099d7
does not lower the client family in the global window stack\&. Specifying \fIfreeFamily\fP lowers the window to the bottom of the global windows
Packit b099d7
stack from its local family stack\&.
Packit b099d7
.IP "\fBf\&.maximize\fP" 10
Packit b099d7
This function causes a client window to be displayed with its maximum
Packit b099d7
size\&. Refer to the \fImaximumClientSize\fP, \fImaximumMaximumSize\fP, and \fIlimitResize\fP resources in \fBmwm\fP(1)\&.
Packit b099d7
.IP "\fBf\&.menu\fP \fImenu_name\fP" 10
Packit b099d7
This function associates a cascading (pull-right) menu with a menu
Packit b099d7
pane entry or a menu with a button or key binding\&. The \fImenu_name\fP function argument identifies the menu to be used\&.
Packit b099d7
.IP "\fBf\&.minimize\fP" 10
Packit b099d7
This function causes a client window to be minimized (iconified)\&. When
Packit b099d7
a window is minimized with no icon box in use, and if the \fIlowerOnIconify\fP resource has the value True (the default), the icon is placed
Packit b099d7
on the bottom of the window stack (such that it obscures no other window)\&.
Packit b099d7
If an icon box is used, then the client\&'s icon changes to its iconified form
Packit b099d7
inside the icon box\&. Secondary windows (that is, transient windows) are minimized
Packit b099d7
with their associated primary window\&. There is only one icon for a primary
Packit b099d7
window and all its secondary windows\&.
Packit b099d7
.IP "\fBf\&.move\fP" 10
Packit b099d7
This function initiates an interactive move of a client window\&.
Packit b099d7
.IP "\fBf\&.next_cmap\fP" 10
Packit b099d7
This function installs the next colormap in the list of colormaps for
Packit b099d7
the window with the colormap focus\&.
Packit b099d7
.IP "\fBf\&.next_key\fP [ \fIicon\fP | \fIwindow\fP | \fItransient\fP]" 10
Packit b099d7
This function sets the keyboard input focus to the next window/icon
Packit b099d7
in the set of windows/icons managed by the window manager (the ordering
Packit b099d7
of this set is based on the stacking of windows on the screen)\&. This function
Packit b099d7
is treated as \fBf\&.nop\fP if \fBkeyboardFocusPolicy\fP
Packit b099d7
is not explicit\&. The keyboard input focus is only moved to windows that do
Packit b099d7
not have an associated secondary window that is application modal\&. If the
Packit b099d7
\fItransient\fP argument is specified, then transient (secondary)
Packit b099d7
windows are traversed (otherwise, if only \fIwindow\fP
Packit b099d7
is specified, traversal is done only to the last focused window in a transient
Packit b099d7
group)\&. If an \fIicon\fP function argument is specified,
Packit b099d7
then the function applies only to icons\&. If a \fIwindow\fP function argument is specified, then the function applies only to
Packit b099d7
windows\&.
Packit b099d7
.IP "\fBf\&.nop\fP" 10
Packit b099d7
This function does nothing\&.
Packit b099d7
.IP "\fBf\&.normalize\fP" 10
Packit b099d7
This function causes a client window to be displayed with its normal
Packit b099d7
size\&. Secondary windows (that is, transient windows) are placed in their normal
Packit b099d7
state along with their associated primary window\&.
Packit b099d7
.IP "\fBf\&.normalize_and_raise\fP" 10
Packit b099d7
This function causes a client window to be displayed with its normal
Packit b099d7
size and raised to the top of the window stack\&. Secondary windows (that is,
Packit b099d7
transient windows) are placed in their normal state along with their associated
Packit b099d7
primary window\&.
Packit b099d7
.IP "\fBf\&.pack_icons\fP" 10
Packit b099d7
This function is used to relayout icons (based on the layout policy
Packit b099d7
being used) on the root window or in the icon box\&. In general this causes
Packit b099d7
icons to be "packed" into the icon grid\&.
Packit b099d7
.IP "\fBf\&.pass_keys\fP" 10
Packit b099d7
This function is used to enable/disable (toggle) processing of key bindings
Packit b099d7
for window manager functions\&. When it disables key binding processing all
Packit b099d7
keys are passed on to the window with the keyboard input focus and no window
Packit b099d7
manager functions are invoked\&. If the \fBf\&.pass_keys\fP function
Packit b099d7
is invoked with a key binding to disable key binding processing the same key
Packit b099d7
binding can be used to enable key binding processing\&.
Packit b099d7
.IP "\fBf\&.post_wmenu\fP" 10
Packit b099d7
This function is used to post the window menu\&. If a key is used to post
Packit b099d7
the window menu and a window menu button is present, the window menu is automatically
Packit b099d7
placed with its top-left corner at the bottom-left corner of the window menu
Packit b099d7
button for the client window\&. If no window menu button is present, the window
Packit b099d7
menu is placed at the top-left corner of the client window\&.
Packit b099d7
.IP "\fBf\&.prev_cmap\fP" 10
Packit b099d7
This function installs the previous colormap in the list of colormaps
Packit b099d7
for the window with the colormap focus\&.
Packit b099d7
.IP "\fBf\&.prev_key\fP [ \fIicon\fP | \fIwindow\fP | \fItransient\fP]" 10
Packit b099d7
This function sets the keyboard input focus to the previous window/icon
Packit b099d7
in the set of windows/icons managed by the window manager (the ordering
Packit b099d7
of this set is based on the stacking of windows on the screen)\&. This function
Packit b099d7
is treated as \fBf\&.nop\fP if \fIkeyboardFocusPolicy\fP is not explicit\&. The keyboard input focus is only moved to windows
Packit b099d7
that do not have an associated secondary window that is application modal\&.
Packit b099d7
If the \fItransient\fP argument is specified, then
Packit b099d7
transient (secondary) windows are traversed (otherwise, if only \fIwindow\fP is specified, traversal is done only to the last focused window
Packit b099d7
in a transient group)\&. If an \fIicon\fP function
Packit b099d7
argument is specified then the function applies only to icons\&. If an
Packit b099d7
\fIwindow\fP function argument is specified then the function
Packit b099d7
applies only to windows\&.
Packit b099d7
.IP "\fBf\&.quit_mwm\fP" 10
Packit b099d7
This function terminates mwm (but NOT the X window system)\&.
Packit b099d7
.IP "\fBf\&.raise\fP\ [\fI-\fP\fIclient\fP | \fIwithin\fP | \fIfreeFamily\fP]" 10
Packit b099d7
This function raises a primary window to the top of the global window
Packit b099d7
stack (where it is obscured by no other window) and raises the secondary window
Packit b099d7
(transient window or dialog box) within the client family\&. The arguments to
Packit b099d7
this function are mutually exclusive\&. The \fIclient\fP
Packit b099d7
argument indicates the name or class of a client to lower\&. If the \fIclient\fP
Packit b099d7
is not specified, the context that the function
Packit b099d7
was invoked in indicates the window or icon to lower\&. Specifying \fIwithin\fP raises the secondary window within the family but does not
Packit b099d7
raise the client family in the global window stack\&. Specifying \fIfreeFamily\fP raises the window to the top of its local family stack
Packit b099d7
and raises the family to the top of the global window stack\&.
Packit b099d7
.IP "\fBf\&.raise_lower\fP\ [ \fIwithin\fP | \fIfreeFamily\fP]" 10
Packit b099d7
This function raises a primary window to the top of the global window
Packit b099d7
stack if it is partially obscured by another window; otherwise, it lowers
Packit b099d7
the window to the bottom of the window stack\&. The arguments to this function
Packit b099d7
are mutually exclusive\&. Specifying \fIwithin\fP
Packit b099d7
raises a secondary window within the family (staying above the parent window),
Packit b099d7
if it is partially obscured by another window in the application\&'s family;
Packit b099d7
otherwise, it lowers the window to the bottom of the family stack\&. It has
Packit b099d7
no effect on the global window stacking order\&. Specifying \fIfreeFamily\fP raises the window to the top of its local family stack, if obscured
Packit b099d7
by another window, and raises the family to the top of the global window
Packit b099d7
stack; otherwise, it lowers the window to the bottom of its local family stack
Packit b099d7
and lowers the family to the bottom of the global window stack\&.
Packit b099d7
.IP "\fBf\&.refresh\fP" 10
Packit b099d7
This function causes all windows to be redrawn\&.
Packit b099d7
.IP "\fBf\&.refresh_win\fP" 10
Packit b099d7
This function causes a client window to be redrawn\&.
Packit b099d7
.IP "\fBf\&.resize\fP" 10
Packit b099d7
This function initiates an interactive resize of a client window\&.
Packit b099d7
.IP "\fBf\&.restore\fP" 10
Packit b099d7
This function restores the previous state of an icon\&'s associated window\&.
Packit b099d7
If a maximized window is iconified, then \fBf\&.restore\fP restores
Packit b099d7
it to its maximized state\&. If a normal window is iconified, then \fBf\&.restore\fP restores it to its normalized state\&.
Packit b099d7
.IP "\fBf\&.restore_and_raise\fP" 10
Packit b099d7
This function restores the previous state of an icon\&'s associated window
Packit b099d7
and raises the window to the top of the window stack\&. If a maximized window
Packit b099d7
is iconified, then \fBf\&.restore_and_raise\fP restores it to
Packit b099d7
its maximized state and raises it to the top of the window stack\&. If a normal
Packit b099d7
window is iconified, then \fBf\&.restore_and_raise\fP restores
Packit b099d7
it to its normalized state and raises it to the top of the window stack\&.
Packit b099d7
.IP "\fBf\&.restart\fP" 10
Packit b099d7
This function causes mwm to be restarted (effectively terminated and
Packit b099d7
re-executed)\&. Restart is necessary for \fBmwm\fP to incorporate
Packit b099d7
changes in both the \fBmwmrc\fP file and X resources\&.
Packit b099d7
.IP "\fBf\&.screen\fP\ [ \fInext\fP | \fIprev\fP | \fIback\fP | \fIscreen_number\fP]" 10
Packit b099d7
This function causes the pointer to be warp to a specific screen number
Packit b099d7
or to the \fInext\fP, \fIprevious\fP, or last visited (\fIback\fP)
Packit b099d7
screen\&. The arguments to this function are mutually exclusive\&. The
Packit b099d7
\fIscreen_number\fP argument indicates the screen number
Packit b099d7
that the pointer is to be warped\&. Screens are numbered starting from screen
Packit b099d7
0\&. Specifying \fInext\fP cause the pointer to warp
Packit b099d7
to the next managed screen (skipping over any unmanaged screens)\&. Specifying
Packit b099d7
\fIprev\fP cause the pointer to warp to the previous managed
Packit b099d7
screen (skipping over any unmanaged screens)\&. Specifying \fIback\fP cause the pointer to warp to the last visited screen\&.
Packit b099d7
.IP "\fBf\&.send_msg\fP \fImessage_number\fP" 10
Packit b099d7
This function sends an \fBXClientMessageEvent\fR of type \fB_MOTIF_WM_MESSAGES\fP with
Packit b099d7
\fImessage_type\fP set to \fImessage_number\fP\&.
Packit b099d7
The client message is sent only if \fImessage_number\fP
Packit b099d7
is included in the client\&'s \fB_MOTIF_WM_MESSAGES\fP
Packit b099d7
property\&. A menu item label is grayed out if the menu item is used to do \fBf\&.send_msg\fP of a message that is not included in the client\&'s \fB_MOTIF_WM_MESSAGES\fP property\&.
Packit b099d7
.IP "\fBf\&.separator\fP" 10
Packit b099d7
This function causes a menu separator to be put in the menu pane at
Packit b099d7
the specified location (the label is ignored)\&.
Packit b099d7
.IP "\fBf\&.set_behavior\fP" 10
Packit b099d7
This function causes the window manager to restart with the default
Packit b099d7
behavior (if a custom behavior is configured) or a custom behavior (if a
Packit b099d7
default behavior is configured)\&. By default this is bound to \fIShift\ Ctrl\ Alt\ <Key>!\fP\&.
Packit b099d7
.IP "\fBf\&.title\fP" 10
Packit b099d7
This function inserts a title in the menu pane at the specified location\&.
Packit b099d7
.IP "\fBf\&.version\fP" 10
Packit b099d7
This function causes the window manager to display its release version
Packit b099d7
in a dialog box\&.
Packit b099d7
.SS "Function Constraints"
Packit b099d7
.PP
Packit b099d7
Each function may be constrained as to which resource types can specify
Packit b099d7
the function (for example, menu pane) and also what context the function
Packit b099d7
can be used in (for example, the function is done to the selected client window)\&.
Packit b099d7
Function contexts are:
Packit b099d7
.IP "\fIroot\fP" 10
Packit b099d7
No client window or icon has been selected as an object for the function\&.
Packit b099d7
.IP "\fIwindow\fP" 10
Packit b099d7
A client window has been selected as an object for the function\&. This
Packit b099d7
includes the window\&'s title bar and frame\&. Some functions are applied only
Packit b099d7
when the window is in its normalized state (for example, \fBf\&.maximize\fP) or its maximized state (for example, \fBf\&.normalize\fP)\&.
Packit b099d7
.IP "\fIicon\fP" 10
Packit b099d7
An icon has been selected as an object for the function\&.
Packit b099d7
.PP
Packit b099d7
If a function is specified in a type of resource where it is not supported
Packit b099d7
or is invoked in a context that does not apply then the function is treated
Packit b099d7
as \fBf\&.nop\fP\&. The following table indicates the resource
Packit b099d7
types and function contexts in which window manager functions apply\&.
Packit b099d7
.PP
Packit b099d7
.TS
Packit b099d7
tab(?);
Packit b099d7
lw(2.289841i) lw(1.851594i) lw(1.358566i).
Packit b099d7
Function?Contexts?Resources
Packit b099d7
_
Packit b099d7
\fBf\&.beep\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.circle_down\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.circle_up\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.exec\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.focus_color\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.focus_key\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.kill\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.lower\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.maximize\fP?icon,window(normal)?button,key,menu
Packit b099d7
\fBf\&.menu\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.minimize\fP?window?button,key,menu
Packit b099d7
\fBf\&.move\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.next_cmap\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.next_key\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.nop\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.normalize\fP?icon,window(maximized)?button,key,menu
Packit b099d7
\fBf\&.normalize_and_raise\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.pack_icons\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.pass_keys\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.post_wmenu\fP?root,icon,window?button,key
Packit b099d7
\fBf\&.prev_cmap\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.prev_key\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.quit_mwm\fP?root?button,key,menu (root only)
Packit b099d7
\fBf\&.raise\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.raise_lower\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.refresh\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.refresh_win\fP?window?button,key,menu
Packit b099d7
\fBf\&.resize\fP?window?button,key,menu
Packit b099d7
\fBf\&.restart\fP?root?button,key,menu (root only)
Packit b099d7
\fBf\&.restore\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.restore_and_raise\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.screen\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.send_msg\fP?icon,window?button,key,menu
Packit b099d7
\fBf\&.separator\fP?root,icon,window?menu
Packit b099d7
\fBf\&.set_behavior\fP?root,icon,window?button,key,menu
Packit b099d7
\fBf\&.title\fP?root,icon,window?menu
Packit b099d7
\fBf\&.version\fP?root,icon,window?button,key,menu
Packit b099d7
.TE
Packit b099d7
.SH "WINDOW MANAGER EVENT SPECIFICATION"
Packit b099d7
.PP
Packit b099d7
Events are indicated as part of the specifications for button and key
Packit b099d7
binding sets, and menu panes\&. Button events have the following syntax:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fBbutton\fP =~[\fBmodifier_list\fP ]\fI<\fP\fBbutton_event_name\fP \fI>\fP
Packit b099d7
\fBmodifier_list\fP =~\fBmodifier_name\fP { \fBmodifier_name\fP}\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The following table indicates the values that can be used for \fBmodifier_name\fP\&. Note that [Alt] and [Meta] can be used interchangably
Packit b099d7
on some hardware\&.
Packit b099d7
.PP
Packit b099d7
.TS
Packit b099d7
tab(?);
Packit b099d7
lw(1.097588i) lw(4.402412i).
Packit b099d7
Modifier?Description
Packit b099d7
_
Packit b099d7
Ctrl?Control Key
Packit b099d7
Shift?Shift Key
Packit b099d7
Alt?Alt Key
Packit b099d7
Meta?Meta Key
Packit b099d7
Mod1?Modifier1
Packit b099d7
Mod2?Modifier2
Packit b099d7
Mod3?Modifier3
Packit b099d7
Mod4?Modifier4
Packit b099d7
Mod5?Modifier5
Packit b099d7
.TE
Packit b099d7
.PP
Packit b099d7
Locking modifiers are ignored when processing button and key bindings\&.
Packit b099d7
The following table lists keys that are interpreted as locking modifiers\&.
Packit b099d7
The X server may map some of these symbols to the Mod1 - Mod5 modifier keys\&.
Packit b099d7
These keys may or may not be available on your hardware: Key Symbol Caps Lock
Packit b099d7
Shift Lock Kana Lock Num Lock Scroll Lock The following table indicates the
Packit b099d7
values that can be used for \fBbutton_event_name\fP\&.
Packit b099d7
.PP
Packit b099d7
.TS
Packit b099d7
tab(?);
Packit b099d7
lw(1.290570i) lw(4.209430i).
Packit b099d7
Button?Description
Packit b099d7
_
Packit b099d7
Btn1Down?Button 1 Press
Packit b099d7
Btn1Up?Button 1 Release
Packit b099d7
Btn1Click?Button 1 Press and Release
Packit b099d7
Btn1Click2?Button 1 Double Click
Packit b099d7
Btn2Down?Button 2 Press
Packit b099d7
Btn2Up?Button 2 Release
Packit b099d7
Btn2Click?Button 2 Press and Release
Packit b099d7
Btn2Click2?Button 2 Double Click
Packit b099d7
Btn3Down?Button 3 Press
Packit b099d7
Btn3Up?Button 3 Release
Packit b099d7
Btn3Click?Button 3 Press and Release
Packit b099d7
Btn3Click2?Button 3 Double Click
Packit b099d7
Btn4Down?Button 4 Press
Packit b099d7
Btn4Up?Button 4 Release
Packit b099d7
Btn4Click?Button 4 Press and Release
Packit b099d7
Btn4Click2?Button 4 Double Click
Packit b099d7
Btn5Down?Button 5 Press
Packit b099d7
Btn5Up?Button 5 Release
Packit b099d7
Btn5Click?Button 5 Press and Release
Packit b099d7
Btn5Click2?Button 5 Double Click
Packit b099d7
.TE
Packit b099d7
.PP
Packit b099d7
Key events that are used by the window manager for menu mnemonics
Packit b099d7
and for binding to window manager functions are single key presses; key
Packit b099d7
releases are ignored\&. Key events have the following syntax:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fBkey\fP =~[\fBmodifier_list\fP] \fB<Key>\fP\fBkey_name\fP
Packit b099d7
\fBmodifier_list\fP =~\fBmodifier_name\fP { \fBmodifier_name\fP}\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
All modifiers specified are interpreted as being exclusive (this means
Packit b099d7
that only the specified modifiers can be present when the key event occurs)\&.
Packit b099d7
Modifiers for keys are the same as those that apply to buttons\&. The \fBkey_name\fP is an X11 keysym name\&. Keysym names can be found in the
Packit b099d7
\fBkeysymdef\&.h\fP file (remove the \fBXK_\fP
Packit b099d7
prefix)\&.
Packit b099d7
.SH "BUTTON BINDINGS"
Packit b099d7
.PP
Packit b099d7
The \fBbuttonBindings\fP resource value is the name of
Packit b099d7
a set of button bindings that are used to configure window manager behavior\&.
Packit b099d7
A window manager function can be done when a button press occurs with
Packit b099d7
the pointer over a framed client window, an icon or the root window\&. The
Packit b099d7
context for indicating where the button press applies is also the context
Packit b099d7
for invoking the window manager function when the button press is done
Packit b099d7
(significant for functions that are context sensitive)\&. The button binding
Packit b099d7
syntax is
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fIButtons\fP \fBbindings_set_name\fP
Packit b099d7
\fI{\fP
Packit b099d7
    \fBbutton\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
    \fBbutton\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
    \&.\&.\&.
Packit b099d7
    \fBbutton\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
\fI}\fP\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The syntax for the \fBcontext\fP specification is: \fBcontext\fP = \fBobject\fP[\fI|\fP \fBcontext\fP] \fBobject\fP = \fIroot\fP | \fIicon\fP | \fIwindow\fP | \fItitle\fP | \fIframe\fP | \fIborder\fP | \fIapp\fP The context specification indicates where the pointer must be
Packit b099d7
for the button binding to be effective\&. For example, a context of
Packit b099d7
\fIwindow\fP indicates that the pointer must be over a
Packit b099d7
client window or window management frame for the button binding to be effective\&.
Packit b099d7
The \fIframe\fP context is for the window management
Packit b099d7
frame around a client window (including the border and titlebar), the
Packit b099d7
\fIborder\fP context is for the border part of the window
Packit b099d7
management frame (not including the titlebar), the \fItitle\fP context is for the title area of the window management frame,
Packit b099d7
and the \fIapp\fP context is for the application
Packit b099d7
window (not including the window management frame)\&. If an \fBf\&.nop\fP function is specified for a button binding, the button binding
Packit b099d7
is not done\&.
Packit b099d7
.SH "KEY BINDINGS"
Packit b099d7
.PP
Packit b099d7
The \fBkeyBindings\fP resource value is the name of a set
Packit b099d7
of key bindings that are used to configure window manager behavior\&. A
Packit b099d7
window manager function can be done when a particular key is pressed\&. The
Packit b099d7
context in which the key binding applies is indicated in the key binding specification\&.
Packit b099d7
The valid contexts are the same as those that apply to button bindings\&. The
Packit b099d7
key binding syntax is:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fIKeys\fP \fBbindings_set_name\fP
Packit b099d7
\fI{\fP
Packit b099d7
    \fBkey\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
    \fBkey\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
    \&.\&.\&.
Packit b099d7
    \fBkey\fP    \fBcontext\fP    \fBfunction\fP
Packit b099d7
\fI}\fP\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
If an \fBf\&.nop\fP function is specified for a key binding,
Packit b099d7
the key binding is not done\&. If an \fBf\&.post_wmenu\fP or \fBf\&.menu\fP function is bound to a key, \fBmwm\fP automatically
Packit b099d7
uses the same key for removing the menu from the screen after it has been
Packit b099d7
popped up\&. The \fBcontext\fP specification syntax is the same
Packit b099d7
as for button bindings with one addition\&. The context \fIifkey\fP
Packit b099d7
may be specified for binding keys that may not be available on all displays\&.
Packit b099d7
If the key is not available and if \fIifkey\fP is in the context,
Packit b099d7
then reporting of the error message to the error log is suppressed\&. This feature
Packit b099d7
is useful for networked, heterogeneous environments\&. For key bindings, the
Packit b099d7
\fIframe\fP, \fItitle\fP,
Packit b099d7
\fIborder\fP, and \fIapp\fP
Packit b099d7
contexts are equivalent to the \fIwindow\fP context\&.
Packit b099d7
The context for a key event is the window or icon that has the keyboard input
Packit b099d7
focus (\fIroot\fP if no window or icon has the
Packit b099d7
keyboard input focus)\&.
Packit b099d7
.SH "MENU PANES"
Packit b099d7
.PP
Packit b099d7
Menus can be popped up using the \fBf\&.post_wmenu\fP and \fBf\&.menu\fP window manager functions\&. The context for window manager
Packit b099d7
functions that are done from a menu is \fIroot\fP,
Packit b099d7
\fIicon\fP or \fIwindow\fP depending
Packit b099d7
on how the menu was popped up\&. In the case of the \fIwindow\fP menu or menus popped up with a key binding, the location of
Packit b099d7
the keyboard input focus indicates the context\&. For menus popped up using
Packit b099d7
a button binding, the context of the button binding is the context of the
Packit b099d7
menu\&. The menu pane specification syntax is:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fIMenu\fP \fBmenu_name\fP
Packit b099d7
\fI{\fP
Packit b099d7
    \fBlabel\fP  [\fBmnemonic\fP]  [\fBaccelerator\fP ]   \fBfunction\fP
Packit b099d7
    \fBlabel\fP  [\fBmnemonic\fP]  [\fBaccelerator\fP ]   \fBfunction\fP
Packit b099d7
    \&.\&.\&.
Packit b099d7
    \fBlabel\fP  [\fBmnemonic\fP]  [\fBaccelerator\fP ]   \fBfunction\fP
Packit b099d7
\fI}\fP\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
Each line in the \fIMenu\fP specification identifies
Packit b099d7
the label for a menu item and the function to be done if the menu item is
Packit b099d7
selected\&. Optionally a menu button mnemonic and a menu button keyboard accelerator
Packit b099d7
may be specified\&. Mnemonics are functional only when the menu is posted and
Packit b099d7
keyboard traversal applies\&. The \fBlabel\fP may be a string or
Packit b099d7
a bitmap file\&. The label specification has the following syntax:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fBlabel\fP = \fBtext\fP | \fBbitmap_file\fP
Packit b099d7
\fBbitmap_file\fP = \fI@\fP\fBfile_name\fP
Packit b099d7
\fBtext\fP = \fBquoted_item\fP | \fBunquoted_item\fP\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The string encoding for labels must be compatible with the menu font
Packit b099d7
that is used\&. Labels are greyed out for menu items that do the \fBf\&.nop\fP function or an invalid function or a function that doesn\&'t
Packit b099d7
apply in the current context\&. A \fBmnemonic\fP specification
Packit b099d7
has the following syntax:
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CW\fBmnemonic\fP = \fI_\fP \fBcharacter\fP\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
The first matching \fBcharacter\fP in the label is underlined\&.
Packit b099d7
If there is no matching \fBcharacter\fP in the label, no mnemonic
Packit b099d7
is registered with the window manager for that label\&. Although the \fBcharacter\fP must exactly match a character in the label, the mnemonic
Packit b099d7
does not execute if any modifier (such as Shift) is pressed with the character
Packit b099d7
key\&. The \fBaccelerator\fP specification is a key event specification
Packit b099d7
with the same syntax as is used for key bindings to window manager functions\&.
Packit b099d7
.SH "INCLUDING FILES"
Packit b099d7
.PP
Packit b099d7
You may include other files into your mwmrc file by using the
Packit b099d7
\fIinclude\fP construct\&. For example,
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\f(CWINCLUDE
Packit b099d7
{
Packit b099d7
    /usr/local/shared/mwm\&.menus
Packit b099d7
    /home/kmt/personal/my\&.bindings
Packit b099d7
}\fR
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.PP
Packit b099d7
causes the files named to be read in and interpreted in order as an
Packit b099d7
additional part of the mwmrc file\&. \fIInclude\fP is a top-level
Packit b099d7
construct\&. It cannot be nested inside another construct\&.
Packit b099d7
.SH "WARNINGS"
Packit b099d7
.PP
Packit b099d7
Errors that occur during the processing of the resource description
Packit b099d7
file are recorded in: \fB$HOME/\&.mwm/errorlog\fP\&. Be sure to
Packit b099d7
check this file if the appearance or behavior of \fBmwm\fP
Packit b099d7
is not what you expect\&.
Packit b099d7
.SH "FILES"
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
\fB$HOME/$LANG/\&.mwmrc
Packit b099d7
$HOME/\&.mwmrc
Packit Service 1f15c3
/usr/X11R6/lib/X11/$LANG/system\&.mwmrc
Packit Service 1f15c3
/usr/X11R6/lib/X11/system\&.mwmrc\fP
Packit b099d7
.fi
Packit b099d7
.SH "RELATED INFORMATION"
Packit b099d7
.PP
Packit b099d7
\fBmwm\fP(1),
Packit b099d7
\fBX\fP(1)\&. 
Packit b099d7
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:36