debian man page for gnome-osd-client

gnome-osd-client(1)					      General Commands Manual					       gnome-osd-client(1)

NAME
       gnome-osd-client - A GNOME OSD shell interface

SYNOPSIS
       gnome-osd-client [-h] [--help] [-f] [--full] [-s] [--stdin] [--dbus] [message]

DESCRIPTION
       The gnome-osd-client command allows you to send Gnome OSD notifications from shell scripts.

OPTIONS
       -h --help
	      Display help on command-line options.

       -f --full
	      Enable "full" message specification syntax, which is XML based.

       -s --stdin
	      Read message from stdin instead of command-line.

       --dbus Always use D-BUS instead of Bonobo as IPC mechanism.

	      By default Bonobo is used, unless it is not available, in which case D-BUS is tried next. This option reverses this order.

MESSAGE FORMAT
       The protocol used by GNOME OSD is XML based (surprise!).

		   <message ..attributes..> ...pango markup... </message>

       For a description of pango markup, see http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html

       The <message> XML element accepts the following attributes:

       id     This  allows you to create or use alternative OSD instance; By specifying different IDs, you can keep several messages on the screen
	      at the same time. But for each ID, only one message can be displayed at a time. If not specified, id='default' is assumed.

       inherit
	      Can be used in conjunction with 'id', to specify that the new OSD instance (which must not already exist) inherits  properties  from
	      the instance identified by 'inherit'. If not specified, inherit='default'.

       Any gnome-osd gconf key name (run "gconf-editor /apps/gnome-osd" for a list, with respective documentation)
	      These  control  several  message properties.  This can not be used for messages with ID 'default'. Property overrides are remembered
	      across messages for the same ID. For instance, if you specify animations='false' for id='foo', next message with id='foo' will  have
	      animations turned off by default.

       Example:

       .PP

       gnome-osd-client -f "<message id='myplugin' osd_fake_translucent_bg='on' osd_vposition='center' animations='off' hide_timeout='1000' osd_halignment='right'>Volume: 96%</message>"

AUTHOR
       Gnome OSD was written by Gustavo J. A. M. Carneiro.

								   March 05 2006					       gnome-osd-client(1)