notify-send.1 revision 11933
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "notify-send">
%commonents;
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="notify-send-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>notify-send</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">28 Feb 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<refnamediv id="notify-send-1-name"><refname>notify-send</refname><refpurpose>a CLI program to send desktop notifications</refpurpose>
</refnamediv>
<refsynopsisdiv id="notify-send-1-synp"><title>&synp-tt;</title>
<cmdsynopsis>
<command>&cmd;</command>
<arg choice="opt"><option>-help </option></arg>
<arg choice="opt"><option>-urgency=<replaceable>level</replaceable></option></arg>
<arg choice="opt"><option>-expire-time=<replaceable>time</replaceable></option></arg>
<arg choice="opt"><option>-icon=<replaceable>icon,icon...</replaceable></option></arg>
<arg choice="opt"><option>-category=<replaceable>type,type...</replaceable></option></arg>
<arg choice="opt"><option>-hint=<replaceable>type:name:value</replaceable></option></arg>
<arg choice="opt"><replaceable>summary</replaceable></arg>
<arg choice="opt"><replaceable>body</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="notify-send-1-desc"><title>&desc-tt;</title>
<para>Using notify-send, you can send desktop notifications to the user via a notification daemon from the command line. The notifications are used to inform the user about an asynchronous event or display some useful information without getting in the user's way.</para>
</refsect1>
<refsect1 id="notify-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="medium">
<varlistentry><term><option>?</option>, <option>-help</option></term><listitem><para>Display help
text.</para>
</listitem></varlistentry>
<varlistentry><term><option>u</option>, <option>-urgency=<replaceable>level</replaceable></option></term><listitem><para>Specifies
the urgency level, including low, normal and critical.</para>
</listitem></varlistentry>
<varlistentry><term><option>t</option>, <option>-expire-time=<replaceable>time</replaceable></option></term><listitem><para>Specifies
the timeout in milliseconds at which to expire the notification.</para>
</listitem></varlistentry>
<varlistentry><term><option>i</option>, <option>-icon=<replaceable>icons</replaceable></option></term><listitem><para>Specifies
an icon filename or stock icon to display.</para>
</listitem></varlistentry>
<varlistentry><term><option>c</option>, <option>-category=<replaceable>types</replaceable></option></term><listitem><para>Specifies
the notification category.</para>
</listitem></varlistentry>
<varlistentry><term><option>h</option>, <option>-hint=<replaceable>hint</replaceable></option></term><listitem><para>Specifies
basic extra data to pass. The format is type:name:value and valid types are int, double, string and byte</para>
</listitem></varlistentry>
<varlistentry><term><option>v</option>, <option>-version</option></term><listitem><para>Display
version information.</para>
</listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1 id="notify-send-1-exit"><title>&exit-tt;</title> <para>
0 All information was written successfully.
>0 An error occurred.
</para>
</refsect1>
<refsect1 id="notify-send-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN2" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-panel</para></entry>
</row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="notify-send-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
The Desktop Notification Spec on
</refsect1>
<refsect1 id="notify-send-1-note"><title>¬e-tt;</title>
<para>
Written by Jedy Wang, Sun Microsystems Inc., 2007.
</para>
</refsect1>
</refentry>