<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "devhelp">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="devhelp-1">

<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">08 Nov 2007</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>

GNOME API documentation browser</primary></indexterm>

<refnamediv id="devhelp-1-name"><refname>&cmd;</refname>

<refpurpose>GNOME API documentation browser</refpurpose></refnamediv>

<refsynopsisdiv id="devhelp-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-search=<replaceable>string</replaceable></option></arg>

<arg choice="opt"><option>-focus-search</option></arg>

<arg choice="opt"><option>-quit</option></arg>

<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="devhelp-1-desc"><title>&desc-tt;</title>

<para>&cmd; is an API documentation browser for GNOME. It works natively with

gtk-doc (the API reference framework developed for GTK+ and used throughout

GNOME for API documentation). If you use gtk-doc with your project, you can use

&cmd; to browse the documentation.</para>

</refsect1>

<refsect1 id="devhelp-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="wide">

<varlistentry>

<term><option>s</option>, <option>-search=<replaceable>string</replaceable></option></term>

<listitem><para>

Search for a item prefixed by <replaceable>string</replaceable>. Items can be

functions, structures and etc.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>f</option>, <option>-focus-search</option></term>

<listitem><para>

Focus the &cmd; window with the search field active.

</para>

</listitem></varlistentry>

<varlistentry>

<term><option>q</option>, <option>-quit</option></term>

<listitem><para>

Quit any running &cmd;.

</para>

</listitem></varlistentry>

<varlistentry>

<term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>

<listitem>

<para>Standard options available for use with most GNOME applications.

See

<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

for more information.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="devhelp-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Launching &cmd;</title>

<para><screen>example% <userinput>&cmd;</userinput></screen></para>

</example>

<example role="example">

<title>Launching &cmd; to search for a function.

</title>

<para><screen>example% <userinput>&cmd; -s search-string

</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="devhelp-1-envr"><title>&envr-tt;</title>

<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>

5</manvolnum></citerefentry> for descriptions of the following environment

variables:</para>

<variablelist>

<varlistentry><term>INFOPATH</term><listitem><para>Location of GNU Info files.

</para>

</listitem></varlistentry>

<varlistentry><term>MANPATH</term><listitem><para>Location of man pages.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="devhelp-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow">

<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="devhelp-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>

Executable for GNOME API documentation browser</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="devhelp-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" 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>developer/gnome/devhelp

</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="devhelp-1-also"><title>&also-tt;</title>

<citerefentry><refentrytitle>libdevhelp-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</citerefentry></para>

</refsect1>

<refsect1 id="devhelp-1-note"><title>&note-tt;</title>

<para>This manual page is Copyright (c) 2001 Johan Dahlin <zilch.am@home.se>.

It has been written for the Debian GNU/Linux distribution and is distributed

under the GNU General Public License. As such, it may be used, modified and

distributed by anyone else as long as this copyright notice is preserved.</para>

</para>

<para>Updated by Simon Zheng, Sun Microsystems Inc., 2007.</para>

</refsect1>

</refentry>