1 .TH canberra-gtk-play 1 "7 Apr 2017" "SunOS 5.11" "User Commands"

     2 .SH "NAME"

     3 canberra-gtk-play \- play a sound event

     4 .SH "SYNOPSIS"

     5 .PP

     6 \fBcanberra-gtk-play\fR [\fB\-\-cache-control=\fIpermanent|volatile|never\fR\fR] [\fB\-\-description=\fIdescription\fR\fR] [\fB\-\-display=\fIdisplay\fR\fR] [\fB\-\-file=\fIfile\fR\fR] [\fB\-\-help\fR] [\fB\-\-id=\fIidentifier\fR\fR] [\fB\-\-loop=\fItimes\fR\fR] [\fB\-\-version\fR] [\fB\fIgnome-std-options\fR\fR]

     7 .SH "DESCRIPTION"

     8 .PP

     9 \fBcanberra-gtk-play\fR is an application for playing sound events that

    10 are specified by the FreeDesktop "XDG Sound Theme and Name Specification"\&.

    11 .SH "OPTIONS"

    12 .PP

    13 The following options are supported:

    14 .TP 4

    15 \fB\-\-c\fR, \fB\-\-cache-control=\fR\fI[permanent|volatile|never]\fR

    16 Specify how canberra-gtk-play will manage its cache control\&.  The value of

    17 "permanent" will cause the sample to be cached in the server

    18 permanently\&.  This is useful for very frequently used sounds\&.  The value of

    19 "volatile" may be used for caching sounds in the sound server

    20 temporarily\&.  They will expire after some time or on cache pressure\&.  The

    21 value of "never" may be used that should never be cached, because

    22 they are only generated very seldomly or only once\&.

    23 .sp

    24 Not all libcanberra backends support caching, and this option is only

    25 functional if the backend being used does support this functionality\&.

    26 .TP 4

    27 \fB\-d\fR, \fB\-\-description=\fR\fIdescription\fR

    28 Specify a \fIdescription\fR for the sound event\&.

    29 .TP 4

    30 \fB\-\-display=\fR\fIdisplay\fR

    31 Specify the X display to use\&.

    32 .TP 4

    33 \fB\-f\fR, \fB\-\-file=\fR\fIfile\fR

    34 Specify a \fIfile\fR to play\&.

    35 .TP 4

    36 \fB\-?\fR, \fB\-\-help\fR

    37 Display usage information\&.

    38 .TP 4

    39 \fB\-i\fR, \fB\-\-id=\fR\fIidentifier\fR

    40 Specify the event \fIidentifier\fR to play\&.  These

    41 \fIidentifier\fR values are specified in the

    42 "XDG Sound Theme and Name Specification"\&.

    43 .TP 4

    44 \fB\-l\fR, \fB\-\-loop=\fR\fItimes\fR

    45 Specify the number of \fItimes\fR to play the file\&.  The

    46 default value is 1\&.

    47 .TP 4

    48 \fB\-v\fR, \fB\-\-version\fR

    49 Display canberra-gtk-play version number\&.

    50 .TP 4

    51 .I gnome-std-options

    52 Standard options available for use with most GNOME applications\&.  See

    53 .BR gnome-std-options (7)

    54 for more information\&.

    55 .SH "EXAMPLES"

    56 .PP

    57 \fBExample 1: Play the "desktop-login" sound event\fR

    58 .PP

    59 .nf

    60 example% \fBcanberra-gtk-play --id desktop-login --description="GNOME Login"\fR

    61 .fi

    62 .SH "SEE ALSO"

    63 .PP

    64 .BR libcanberra (3lib),

    65 .BR attributes (7),

    66 .BR gnome-std-options (7)

    67 .SH "NOTES"

    68 .PP

    69 Written by Brian Cameron, Sun Microsystems Inc\&., 2009\&.