Debian Codegraph @

doc/man/man4/mwmrc.4

raw ◀ ▶
Source reconstructed at patch state 0 of 2 — not the installed (fully patched) source.
2 Debian patches touch this file
1 '\" t
2 ...\" mwmrc.sgm /main/8 1996/09/08 21:43:59 rws $
3 .de P!
4 .fl
5 \!!1 setgray
6 .fl
7 \\&.\"
8 .fl
9 \!!0 setgray
10 .fl \" force out current output buffer
11 \!!save /psv exch def currentpoint translate 0 0 moveto
12 \!!/showpage{}def
13 .fl \" prolog
14 .sy sed -e 's/^/!/' \\$1\" bring in postscript file
15 \!!psv restore
16 .
17 .de pF
18 .ie \\*(f1 .ds f1 \\n(.f
19 .el .ie \\*(f2 .ds f2 \\n(.f
20 .el .ie \\*(f3 .ds f3 \\n(.f
21 .el .ie \\*(f4 .ds f4 \\n(.f
22 .el .tm ? font overflow
23 .ft \\$1
24 ..
25 .de fP
26 .ie !\\*(f4 \{\
27 . ft \\*(f4
28 . ds f4\"
29 ' br \}
30 .el .ie !\\*(f3 \{\
31 . ft \\*(f3
32 . ds f3\"
33 ' br \}
34 .el .ie !\\*(f2 \{\
35 . ft \\*(f2
36 . ds f2\"
37 ' br \}
38 .el .ie !\\*(f1 \{\
39 . ft \\*(f1
40 . ds f1\"
41 ' br \}
42 .el .tm ? font underflow
43 ..
44 .ds f1\"
45 .ds f2\"
46 .ds f3\"
47 .ds f4\"
48 .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
49 .TH "mwmrc" "special file"
50 .SH "NAME"
51 \fBmwmrc\fP \(em the
52 Motif Window Manager Resource Description File
53 .SH "DESCRIPTION"
54 .PP
55 The \fBmwmrc\fP file is a supplementary resource
56 file that controls much of the behavior of the Motif window manager \fBmwm\fP\&.
57 It contains descriptions of resources that cannot easily be
58 written using standard X Window System, Version 11 resource syntax\&. The resource
59 description file contains entries that are referred to by X resources in
60 defaults files (for example, \fB/usr/X11R6/lib/X11/app-defaults/Mwm\fP)
61 or in the \fBRESOURCE_MANAGER\fP property on the
62 root window\&. For example, the resource description file enables you to specify
63 different types of window menus; however, an X resource is used to specify
64 which of these window menus \fBmwm\fP should use for a particular
65 window\&.
66 .SS "Location"
67 .PP
68 The window manager searches for one of the following resource description
69 files, where \fI$LANG\fP is the value of the language environment
70 on a per-user basis:
71 .PP
72 .nf
73 \f(CW$HOME/$LANG/\&.mwmrc
74 $HOME/\&.mwmrc
75 /usr/X11R6/lib/X11/$LANG/system\&.mwmrc
76 /usr/X11R6/lib/X11/system\&.mwmrc\fR
77 .fi
78 .PP
79 .PP
80 The first file found is the first used\&. If no file is found, a
81 set of built-in specifications is used\&. A particular resource description
82 file can be selected using the \fIconfigFile\fP
83 resource\&. The following shows how a different resource description file can
84 be specified from the command line:
85 .PP
86 .nf
87 \f(CW/usr/X11R6/bin/X11/mwm -xrm "mwm*configFile: mymwmrc"\fR
88 .fi
89 .PP
90 .SS "Resource Types"
91 .PP
92 The following types of resources can be described in the mwm resource
93 description file:
94 .IP "\fBButtons\fP" 10
95 Window manager functions can be bound (associated) with button events\&.
96 .IP "\fBKeys\fP" 10
97 Window manager functions can be bound (associated) with key press
98 events\&.
99 .IP "\fBMenus\fP" 10
100 Menu panes can be used for the window menu and other menus posted with
101 key bindings and button bindings\&.
102 .SH "MWM RESOURCE DESCRIPTION FILE SYNTAX"
103 .PP
104 The \fBmwm\fP resource description file is a standard
105 text file that contains items of information separated by blanks, tabs, and
106 new lines characters\&. Blank lines are ignored\&. Items or characters can be
107 quoted to avoid special interpretation (for example, the comment character
108 can be quoted to prevent it from being interpreted as the comment character)\&.
109 A quoted item can be contained in double quotes (\fB" "\fP)\&.
110 Single characters can be quoted by preceding them by the back-slash character
111 (\fB\\\fP)\&. If a line ends with a back-slash, the next line is considered
112 a continuation of that line\&. All text from an unquoted \fB#\fP
113 to the end of the line is regarded as a comment and is not interpreted as
114 part of a resource description\&. If \fB!\fP is the first character
115 in a line, the line is regarded as a comment\&.
116 .SS "Window Manager Functions"
117 .PP
118 Window manager functions can be accessed with button and key bindings,
119 and with window manager menus\&. Functions are indicated as part of the specifications
120 for button and key binding sets, and menu panes\&. The function specification
121 has the following syntax:
122 .PP
123 .nf
124 \f(CW\fBfunction\fP = \fBfunction_name\fP [\fBfunction_args\fP]
125 \fBfunction_name\fP = \fBwindow manager function\fP
126 \fBfunction_args\fP = {\fBquoted_item\fP | \fBunquoted_item\fP}\fR
127 .fi
128 .PP
129 .PP
130 The following functions are supported\&. If a function is specified that
131 isn\&'t one of the supported functions then it is interpreted by \fBmwm\fP as \fBf\&.nop\fP\&.
132 .IP "\fBf\&.beep\fP" 10
133 This function causes a beep\&.
134 .IP "\fBf\&.circle_down\fP [ \fIicon\fP | \fIwindow\fP]" 10
135 This function causes the window or icon that is on the top of the window
136 stack to be put on the bottom of the window stack (so that it is no longer
137 obscuring any other window or icon)\&. This function affects only those windows
138 and icons that are obscuring other windows and icons, or that are obscured
139 by other windows and icons\&. Secondary windows (that is, transient windows)
140 are restacked with their associated primary window\&. Secondary windows always
141 stay on top of the associated primary window and there can be no other primary
142 windows between the secondary windows and their primary window\&. If an
143 \fIicon\fP function argument is specified, then the function
144 applies only to icons\&. If a \fIwindow\fP function
145 argument is specified then the function applies only to windows\&.
146 .IP "\fBf\&.circle_up\fP [ \fIicon\fP | \fIwindow\fP]" 10
147 This function raises the window or icon on the bottom of the window
148 stack (so that it is not obscured by any other windows)\&. This function affects
149 only those windows and icons that are obscuring other windows and icons, or
150 that are obscured by other windows and icons\&. Secondary windows (that is,
151 transient windows) are restacked with their associated primary window\&. If
152 an \fIicon\fP function argument is specified then
153 the function applies only to icons\&. If an \fIwindow\fP
154 function argument is specified then the function applies only to windows\&.
155 .IP "\fBf\&.exec\fP \fBcommand\fP (or \fI!\fP \fBcommand\fP)" 10
156 This function causes \fIcommand\fP to be
157 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\&.
158 .IP "\fBf\&.focus_color\fP" 10
159 This function sets the colormap focus to a client window\&. If this function
160 is done in a root context, then the default colormap (setup by the X Window
161 System for the screen where \fBmwm\fP is running) is installed
162 and there is no specific client window colormap focus\&. This function is treated
163 as \fBf\&.nop\fP if \fIcolormapFocusPolicy\fP
164 is not explicit\&.
165 .IP "\fBf\&.focus_key\fP" 10
166 This function sets the keyboard input focus to a client window or icon\&.
167 This function is treated as \fBf\&.nop\fP if \fIkeyboardFocusPolicy\fP is not explicit or the function is executed in a root context\&.
168 .IP "\fBf\&.kill\fP" 10
169 This function is used to close application windows\&. The actual processing
170 that occurs depends on the protocols that the application observes\&. The application
171 lists the protocols it observes in the \fBWM_PROTOCOLS\fP property
172 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\&.
173 If the application observes both \fBWM_DELETE_WINDOW\fP and \fBWM_SAVE_YOURSELF\fP, it is sent one message requesting the window
174 be deleted and another message advising it to save its state\&. If the application
175 observes only the \fBWM_SAVE_YOURSELF\fPprotocol \fI,\fP it is sent a message advising it to save its state\&. After a
176 delay (specified by the resource \fIquitTimeout\fP), the application\&'s
177 connection to the X server is terminated\&. If the application observes neither
178 of these protocols, its connection to the X server is terminated\&.
179 .IP "\fBf\&.lower\fP\ [\fI-\fP \fBclient\fP | \fIwithin\fP\ | \fIfreeFamily\fP]" 10
180 This function lowers a primary window to the bottom of the global window
181 stack (where it obscures no other window) and lowers the secondary window
182 (transient window or dialog box) within the client family\&. The arguments to
183 this function are mutually exclusive\&. The \fIclient\fP
184 argument indicates the name or class of a client to lower\&. The name or class
185 of a client appears in the \fBWM_CLASS\fP property on the
186 client\&'s top-level window\&. If the \fIclient\fP
187 argument is not specified, the context that the function was invoked in indicates
188 the window or icon to lower\&. Specifying \fIwithin\fP
189 lowers the secondary window within the family (staying above the parent) but
190 does not lower the client family in the global window stack\&. Specifying \fIfreeFamily\fP lowers the window to the bottom of the global windows
191 stack from its local family stack\&.
192 .IP "\fBf\&.maximize\fP" 10
193 This function causes a client window to be displayed with its maximum
194 size\&. Refer to the \fImaximumClientSize\fP, \fImaximumMaximumSize\fP, and \fIlimitResize\fP resources in \fBmwm\fP(1)\&.
195 .IP "\fBf\&.menu\fP \fImenu_name\fP" 10
196 This function associates a cascading (pull-right) menu with a menu
197 pane entry or a menu with a button or key binding\&. The \fImenu_name\fP function argument identifies the menu to be used\&.
198 .IP "\fBf\&.minimize\fP" 10
199 This function causes a client window to be minimized (iconified)\&. When
200 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
201 on the bottom of the window stack (such that it obscures no other window)\&.
202 If an icon box is used, then the client\&'s icon changes to its iconified form
203 inside the icon box\&. Secondary windows (that is, transient windows) are minimized
204 with their associated primary window\&. There is only one icon for a primary
205 window and all its secondary windows\&.
206 .IP "\fBf\&.move\fP" 10
207 This function initiates an interactive move of a client window\&.
208 .IP "\fBf\&.next_cmap\fP" 10
209 This function installs the next colormap in the list of colormaps for
210 the window with the colormap focus\&.
211 .IP "\fBf\&.next_key\fP [ \fIicon\fP | \fIwindow\fP | \fItransient\fP]" 10
212 This function sets the keyboard input focus to the next window/icon
213 in the set of windows/icons managed by the window manager (the ordering
214 of this set is based on the stacking of windows on the screen)\&. This function
215 is treated as \fBf\&.nop\fP if \fBkeyboardFocusPolicy\fP
216 is not explicit\&. The keyboard input focus is only moved to windows that do
217 not have an associated secondary window that is application modal\&. If the
218 \fItransient\fP argument is specified, then transient (secondary)
219 windows are traversed (otherwise, if only \fIwindow\fP
220 is specified, traversal is done only to the last focused window in a transient
221 group)\&. If an \fIicon\fP function argument is specified,
222 then the function applies only to icons\&. If a \fIwindow\fP function argument is specified, then the function applies only to
223 windows\&.
224 .IP "\fBf\&.nop\fP" 10
225 This function does nothing\&.
226 .IP "\fBf\&.normalize\fP" 10
227 This function causes a client window to be displayed with its normal
228 size\&. Secondary windows (that is, transient windows) are placed in their normal
229 state along with their associated primary window\&.
230 .IP "\fBf\&.normalize_and_raise\fP" 10
231 This function causes a client window to be displayed with its normal
232 size and raised to the top of the window stack\&. Secondary windows (that is,
233 transient windows) are placed in their normal state along with their associated
234 primary window\&.
235 .IP "\fBf\&.pack_icons\fP" 10
236 This function is used to relayout icons (based on the layout policy
237 being used) on the root window or in the icon box\&. In general this causes
238 icons to be "packed" into the icon grid\&.
239 .IP "\fBf\&.pass_keys\fP" 10
240 This function is used to enable/disable (toggle) processing of key bindings
241 for window manager functions\&. When it disables key binding processing all
242 keys are passed on to the window with the keyboard input focus and no window
243 manager functions are invoked\&. If the \fBf\&.pass_keys\fP function
244 is invoked with a key binding to disable key binding processing the same key
245 binding can be used to enable key binding processing\&.
246 .IP "\fBf\&.post_wmenu\fP" 10
247 This function is used to post the window menu\&. If a key is used to post
248 the window menu and a window menu button is present, the window menu is automatically
249 placed with its top-left corner at the bottom-left corner of the window menu
250 button for the client window\&. If no window menu button is present, the window
251 menu is placed at the top-left corner of the client window\&.
252 .IP "\fBf\&.prev_cmap\fP" 10
253 This function installs the previous colormap in the list of colormaps
254 for the window with the colormap focus\&.
255 .IP "\fBf\&.prev_key\fP [ \fIicon\fP | \fIwindow\fP | \fItransient\fP]" 10
256 This function sets the keyboard input focus to the previous window/icon
257 in the set of windows/icons managed by the window manager (the ordering
258 of this set is based on the stacking of windows on the screen)\&. This function
259 is treated as \fBf\&.nop\fP if \fIkeyboardFocusPolicy\fP is not explicit\&. The keyboard input focus is only moved to windows
260 that do not have an associated secondary window that is application modal\&.
261 If the \fItransient\fP argument is specified, then
262 transient (secondary) windows are traversed (otherwise, if only \fIwindow\fP is specified, traversal is done only to the last focused window
263 in a transient group)\&. If an \fIicon\fP function
264 argument is specified then the function applies only to icons\&. If an
265 \fIwindow\fP function argument is specified then the function
266 applies only to windows\&.
267 .IP "\fBf\&.quit_mwm\fP" 10
268 This function terminates mwm (but NOT the X window system)\&.
269 .IP "\fBf\&.raise\fP\ [\fI-\fP\fIclient\fP | \fIwithin\fP | \fIfreeFamily\fP]" 10
270 This function raises a primary window to the top of the global window
271 stack (where it is obscured by no other window) and raises the secondary window
272 (transient window or dialog box) within the client family\&. The arguments to
273 this function are mutually exclusive\&. The \fIclient\fP
274 argument indicates the name or class of a client to lower\&. If the \fIclient\fP
275 is not specified, the context that the function
276 was invoked in indicates the window or icon to lower\&. Specifying \fIwithin\fP raises the secondary window within the family but does not
277 raise the client family in the global window stack\&. Specifying \fIfreeFamily\fP raises the window to the top of its local family stack
278 and raises the family to the top of the global window stack\&.
279 .IP "\fBf\&.raise_lower\fP\ [ \fIwithin\fP | \fIfreeFamily\fP]" 10
280 This function raises a primary window to the top of the global window
281 stack if it is partially obscured by another window; otherwise, it lowers
282 the window to the bottom of the window stack\&. The arguments to this function
283 are mutually exclusive\&. Specifying \fIwithin\fP
284 raises a secondary window within the family (staying above the parent window),
285 if it is partially obscured by another window in the application\&'s family;
286 otherwise, it lowers the window to the bottom of the family stack\&. It has
287 no effect on the global window stacking order\&. Specifying \fIfreeFamily\fP raises the window to the top of its local family stack, if obscured
288 by another window, and raises the family to the top of the global window
289 stack; otherwise, it lowers the window to the bottom of its local family stack
290 and lowers the family to the bottom of the global window stack\&.
291 .IP "\fBf\&.refresh\fP" 10
292 This function causes all windows to be redrawn\&.
293 .IP "\fBf\&.refresh_win\fP" 10
294 This function causes a client window to be redrawn\&.
295 .IP "\fBf\&.resize\fP" 10
296 This function initiates an interactive resize of a client window\&.
297 .IP "\fBf\&.restore\fP" 10
298 This function restores the previous state of an icon\&'s associated window\&.
299 If a maximized window is iconified, then \fBf\&.restore\fP restores
300 it to its maximized state\&. If a normal window is iconified, then \fBf\&.restore\fP restores it to its normalized state\&.
301 .IP "\fBf\&.restore_and_raise\fP" 10
302 This function restores the previous state of an icon\&'s associated window
303 and raises the window to the top of the window stack\&. If a maximized window
304 is iconified, then \fBf\&.restore_and_raise\fP restores it to
305 its maximized state and raises it to the top of the window stack\&. If a normal
306 window is iconified, then \fBf\&.restore_and_raise\fP restores
307 it to its normalized state and raises it to the top of the window stack\&.
308 .IP "\fBf\&.restart\fP" 10
309 This function causes mwm to be restarted (effectively terminated and
310 re-executed)\&. Restart is necessary for \fBmwm\fP to incorporate
311 changes in both the \fBmwmrc\fP file and X resources\&.
312 .IP "\fBf\&.screen\fP\ [ \fInext\fP | \fIprev\fP | \fIback\fP | \fIscreen_number\fP]" 10
313 This function causes the pointer to be warp to a specific screen number
314 or to the \fInext\fP, \fIprevious\fP, or last visited (\fIback\fP)
315 screen\&. The arguments to this function are mutually exclusive\&. The
316 \fIscreen_number\fP argument indicates the screen number
317 that the pointer is to be warped\&. Screens are numbered starting from screen
318 0\&. Specifying \fInext\fP cause the pointer to warp
319 to the next managed screen (skipping over any unmanaged screens)\&. Specifying
320 \fIprev\fP cause the pointer to warp to the previous managed
321 screen (skipping over any unmanaged screens)\&. Specifying \fIback\fP cause the pointer to warp to the last visited screen\&.
322 .IP "\fBf\&.send_msg\fP \fImessage_number\fP" 10
323 This function sends an \fBXClientMessageEvent\fR of type \fB_MOTIF_WM_MESSAGES\fP with
324 \fImessage_type\fP set to \fImessage_number\fP\&.
325 The client message is sent only if \fImessage_number\fP
326 is included in the client\&'s \fB_MOTIF_WM_MESSAGES\fP
327 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\&.
328 .IP "\fBf\&.separator\fP" 10
329 This function causes a menu separator to be put in the menu pane at
330 the specified location (the label is ignored)\&.
331 .IP "\fBf\&.set_behavior\fP" 10
332 This function causes the window manager to restart with the default
333 behavior (if a custom behavior is configured) or a custom behavior (if a
334 default behavior is configured)\&. By default this is bound to \fIShift\ Ctrl\ Alt\ <Key>!\fP\&.
335 .IP "\fBf\&.title\fP" 10
336 This function inserts a title in the menu pane at the specified location\&.
337 .IP "\fBf\&.version\fP" 10
338 This function causes the window manager to display its release version
339 in a dialog box\&.
340 .SS "Function Constraints"
341 .PP
342 Each function may be constrained as to which resource types can specify
343 the function (for example, menu pane) and also what context the function
344 can be used in (for example, the function is done to the selected client window)\&.
345 Function contexts are:
346 .IP "\fIroot\fP" 10
347 No client window or icon has been selected as an object for the function\&.
348 .IP "\fIwindow\fP" 10
349 A client window has been selected as an object for the function\&. This
350 includes the window\&'s title bar and frame\&. Some functions are applied only
351 when the window is in its normalized state (for example, \fBf\&.maximize\fP) or its maximized state (for example, \fBf\&.normalize\fP)\&.
352 .IP "\fIicon\fP" 10
353 An icon has been selected as an object for the function\&.
354 .PP
355 If a function is specified in a type of resource where it is not supported
356 or is invoked in a context that does not apply then the function is treated
357 as \fBf\&.nop\fP\&. The following table indicates the resource
358 types and function contexts in which window manager functions apply\&.
359 .PP
360 .TS
361 tab();
362 lw(2.289841i) lw(1.851594i) lw(1.358566i).
363 FunctionContextsResources
364 _
365 \fBf\&.beep\fProot,icon,windowbutton,key,menu
366 \fBf\&.circle_down\fProot,icon,windowbutton,key,menu
367 \fBf\&.circle_up\fProot,icon,windowbutton,key,menu
368 \fBf\&.exec\fProot,icon,windowbutton,key,menu
369 \fBf\&.focus_color\fProot,icon,windowbutton,key,menu
370 \fBf\&.focus_key\fProot,icon,windowbutton,key,menu
371 \fBf\&.kill\fPicon,windowbutton,key,menu
372 \fBf\&.lower\fProot,icon,windowbutton,key,menu
373 \fBf\&.maximize\fPicon,window(normal)button,key,menu
374 \fBf\&.menu\fProot,icon,windowbutton,key,menu
375 \fBf\&.minimize\fPwindowbutton,key,menu
376 \fBf\&.move\fPicon,windowbutton,key,menu
377 \fBf\&.next_cmap\fProot,icon,windowbutton,key,menu
378 \fBf\&.next_key\fProot,icon,windowbutton,key,menu
379 \fBf\&.nop\fProot,icon,windowbutton,key,menu
380 \fBf\&.normalize\fPicon,window(maximized)button,key,menu
381 \fBf\&.normalize_and_raise\fPicon,windowbutton,key,menu
382 \fBf\&.pack_icons\fProot,icon,windowbutton,key,menu
383 \fBf\&.pass_keys\fProot,icon,windowbutton,key,menu
384 \fBf\&.post_wmenu\fProot,icon,windowbutton,key
385 \fBf\&.prev_cmap\fProot,icon,windowbutton,key,menu
386 \fBf\&.prev_key\fProot,icon,windowbutton,key,menu
387 \fBf\&.quit_mwm\fProotbutton,key,menu (root only)
388 \fBf\&.raise\fProot,icon,windowbutton,key,menu
389 \fBf\&.raise_lower\fPicon,windowbutton,key,menu
390 \fBf\&.refresh\fProot,icon,windowbutton,key,menu
391 \fBf\&.refresh_win\fPwindowbutton,key,menu
392 \fBf\&.resize\fPwindowbutton,key,menu
393 \fBf\&.restart\fProotbutton,key,menu (root only)
394 \fBf\&.restore\fPicon,windowbutton,key,menu
395 \fBf\&.restore_and_raise\fPicon,windowbutton,key,menu
396 \fBf\&.screen\fProot,icon,windowbutton,key,menu
397 \fBf\&.send_msg\fPicon,windowbutton,key,menu
398 \fBf\&.separator\fProot,icon,windowmenu
399 \fBf\&.set_behavior\fProot,icon,windowbutton,key,menu
400 \fBf\&.title\fProot,icon,windowmenu
401 \fBf\&.version\fProot,icon,windowbutton,key,menu
402 .TE
403 .SH "WINDOW MANAGER EVENT SPECIFICATION"
404 .PP
405 Events are indicated as part of the specifications for button and key
406 binding sets, and menu panes\&. Button events have the following syntax:
407 .PP
408 .nf
409 \f(CW\fBbutton\fP =~[\fBmodifier_list\fP ]\fI<\fP\fBbutton_event_name\fP \fI>\fP
410 \fBmodifier_list\fP =~\fBmodifier_name\fP { \fBmodifier_name\fP}\fR
411 .fi
412 .PP
413 .PP
414 The following table indicates the values that can be used for \fBmodifier_name\fP\&. Note that [Alt] and [Meta] can be used interchangably
415 on some hardware\&.
416 .PP
417 .TS
418 tab();
419 lw(1.097588i) lw(4.402412i).
420 ModifierDescription
421 _
422 CtrlControl Key
423 ShiftShift Key
424 AltAlt Key
425 MetaMeta Key
426 Mod1Modifier1
427 Mod2Modifier2
428 Mod3Modifier3
429 Mod4Modifier4
430 Mod5Modifier5
431 .TE
432 .PP
433 Locking modifiers are ignored when processing button and key bindings\&.
434 The following table lists keys that are interpreted as locking modifiers\&.
435 The X server may map some of these symbols to the Mod1 - Mod5 modifier keys\&.
436 These keys may or may not be available on your hardware: Key Symbol Caps Lock
437 Shift Lock Kana Lock Num Lock Scroll Lock The following table indicates the
438 values that can be used for \fBbutton_event_name\fP\&.
439 .PP
440 .TS
441 tab();
442 lw(1.290570i) lw(4.209430i).
443 ButtonDescription
444 _
445 Btn1DownButton 1 Press
446 Btn1UpButton 1 Release
447 Btn1ClickButton 1 Press and Release
448 Btn1Click2Button 1 Double Click
449 Btn2DownButton 2 Press
450 Btn2UpButton 2 Release
451 Btn2ClickButton 2 Press and Release
452 Btn2Click2Button 2 Double Click
453 Btn3DownButton 3 Press
454 Btn3UpButton 3 Release
455 Btn3ClickButton 3 Press and Release
456 Btn3Click2Button 3 Double Click
457 Btn4DownButton 4 Press
458 Btn4UpButton 4 Release
459 Btn4ClickButton 4 Press and Release
460 Btn4Click2Button 4 Double Click
461 Btn5DownButton 5 Press
462 Btn5UpButton 5 Release
463 Btn5ClickButton 5 Press and Release
464 Btn5Click2Button 5 Double Click
465 .TE
466 .PP
467 Key events that are used by the window manager for menu mnemonics
468 and for binding to window manager functions are single key presses; key
469 releases are ignored\&. Key events have the following syntax:
470 .PP
471 .nf
472 \f(CW\fBkey\fP =~[\fBmodifier_list\fP] \fB<Key>\fP\fBkey_name\fP
473 \fBmodifier_list\fP =~\fBmodifier_name\fP { \fBmodifier_name\fP}\fR
474 .fi
475 .PP
476 .PP
477 All modifiers specified are interpreted as being exclusive (this means
478 that only the specified modifiers can be present when the key event occurs)\&.
479 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
480 \fBkeysymdef\&.h\fP file (remove the \fBXK_\fP
481 prefix)\&.
482 .SH "BUTTON BINDINGS"
483 .PP
484 The \fBbuttonBindings\fP resource value is the name of
485 a set of button bindings that are used to configure window manager behavior\&.
486 A window manager function can be done when a button press occurs with
487 the pointer over a framed client window, an icon or the root window\&. The
488 context for indicating where the button press applies is also the context
489 for invoking the window manager function when the button press is done
490 (significant for functions that are context sensitive)\&. The button binding
491 syntax is
492 .PP
493 .nf
494 \f(CW\fIButtons\fP \fBbindings_set_name\fP
495 \fI{\fP
496 \fBbutton\fP \fBcontext\fP \fBfunction\fP
497 \fBbutton\fP \fBcontext\fP \fBfunction\fP
498 \&.\&.\&.
499 \fBbutton\fP \fBcontext\fP \fBfunction\fP
500 \fI}\fP\fR
501 .fi
502 .PP
503 .PP
504 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
505 for the button binding to be effective\&. For example, a context of
506 \fIwindow\fP indicates that the pointer must be over a
507 client window or window management frame for the button binding to be effective\&.
508 The \fIframe\fP context is for the window management
509 frame around a client window (including the border and titlebar), the
510 \fIborder\fP context is for the border part of the window
511 management frame (not including the titlebar), the \fItitle\fP context is for the title area of the window management frame,
512 and the \fIapp\fP context is for the application
513 window (not including the window management frame)\&. If an \fBf\&.nop\fP function is specified for a button binding, the button binding
514 is not done\&.
515 .SH "KEY BINDINGS"
516 .PP
517 The \fBkeyBindings\fP resource value is the name of a set
518 of key bindings that are used to configure window manager behavior\&. A
519 window manager function can be done when a particular key is pressed\&. The
520 context in which the key binding applies is indicated in the key binding specification\&.
521 The valid contexts are the same as those that apply to button bindings\&. The
522 key binding syntax is:
523 .PP
524 .nf
525 \f(CW\fIKeys\fP \fBbindings_set_name\fP
526 \fI{\fP
527 \fBkey\fP \fBcontext\fP \fBfunction\fP
528 \fBkey\fP \fBcontext\fP \fBfunction\fP
529 \&.\&.\&.
530 \fBkey\fP \fBcontext\fP \fBfunction\fP
531 \fI}\fP\fR
532 .fi
533 .PP
534 .PP
535 If an \fBf\&.nop\fP function is specified for a key binding,
536 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
537 uses the same key for removing the menu from the screen after it has been
538 popped up\&. The \fBcontext\fP specification syntax is the same
539 as for button bindings with one addition\&. The context \fIifkey\fP
540 may be specified for binding keys that may not be available on all displays\&.
541 If the key is not available and if \fIifkey\fP is in the context,
542 then reporting of the error message to the error log is suppressed\&. This feature
543 is useful for networked, heterogeneous environments\&. For key bindings, the
544 \fIframe\fP, \fItitle\fP,
545 \fIborder\fP, and \fIapp\fP
546 contexts are equivalent to the \fIwindow\fP context\&.
547 The context for a key event is the window or icon that has the keyboard input
548 focus (\fIroot\fP if no window or icon has the
549 keyboard input focus)\&.
550 .SH "MENU PANES"
551 .PP
552 Menus can be popped up using the \fBf\&.post_wmenu\fP and \fBf\&.menu\fP window manager functions\&. The context for window manager
553 functions that are done from a menu is \fIroot\fP,
554 \fIicon\fP or \fIwindow\fP depending
555 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
556 the keyboard input focus indicates the context\&. For menus popped up using
557 a button binding, the context of the button binding is the context of the
558 menu\&. The menu pane specification syntax is:
559 .PP
560 .nf
561 \f(CW\fIMenu\fP \fBmenu_name\fP
562 \fI{\fP
563 \fBlabel\fP [\fBmnemonic\fP] [\fBaccelerator\fP ] \fBfunction\fP
564 \fBlabel\fP [\fBmnemonic\fP] [\fBaccelerator\fP ] \fBfunction\fP
565 \&.\&.\&.
566 \fBlabel\fP [\fBmnemonic\fP] [\fBaccelerator\fP ] \fBfunction\fP
567 \fI}\fP\fR
568 .fi
569 .PP
570 .PP
571 Each line in the \fIMenu\fP specification identifies
572 the label for a menu item and the function to be done if the menu item is
573 selected\&. Optionally a menu button mnemonic and a menu button keyboard accelerator
574 may be specified\&. Mnemonics are functional only when the menu is posted and
575 keyboard traversal applies\&. The \fBlabel\fP may be a string or
576 a bitmap file\&. The label specification has the following syntax:
577 .PP
578 .nf
579 \f(CW\fBlabel\fP = \fBtext\fP | \fBbitmap_file\fP
580 \fBbitmap_file\fP = \fI@\fP\fBfile_name\fP
581 \fBtext\fP = \fBquoted_item\fP | \fBunquoted_item\fP\fR
582 .fi
583 .PP
584 .PP
585 The string encoding for labels must be compatible with the menu font
586 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
587 apply in the current context\&. A \fBmnemonic\fP specification
588 has the following syntax:
589 .PP
590 .nf
591 \f(CW\fBmnemonic\fP = \fI_\fP \fBcharacter\fP\fR
592 .fi
593 .PP
594 .PP
595 The first matching \fBcharacter\fP in the label is underlined\&.
596 If there is no matching \fBcharacter\fP in the label, no mnemonic
597 is registered with the window manager for that label\&. Although the \fBcharacter\fP must exactly match a character in the label, the mnemonic
598 does not execute if any modifier (such as Shift) is pressed with the character
599 key\&. The \fBaccelerator\fP specification is a key event specification
600 with the same syntax as is used for key bindings to window manager functions\&.
601 .SH "INCLUDING FILES"
602 .PP
603 You may include other files into your mwmrc file by using the
604 \fIinclude\fP construct\&. For example,
605 .PP
606 .nf
607 \f(CWINCLUDE
608 {
609 /usr/local/shared/mwm\&.menus
610 /home/kmt/personal/my\&.bindings
611 }\fR
612 .fi
613 .PP
614 .PP
615 causes the files named to be read in and interpreted in order as an
616 additional part of the mwmrc file\&. \fIInclude\fP is a top-level
617 construct\&. It cannot be nested inside another construct\&.
618 .SH "WARNINGS"
619 .PP
620 Errors that occur during the processing of the resource description
621 file are recorded in: \fB$HOME/\&.mwm/errorlog\fP\&. Be sure to
622 check this file if the appearance or behavior of \fBmwm\fP
623 is not what you expect\&.
624 .SH "FILES"
625 .PP
626 .nf
627 \fB$HOME/$LANG/\&.mwmrc
628 $HOME/\&.mwmrc
629 /usr/X11R6/lib/X11/$LANG/system\&.mwmrc
630 /usr/X11R6/lib/X11/system\&.mwmrc\fP
631 .fi
632 .SH "RELATED INFORMATION"
633 .PP
634 \fBmwm\fP(1),
635 \fBX\fP(1)\&.
636 ...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:36