1FvwmEvent(1) Fvwm Modules FvwmEvent(1)
2
6 FvwmEvent - the fvwm event module
7
9 FvwmEvent is a more versatile replacement for FvwmAudio. It can in
10 general be used to hook any fvwm function or program to any window man‐
11 ager event. E.g: Delete unwanted Netscape Pop ups or application error
12 pop ups as they appear, play sounds, log events to a file and the like.
13 Be creative, you'll find a use for it.
14 FvwmEvent is spawned by fvwm, so no command line invocation will work.
16 From within the .fvwm2rc file, FvwmEvent is spawned as follows:
17 Module FvwmEvent
19 or from within an fvwm pop-up menu:
21 DestroyMenu Module-Popup
23 AddToMenu Module-Popup "Modules" Title
24 + "Event" Module FvwmEvent
25 + "Auto" Module FvwmAuto 200
26 + "Buttons" Module FvwmButtons
27 + "Console" Module FvwmConsole
28 + "Ident" Module FvwmIdent
29 + "Banner" Module FvwmBanner
30 + "Pager" Module FvwmPager 0 3
31
34 The FvwmEvent module communicates with the fvwm window manager to bind
35 actions to window manager events. Different actions may be assigned to
36 distinct window manager events.
37 FvwmEvent can be used to bind sound files to events like FvwmAudio
39 (RiP) did. It can be used for logging event traces to a log file, while
40 debugging fvwm.
41 FvwmEvent can also have builtin support for the rplay library. (her‐
43 itage of FvwmAudio)
44
47 The invocation method was shown in the synopsis section. No command
48 line invocation is possible. FvwmEvent must be invoked by the fvwm win‐
49 dow manager. FvwmEvent accepts a single argument:
50 -audio Enables FvwmAudio compatibility mode.
53 alias Makes FvwmEvent use alias as its name. This affects which lines
56 from the user's configuration file are used.
57 Invoking FvwmEvent as FvwmAudio (either by using an alias or
59 creating a symlink) enables FvwmAudio compatibility mode.
60
65 FvwmEvent gets config info from fvwm's module configuration database
66 (see fvwm(1), section MODULE COMMANDS), and looks for certain configu‐
67 ration options:
68 *FvwmEvent: Cmd command
71 This determines the fvwm function that is to be called with the
72 event parameters. You might want to do one of the following
73 (details below):
74 # play sounds
76 *FvwmEvent: Cmd builtin-rplay
77 # execute distinct fvwm functions
79 *FvwmEvent: Cmd
80 # execute distinct external programs
82 *FvwmEvent: Cmd exec
83 This version of FvwmEvent has builtin rplay support which does
85 not need to invoke an external audio player to play sounds. The
86 rplay support is enabled when FvwmEvent is compiled with
87 HAVE_RPLAY defined and when FvwmEvent: Cmd is set to builtin-
88 rplay. See remarks below if FvwmEvent is invoked in FvwmAudio
89 compatibility mode.
90 For example:
92 *FvwmEvent: Cmd builtin-rplay
94 *FvwmEvent: add_window drip.au
95 rplay can be obtained via anonymous ftp at
97 <URL:ftp://ftp.sdsu.edu/pub/rplay> or
99 <URL:ftp://ftp.x.org/contrib/Event/audio/rplay>
100 FvwmEvent also has support for any other external program. e.g:
102 the rsynth 'say' command:
103 *FvwmEvent: Cmd "Exec /rsynth/say"
105 *FvwmEvent: destroy_window "window closed"
106 You can also use fvwm's builtin Echo command as FvwmEvent: Cmd
108 to obtain debug output for fvwm events quietly. I used this
109 setup to debug FvwmAuto:
110 *FvwmEvent: Cmd Echo
112 *FvwmEvent: focus_change "focus change"
113 *FvwmEvent: raise_window "raise window"
114 You can even call different shell commands for each event just
116 by setting
117 *FvwmEvent: Cmd exec
119 *FvwmEvent: add_window 'killname "APPL ERROR"'
120 *FvwmEvent: PassId
123 Specifies that the event action will have an ID parameter added
124 to the end of the command line. Most events will have the win‐
125 dowID of the window that the event refers to, new_desk will have
126 the new desk number. The windowID is a hexadecimal string pre‐
127 ceded by 0x, desk numbers are decimal.
128 *FvwmEvent: window-manager-event action-or-filename
131 Binds particular actions to window manager events.
132 e.g. for audio-events:
134 *FvwmEvent: startup TaDa.au
136 *FvwmEvent: shutdown Elvis_Left.au
137 *FvwmEvent: unknown doh.au
138 *FvwmEvent: new_page beam_trek.au
140 *FvwmEvent: new_desk beam_trek.au
141 *FvwmEvent: old_add_window drip.au
142 *FvwmEvent: raise_window swoosh.au
143 *FvwmEvent: lower_window swoosh.au
144 *FvwmEvent: old_configure_window hammer.au
145 *FvwmEvent: focus_change boing.au
146 *FvwmEvent: enter_window boing.au
147 *FvwmEvent: leave_window boing.au
148 *FvwmEvent: destroy_window explosion.au
149 *FvwmEvent: iconify ploop.au
150 *FvwmEvent: deiconify ploop.au
151 *FvwmEvent: window_name huh.au
152 *FvwmEvent: icon_name beep.au
153 *FvwmEvent: visible_icon_name beep.au
154 *FvwmEvent: res_class beep.au
155 *FvwmEvent: res_name beep.au
156 *FvwmEvent: end_windowlist twang.au
157 *FvwmEvent: icon_location beep.au
159 *FvwmEvent: map beep.au
160 *FvwmEvent: error beep.au
161 *FvwmEvent: config_info beep.au
162 *FvwmEvent: end_config_info beep.au
163 *FvwmEvent: icon_file beep.au
164 *FvwmEvent: default_icon beep.au
165 *FvwmEvent: string plapper.au
166 *FvwmEvent: mini_icon beep.au
167 *FvwmEvent: windowshade beep.au
168 *FvwmEvent: dewindowshade beep.au
169 *FvwmEvent: visible_name beep.au
171 *FvwmEvent: sendconfig beep.au
172 *FvwmEvent: restack beep.au
173 *FvwmEvent: add_window beep.au
174 *FvwmEvent: configure_window beep.au
175 *FvwmEvent: visible_icon_name beep.au
177 *FvwmEvent: enter_window beep.au
178 *FvwmEvent: leave_window beep.au
179 *FvwmEvent: property_change beep.au
180 The window related event handlers are executed within a window
182 context. Previously PassId was used for this purpose, but now
183 using PassId is not needed.
184 Note: The enter_window event is generated when the pointer
186 enters a window. With the -passid option, that window's id is
187 passed to fvwm. An enter_window event is generated too when the
188 pointer leaves a window and moves into the root window. In this
189 case, the id passed is 0.
190 Note: When the shutdown event arrives, FvwmEvent may be killed
192 before it can trigger the associated action.
193 Provided fvwm supports it (not yet), there's an additional event
195 to replace all fvwm beeps with a sound:
196 *FvwmEvent: beep beep.au
198 The toggle_paging event will be supported, as soon, as it's res‐
200 urrected by fvwm:
201 *FvwmEvent: toggle_paging fwop.au
203 *FvwmEvent: Delay 5
206 Specifies that an event-action will only be executed if it
207 occurs at least 5 seconds after the previous event. Events that
208 occur during the delay period are ignored. This option is use‐
209 ful if you don't want several sounds playing at the same time.
210 The default delay is 0 which disables the Event delay.
211 *FvwmEvent: StartDelay delay
214 Specifies that an event-action will only be executed if it
215 occurs at least delay seconds after the startup event. Events
216 that occur during the delay period are ignored. This option is
217 useful when fvwm starts and restarts using an audio player. The
218 default delay is 0.
219
222 The following options are only valid with builtin rplay support. i.e:
223 when FvwmEvent was compiled with HAVE_RPLAY defined. They are used
224 only if FvwmEvent: Cmd is set to builtin-rplay.
225 *FvwmEvent: RplayHost hostname
229 Specifies what host the rplay sounds will play on. The hostname
230 can also be an environment variable such as $HOSTDISPLAY.
231 *FvwmEvent: RplayPriority 0
234 Specifies what priority will be assigned to the rplay sounds
235 when they are played.
236 *FvwmEvent: RplayVolume 127
239 Specifies what volume will be assigned to the sounds when they
240 are played.
241
244 When invoked in FvwmAudio compatibility mode (see above), FvwmEvent
245 accepts the following options to provide backwards compatibility for
246 FvwmAudio:
247 *FvwmEvent: PlayCmd command
250 This is equivalent to using *FvwmEvent: Cmd to Exec commands.
251 This determines the independent audio player program that will
252 actually play the sounds. If the play command is set to builtin-
253 rplay then the builtin rplay support will be used.
254 *FvwmAudio: Dir directory
257 Specifies the directory to look for the audio files. This
258 option is ignored when rplay is used.
259
262 It's REALLY noisy when fvwm starts and restarts using an audio player.
263 You can use FvwmEvent: StartDelay to fix this problem.
264
267 This module has evolved of FvwmAudio, which in term is heavily based on
268 a similar Fvwm module called FvwmSound by Mark Boyns. FvwmAudio simply
269 took Mark's original program and extended it to make it generic enough
270 to work with any audio player. Due to different requests to do specific
271 things on specific events, FvwmEvent took this one step further and now
272 calls any fvwm function, or builtin-rplay. If fvwm's Exec function is
273 used, any external program can be called with any parameter.
274 The concept for interfacing this module to the Window Manager, is orig‐
276 inal work by Robert Nation.
277 Copyright 1998 Albrecht Kadlec. Copyright 1994, Mark Boyns and Mark
279 Scott. No guarantees or warranties or anything are provided or implied
280 in any way whatsoever. Use this program at your own risk. Permission
281 to use and modify this program for any purpose is given, as long as the
282 copyright is kept intact.
283
288 1994 FvwmSound Mark Boyns (boyns@sdsu.edu)
289 1994 FvwmAudio Mark Scott (mscott@mcd.mot.com)
290 1996 FvwmAudio Albrecht Kadlec
291 1998 FvwmEvent Albrecht Kadlec (albrecht@auto.tuwien.ac.at)
2923rd Berkeley Distribution 24 November 2007 (2.5.24) FvwmEvent(1)