Hi,

Attached is the man page of libnotify, please review it. I also have 2
Questions
1) In FILES section, /usr/share/gtk-doc/html/libnotify is truncated
to /usr/share/gtk-doc/html/libnotif. What could I do to improve this or
we can just ignore it?

2) In SEE ALSO section, do I have to list gnome-interfaces(5)? If yes, I
guess I should update gnome-interfaces and list libnoitfy entry as
"libnotify Volatile Galago". Is this correct?

Output of man libnotify is:
----------------------------------------------------------------->8
C Library Functions                                  libnotify(3)

NAME
     libnotify - Desktop Notifycation library

DESCRIPTION
     libnotify provides desktop notification support for GTK+.

     To access  the  API  documentation,  you  must  install  the
     developer version of the package.

FILES
     The following files are used by this application:

     /usr/lib/libnotify.so           Desktop Notification  shared
                                     library

     /usr/share/gtk-doc/html/libnotifLocation of developer  docu-
                                     mentation

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

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | SUNWgnome-panel             |
    |_____________________________|_____________________________|
    | Interface stability         | Volatile                    |
    |_____________________________|_____________________________|

SEE ALSO
     notify-send(1), attributes(5), gnome-interfaces(5)

NOTES
     Written by Jedy Wang, Sun Microsystems Inc., 2004, 2008.

SunOS 5.11           Last change: 1 Jul 2008               
------------------------------------------------------------------->8

Regards,

Jedy
-------------- next part --------------
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook 
Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "libnotify">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2004,2008 Sun Microsystems, Inc. All Rights 
Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="libnotify-3">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>libnotify</refentrytitle><manvolnum>3</manvolnum>
<refmiscinfo class="date">1 Jul 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>libnotify</primary></indexterm><indexterm><primary>Desktop
Notification library</primary></indexterm>
<refnamediv 
id="libnotify-3-name"><refname>libnotify</refname><refpurpose>Desktop
Notifycation library</refpurpose></refnamediv>
<refsect1 id="libnotify-3-desc"><title>&desc-tt;</title>
<para><literal>&cmd;</literal> provides desktop notification support for GTK+.
</para>
<para>To access the API documentation, you must install the developer version
of the package.</para>
</refsect1>
<refsect1 id="libnotify-3-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="wide">
<varlistentry>
<term><filename>/usr/lib/&cmd;.so</filename></term>
<listitem><para>
Desktop Notification shared library
</para></varlistentry>
<varlistentry>
<term><filename>/usr/share/gtk-doc/html/libnotify</filename></term>
<listitem><para>
Location of developer documentation
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="libnotify-3-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><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="libnotify-3-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>notify-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="libnotify-3-note"><title>&note-tt;</title>
<para>Written by Jedy Wang, Sun Microsystems Inc., 2004, 2008.</para>
</refsect1>
</refentry>

Reply via email to