--- name: "FvwmEvent" section: "1" platform: "linux" package: "fvwm3" version: "1.1.5-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/FvwmEvent" --- # FvwmEvent(1) the fvwm event module ## NAME FvwmEvent - the fvwm event module ## DESCRIPTION *FvwmEvent* is a module that triggers actions on *fvwm* events. It can be used to hook any *fvwm* function or program to any window manager event. *FvwmEvent* can trigger actions when windows are added, deleted, iconified, shaded, or when *fvwm* changes which virtual page or desk is being shown, or when RandR monitors are changed, enabled, disabled, or gain focus. Be creative, you’ll find a use for it. ## INVOCATION *FvwmEvent* is spawned by *fvwm*, so no command line invocation will work. *FvwmEvent* can be spawned from within the *config* file with or without an *Alias* as follows: ``` Module FvwmEvent Alias ``` You can add this to the *StartFunction* to ensure *FvwmEvent* is running and listening for events when *fvwm* starts. Alternatively you can add this to a menu, key binding, etc. You can kill stop a running instance of *FvwmEvent* with: ``` KillModule FvwmEvent Alias ``` ## CONFIGURATION OPTIONS *FvwmEvent* gets config info from **fvwm**'s module configuration database (see *fvwm*(1), section **MODULE COMMANDS**), and looks for certain configuration options: \*FvwmEvent: Cmd command This determines the *fvwm* function that is to be called with the event parameters. You might want to do one of the following (details below): ``` # execute distinct fvwm functions *FvwmEvent: Cmd # execute distinct external programs *FvwmEvent: Cmd exec ``` *FvwmEvent* has support for any other external program. e.g: the rsynth 'say' command: ``` *FvwmEvent: Cmd "Exec /rsynth/say" *FvwmEvent: destroy_window "window closed" ``` You can also use *fvwm*'s builtin *Echo* command as *FvwmEvent: Cmd* to obtain debug output for *fvwm* events quietly. I used this setup to debug FvwmAuto: ``` *FvwmEvent: Cmd Echo *FvwmEvent: focus_change "focus change" *FvwmEvent: raise_window "raise window" ``` You can even call different shell commands for each event just by setting ``` *FvwmEvent: Cmd exec *FvwmEvent: add_window 'killname "APPL ERROR"' ``` \*FvwmEvent: PassId Specifies that the event action will have an ID parameter added to the end of the command line. Most events will have the windowID of the window that the event refers to. The new\_desk event will have the new desk number. Monitor events will have the RandR monitor name. The windowID is a hexadecimal string preceded by 0x, desk numbers are decimal, and monitor name’s are strings. \*FvwmEvent: window-manager-event action Binds particular actions to window manager events. The action is appended to the *Cmd* which is then sent to *fvwm* for execution. The following events are valid: | | | | --- | --- | | *Event* | *Description* | | add\_window | Occurs when a new window is mapped and visible | | config\_info | Occurs when a module asks for configuration | | configure\_window | Occurs when a ConfigureNotify event happens | | default\_icon | Occurs when a window’s DefaultIcon changes | | deiconify | Occurs when a window id deiconified | | destroy\_window | Occurs when a window is destroyed | | dewindowshade | Occurs when a window is unshaded | | echo | Occurs when an Echo command is run | | end\_config\_info | Occurs when there’s no more module config to send | | end\_windowlist | Occurs when the windowlist has finished sending | | enter\_window | Occurs when a window receives a EnterNotify event | | error | DEPRECATED | | focus\_change | Occurs when a window gains or loses focus | | icon\_file | DEPRECATED | | icon\_location | DEPRECATED | | icon\_name | DEPRECATED | | iconify | Occurs when a window is iconified | | leave\_window | Occurs when a window receives a LeaveNotify event | | lower\_window | Occurs when a window is lowered | | map | Occurs when a window is Mapped | | mini\_icon | Occurs when a window’s mini icon changes | | monitor\_changed | Occurs when a monitor’s resolution changes | | monitor\_disabled | Occurs when a monitor is disabled (via RandR) | | monitor\_enabled | Occurs when a monitor is enabled (via RandR) | | monitor\_focus | Occurs when a monitor gains focus | | new\_desk | Occurs when a new desk is switched to | | new\_page | Occurs when a new page is switched to | | old\_add\_window | DEPRECATED | | old\_configure\_window | DEPRECATED | | property\_change | Occurs when a window receives a PropertNotify event | | raise\_window | Occurs when a window is raised | | res\_class | Occurs when a window’s Class is set | | res\_name | Occurs when a window’s Resource is set | | restack | Occurs when windows are restacked | | sendconfig | Occurs when FvwmEvent asks for its config | | shutdown | DEPRECATED | | startup | DEPRECATED | | string | Occurs when the SendToModule command is used | | unknown | DEPRECATED | | visible\_icon\_name | Occurs when a window’s visible icon name changes | | visible\_name | Occurs when a window’s visible name changes | | window\_name | Occurs when a window’s name (WM\_NAME) is set | | windowshade | Occurs when a window is shaded | The window related event handlers are executed within a window context. Previously PassId was used for this purpose, but now using PassId is not needed. The monitor\_\* events do not operate in a window context (as there isn’t one). The given event command is also passed the following values: ``` $0: monitor_event_name (for example: monitor_changed) $1: monitor_name (the RandR name of the monitor) ``` For example, consider the following: ``` DestroyFunc RandRFunc AddToFunc RandRFunc + I Exec exec xmessage "Monitor $1 had this event: $0" DestroyModuleConfig FE-Monitor: * *FE-Monitor: monitor_changed RandRFunc *FE-Monitor: monitor_enabled RandRFunc KillModule FvwmEvent FE-Monitor Module FvwmEvent FE-Monitor ``` When, say, the monitor\_changed event is triggered, RandRFunc is run, with the monitor name passed in as the first argument, and the monitor event as the second argument. In this way it is possible to do further matching if required. **NOTE**: Using `PassID` with a configuration which includes monitor\_ lines won’t work since there is no ID to pass back. If `PassID` is still required, separate out monitor events into their own FvwmEvent configuration. The echo event is generated whenever Fvwm receives an Echo command. Note: The enter\_window event is generated when the pointer enters a window. With the -passid option, that window’s id is passed to fvwm. An enter\_window event is generated too when the pointer leaves a window and moves into the root window. In this case, the id passed is 0. Note: When the shutdown event arrives, FvwmEvent may be killed before it can trigger the associated action. \*FvwmEvent: Delay 5 Specifies that an event-action will only be executed if it occurs at least 5 seconds after the previous event. Events that occur during the delay period are ignored. The default delay is 0 which disables the Event. \*FvwmEvent: StartDelay delay Specifies that an event-action will only be executed if it occurs at least *delay* seconds after the startup event. Events that occur during the delay period are ignored. This option is useful when *fvwm* starts and restarts using an audio player. The default delay is 0. ## HISTORY This module has evolved of *FvwmAudio*, which in term is heavily based on a similar Fvwm module called *FvwmSound* by Mark Boyns. *FvwmAudio* simply took Mark’s original program and extended it to make it generic enough to work with any audio player. Due to different requests to do specific things on specific events, *FvwmEvent* took this one step further and now calls any *fvwm* function. If *fvwm*'s Exec function is used, any external program can be called with any parameter. ## AUTHORS • 1994 FvwmSound Mark Boyns ( \) • 1994 FvwmAudio Mark Scott ( \) • 1996 FvwmAudio Albrecht Kadlec • 1998 FvwmEvent Albrecht Kadlec ( \)