Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FvwmEvent: remove support for Rplay #317

Merged
merged 1 commit into from
Dec 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions bin/fvwm-config.in
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ with_iconv=@with_iconv@
with_perllib=@with_perllib@
with_png=@with_png@
with_readline=@with_readline@
with_rplay=@with_rplay@
with_rsvg=@with_rsvg@
with_shape=@with_shape@
with_shm=@with_shm@
Expand Down Expand Up @@ -158,7 +157,6 @@ while test $# -gt 0; do
test "$with_perllib" = "yes" && echo "perllib"
test "$with_png" = "yes" && echo "png"
test "$with_readline" = "yes" && echo "readline"
test "$with_rplay" = "yes" && echo "rplay"
test "$with_rsvg" = "yes" && echo "rsvg"
test "$with_shape" = "yes" && echo "shape"
test "$with_shm" = "yes" && echo "shm"
Expand Down Expand Up @@ -207,7 +205,6 @@ while test $# -gt 0; do
echo " iconv (i18n conversions): $with_iconv"
echo " png: $with_png"
echo " readline: $with_readline"
echo " rplay: $with_rplay"
echo " shape (shaped windows): $with_shape"
echo " shm (shared memory): $with_shm"
echo " sm (session management): $with_sm"
Expand Down
14 changes: 0 additions & 14 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -866,18 +866,6 @@ fi
AC_SUBST(rsvg_CFLAGS)
AC_SUBST(rsvg_LIBS)

# ********* rplay
$UNSET ac_cv_header_rplay_h
$UNSET ac_cv_lib_rplay_rplay_create
# Add in X_EXTRA_LIBS here to get things like connect().
smr_CHECK_LIB(rplay, , adds audio capability, rplay_create, rplay.h,
$X_EXTRA_LIBS)
AH_TEMPLATE([HAVE_RPLAY],[Define if rplay library is used.])
test ! x"$rplay_LIBS" = x && AC_DEFINE(HAVE_RPLAY)
AC_SUBST(rplay_LIBS)
AC_SUBST(rplay_CFLAGS)


# ********* readline
with_readline=no
problem_readline=": Both termcap and ncurses disabled"
Expand Down Expand Up @@ -1472,7 +1460,6 @@ AC_SUBST(with_perllib)
AC_SUBST(with_png)
AC_SUBST(with_rsvg)
AC_SUBST(with_readline)
AC_SUBST(with_rplay)
AC_SUBST(with_shape)
AC_SUBST(with_shm)
AC_SUBST(with_sm)
Expand Down Expand Up @@ -1588,7 +1575,6 @@ Fvwm3 Configuration:
With Gettext Native Lang support? $with_gettext$problem_gettext
With Iconv support? $with_iconv_type$problem_iconv
With ReadLine sup. in FvwmConsole? $with_readline$problem_readline
With RPlay support in FvwmEvent? $with_rplay$problem_rplay
With Shaped window support? $with_shape$problem_shape
With Shared memory for XImage? $with_shm$problem_shm
With Session Management support? $with_sm$problem_sm
Expand Down
2 changes: 1 addition & 1 deletion doc/fvwm3/fvwm3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ a multi-screen display.
*-V* | *--version*::

Prints the version of fvwm to _stderr_. Also prints an information about
the compiled in support for readline, rplay, xpm, png, svg, GNOME hints,
the compiled in support for readline, xpm, png, svg, GNOME hints,
EWMH hints, session management, bidirectional text, multibyte
characters, RandR and Xft aa font rendering.

Expand Down
193 changes: 52 additions & 141 deletions doc/modules/FvwmEvent.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,11 @@ _FvwmEvent_ can be used to bind sound files to events like _FvwmAudio_
(RiP) did. It can be used for logging event traces to a log file, while
debugging _fvwm_.

_FvwmEvent_ can also have builtin support for the rplay library.
(heritage of FvwmAudio)

== INVOCATION

The invocation method was shown in the synopsis section. No command line
invocation is possible. _FvwmEvent_ must be invoked by the _fvwm_ window
manager. _FvwmEvent_ accepts a single argument:

[horizontal]
-audio:: Enables FvwmAudio compatibility mode.
alias:: Makes FvwmEvent use _alias_ as its name. This affects which lines from
+
the user's configuration file are used.
+
Invoking FvwmEvent as _FvwmAudio_ (either by using an alias or creating
a symlink) enables FvwmAudio compatibility mode.
manager.

== CONFIGURATION OPTIONS

Expand All @@ -81,37 +69,14 @@ configuration options:
below):
+
....
# play sounds
*FvwmEvent: Cmd builtin-rplay

# execute distinct fvwm functions
*FvwmEvent: Cmd

# execute distinct external programs
*FvwmEvent: Cmd exec
....
+
This version of _FvwmEvent_ has builtin _rplay_ support which does not
need to invoke an external audio player to play sounds. The rplay
support is enabled when _FvwmEvent_ is compiled with _HAVE_RPLAY_
defined and when _FvwmEvent: Cmd_ is set to _builtin-rplay_. See remarks
below if _FvwmEvent_ is invoked in FvwmAudio compatibility mode.
+
For example:
+
....
*FvwmEvent: Cmd builtin-rplay
*FvwmEvent: add_window drip.au
....
+
rplay can be obtained via anonymous ftp at
+
....
<URL:ftp://ftp.sdsu.edu/pub/rplay> or
<URL:ftp://ftp.x.org/contrib/Event/audio/rplay>
....
+
_FvwmEvent_ also has support for any other external program. e.g: the
_FvwmEvent_ has support for any other external program. e.g: the
rsynth 'say' command:
+
....
Expand Down Expand Up @@ -147,62 +112,56 @@ setting
*FvwmEvent: window-manager-event action-or-filename::
Binds particular actions to window manager events.
+
e.g. for audio-events:
+
....
*FvwmEvent: startup TaDa.au
*FvwmEvent: shutdown Elvis_Left.au
*FvwmEvent: unknown doh.au

*FvwmEvent: new_page beam_trek.au
*FvwmEvent: new_desk beam_trek.au
*FvwmEvent: old_add_window drip.au
*FvwmEvent: raise_window swoosh.au
*FvwmEvent: lower_window swoosh.au
*FvwmEvent: old_configure_window hammer.au
*FvwmEvent: focus_change boing.au
*FvwmEvent: enter_window boing.au
*FvwmEvent: leave_window boing.au
*FvwmEvent: destroy_window explosion.au
*FvwmEvent: iconify ploop.au
*FvwmEvent: deiconify ploop.au
*FvwmEvent: window_name huh.au
*FvwmEvent: icon_name beep.au
*FvwmEvent: visible_icon_name beep.au
*FvwmEvent: res_class beep.au
*FvwmEvent: res_name beep.au
*FvwmEvent: end_windowlist twang.au

*FvwmEvent: icon_location beep.au
*FvwmEvent: map beep.au
*FvwmEvent: error beep.au
*FvwmEvent: config_info beep.au
*FvwmEvent: end_config_info beep.au
*FvwmEvent: icon_file beep.au
*FvwmEvent: default_icon beep.au
*FvwmEvent: string plapper.au
*FvwmEvent: mini_icon beep.au
*FvwmEvent: windowshade beep.au
*FvwmEvent: dewindowshade beep.au

*FvwmEvent: visible_name beep.au
*FvwmEvent: sendconfig beep.au
*FvwmEvent: restack beep.au
*FvwmEvent: add_window beep.au
*FvwmEvent: configure_window beep.au
The following events are valid:
+
[cols="<,<",]
|===
|_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 recieves a PropertNotify event
|raise_window | Occurs when a windowis 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
|===

*FvwmEvent: visible_icon_name beep.au
*FvwmEvent: enter_window beep.au
*FvwmEvent: leave_window beep.au
*FvwmEvent: property_change beep.au

*FvwmEvent: monitor_enabled beep.au
*FvwmEvent: monitor_disabled beep.au
*FvwmEvent: monitor_changed beep.au
*FvwmEvent: monitor_focus beep.au

*FvwmEvent: echo beep.au
....
+
The window related event handlers are executed within a window context.
Previously PassId was used for this purpose, but now using PassId is not
Expand Down Expand Up @@ -232,66 +191,18 @@ 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.
+
Provided _fvwm_ supports it (not yet), there's an additional event to
replace all _fvwm_ beeps with a sound:
+
....
*FvwmEvent: beep beep.au
....

*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. This option is useful if you don't want
several sounds playing at the same time. The default delay is 0 which
disables the Event delay.
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.

== RPLAY OPTIONS

The following options are only valid with builtin rplay support. i.e:
when _FvwmEvent_ was compiled with _HAVE_RPLAY_ defined. They are used
only if _FvwmEvent: Cmd_ is set to _builtin-rplay_.

*FvwmEvent: RplayHost hostname::
Specifies what host the rplay sounds will play on. The _hostname_ can
also be an environment variable such as $HOSTDISPLAY.

*FvwmEvent: RplayPriority 0::
Specifies what priority will be assigned to the rplay sounds when they
are played.

*FvwmEvent: RplayVolume 127::
Specifies what volume will be assigned to the sounds when they are
played.

== FvwmAudio Compatibility Mode

When invoked in FvwmAudio compatibility mode (see above), FvwmEvent
accepts the following options to provide backwards compatibility for
FvwmAudio:

*FvwmEvent: PlayCmd command::
This is equivalent to using *FvwmEvent: Cmd to Exec commands. This
determines the independent audio player program that will actually
play the sounds. If the play command is set to _builtin-rplay_ then
the builtin rplay support will be used.

*FvwmAudio: Dir directory::
Specifies the directory to look for the audio files. This option is
ignored when rplay is used.

== BUGS

It's REALLY noisy when _fvwm_ starts and restarts using an audio player.
You can use FvwmEvent: StartDelay to fix this problem.

== COPYRIGHTS

This module has evolved of _FvwmAudio_, which in term is heavily based
Expand Down
3 changes: 0 additions & 3 deletions fvwm/fvwm3.c
Original file line number Diff line number Diff line change
Expand Up @@ -1282,9 +1282,6 @@ static void setVersionInfo(void)
#ifdef HAVE_READLINE
strcat(support_str, " ReadLine,");
#endif
#ifdef HAVE_RPLAY
strcat(support_str, " RPlay,");
#endif
#ifdef XPM
strcat(support_str, " XPM,");
#endif
Expand Down
Loading