Manual Pages for UNIX Operating System command usage for man canberra-gtk-play

User Commands                                canberra-gtk-play(1)



NAME
     canberra-gtk-play - play a sound event

SYNOPSIS
     canberra-gtk-play [--cache-control=permanent|volatile|never]
     [--description=description]      [--display=display]     [--
     file=file]  [--help]  [--id=identifier]  [--loop=times]  [--
     version] [gnome-std-options]

DESCRIPTION
     canberra-gtk-play is an application for playing sound events
     that  are  specified by the FreeDesktop "XDG Sound Theme and
     Name Specification".

OPTIONS
     The following options are supported:

     --c, --cache-control=[permanent|volatile|never]

         Specify how canberra-gtk-play will manage its cache con-
         trol.  The value of "permanent" will cause the sample to
         be cached in the server permanently.  This is useful for
         very  frequently  used  sounds.  The value of "volatile"
         may be used for caching sounds in the sound server  tem-
         porarily.   They will expire after some time or on cache
         pressure.  The value of "never" may be used that  should
         never  be  cached,  because they are only generated very
         seldomly or only once.

         Not all libcanberra backends support caching,  and  this
         option is only functional if the backend being used does
         support this functionality.



     -d, --description=description

         Specify a description for the sound event.



     --display=display

         Specify the X display to use.



     -f, --file=file

         Specify a file to play.





SunOS 5.11          Last change: 20 Feb 2009                    1






User Commands                                canberra-gtk-play(1)



     -?, --help

         Display usage information.



     -i, --id=identifier

         Specify the event identifier to play.  These  identifier
         values  are  specified  in the "XDG Sound Theme and Name
         Specification".



     -l, --loop=times

         Specify the number of  times  to  play  the  file.   The
         default value is 1.



     -v, --version

         Display canberra-gtk-play version number.



     gnome-std-options

         Standard options  available  for  use  with  most  GNOME
         applications.   See  gnome-std-options(5lnum>)  for more
         information.



EXAMPLES
     Example 1: Play the "desktop-login" sound event

     example% canberra-gtk-play --id desktop-login --description="GNOME Login"

FILES
     The following files are used by this application:

     /usr/bin/canberra-gtk-plaEyxecutable to play an sound events



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:





SunOS 5.11          Last change: 20 Feb 2009                    2






User Commands                                canberra-gtk-play(1)



     _______________________________________________________________
    |       ATTRIBUTE TYPE        |         ATTRIBUTE VALUE        |
    |_____________________________|________________________________|
    | Availability                | library/desktop/xdg/libcanberra|
    |_____________________________|________________________________|
    | Interface stability         | Volatile                       |
    |_____________________________|________________________________|


SEE ALSO
     libcanberra(3), attributes(5), gnome-std-options(5)

NOTES
     Written by Brian Cameron, Sun Microsystems Inc., 2009.









































SunOS 5.11          Last change: 20 Feb 2009                    3