doc/SOUND

   1
   2 NOTES ON SOUND SUPPORT
   3 ======================
   4
   5 As of version 5.4.6, VTWM can be built to support sound effects, by way of
   6 the rplay library and daemon. The following chart lists the identifiers for
   7 the sounds resource, loosely organized into categories. Those in parentheses
   8 are best described as "event identifiers" - cues that also trigger a sound.
   9
  10 See the man page and sample resource file for usage and syntax.
  11
  12
  13 CREATE                      DESKTOP                START STOP
  14   m  !                        m  f.autopan           m  f.twmrc
  15   m  f.exec                   m  f.panup             m  f.quit
  16   m  f.newdoor                m  f.pandown           m  f.restart
  17   e  (client map)             m  f.panleft           m  f.startwm
  18   m  (menu map)               m  f.panright          t  (vtwm start)
  19                               m  f.movescreen        t  (vtwm stop)
  20                               m  f.setrealscreen
  21 BUFFER                        m  f.resetdesktop
  22   m  ^                        m  f.enterdoor       NAVIGATE
  23   m  f.cut                    m  f.snap              m  f.backiconmgr
  24   m  f.cutfile                m  f.snugdesktop       m  f.downiconmgr
  25   m  f.file                   m  f.snugwindow        m  f.forwiconmgr
  26                               e  (autopan event)     m  f.lefticonmgr
  27                                                      m  f.nexticonmgr
  28 ARRANGE                                              m  f.previconmgr
  29   m  f.autoraise            ZOOM RESIZE              m  f.upiconmgr
  30   m  f.circledown             m  f.bottomzoom        m  f.righticonmgr
  31   m  f.circleup               m  f.fullzoom          m  f.warp
  32   m  f.lower                  m  f.hbzoom            m  f.warpclassnext
  33   m  f.raise                  m  f.horizoom          m  f.warpclassprev
  34   m  f.raiselower             m  f.htzoom            m  f.warpring
  35   m  f.deiconify              m  f.hzoom             m  f.warpto
  36   m  f.iconify                m  f.leftzoom          m  f.warptoiconmgr
  37   m  f.hidedesktopdisplay     m  f.rightzoom         m  f.warptonewest
  38   m  f.hideiconmgr            m  f.topzoom           m  f.warptoscreen
  39   m  f.showdesktopdisplay     m  f.vlzoom
  40   m  f.showiconmgr            m  f.vrzoom
  41   m  f.forcemove              m  f.zoom            MISC
  42   m  f.move                   m  f.resize            m  f.beep
  43   m  f.nail                                          m  f.colormap
  44   m  f.stick                                         m  f.deltastop
  45   m  f.squeezecenter        DELETE DESTROY           m  f.version
  46   m  f.squeezeleft            m  f.delete            m  f.identify
  47   m  f.squeezeright           m  f.deletedoor        m  f.menu
  48   m  f.namedoor               m  f.destroy           m  f.nailedabove
  49   m  f.sorticonmgr            e  (client unmap)      m  f.nop
  50   m  f.stricticonmgr          e  (info unmap)        m  f.saveyourself
  51                               m  (menu unmap)           f.separator
  52                                                      m  f.stickyabove
  53                                                      m  f.refresh
  54                                                      m  f.winrefresh
  55                                                      m  f.focus
  56                                                      m  f.unfocus
  57                                                      m  f.bindbuttons
  58                                                      m  f.bindkeys
  59                                                      m  f.unbindbuttons
  60                                                      m  f.unbindkeys
  61                                                      m  f.function
  62                                                      m  f.ring
  63                                                      m  f.snaprealscreen
  64                                                      m  f.staticiconpositions
  65                                                      m  f.stricticonmgr
  66                                                      m  f.title
  67                                                      m  f.virtualgeometries
  68                                                      m  f.warpsnug
  69                                                      m  f.warpvisible
  70                                                      m  f.zoomzoom
  71                                                         f.playsound
  72                                                         f.sounds
  73                                                      m  (bell event)
  74
  75
  76 LEGEND:
  77   m = handled in menus.c
  78   e = handled in events.c
  79   t = handled in twm.c
  80     = no sound support
  81
  82 NOTES:
  83   - Where function identifiers overlap event identifiers, the function takes
  84     precedence when both would otherwise play. These identifiers are:
  85         f.beep > (bell event)            f.exec > (client map)
  86         f.delete > (client unmap)        f.menu > (menu map)
  87         f.deletedoor > (client unmap)    f.quit > (vtwm stop)
  88         f.destroy > (client unmap)       f.version = f.identify
  89   - f.exec will never know if the program is an X client, nor if it maps a
  90     window if it is, so (client map) might be preferred.
  91   - None should play if the function or event isn't possible, but they will.
  92   - Two variables, PauseOnExit and PauseOnQuit, allow time for exit sounds
  93     to play.
  94