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

10320N/A<!--ArborText, Inc., 1988-1999, v.4002-->

10320N/A<!ENTITY cmd "devhelp">

10320N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

10320N/A%commonents;

10320N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

10320N/A%booktitles;

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

10320N/A]>

10320N/A<?Pub UDT _bookmark _target>

10320N/A<?Pub Inc>

10320N/A<refentry id="devhelp-1">

13720N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>

11904N/A<refmiscinfo class="date">08 Nov 2007</refmiscinfo>

10320N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

10320N/A<refmiscinfo class="software">&release;</refmiscinfo>

10320N/A<refmiscinfo class="arch">generic</refmiscinfo>

10320N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

10320N/A</refmeta>

13720N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>

10320N/AGNOME API documentation browser</primary></indexterm>

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

10320N/A<refpurpose>GNOME API documentation browser</refpurpose></refnamediv>

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

10320N/A<cmdsynopsis><command>&cmd;</command>

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

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

10320N/A<arg choice="opt"><option>-quit</option></arg>

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

10320N/A</cmdsynopsis></refsynopsisdiv>

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

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

11904N/Agtk-doc (the API reference framework developed for GTK+ and used throughout

11904N/AGNOME for API documentation). If you use gtk-doc with your project, you can use

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

10320N/A</refsect1>

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

10320N/A<para>The following options are supported:</para>

10320N/A<variablelist termlength="wide">

11904N/A<varlistentry>

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

11904N/A<listitem><para>

11904N/ASearch for a item prefixed by <replaceable>string</replaceable>. Items can be

11904N/Afunctions, structures and etc.</para>

10320N/A</listitem></varlistentry>

11904N/A<varlistentry>

11904N/A<term><option>f</option>, <option>-focus-search</option></term>

11904N/A<listitem><para>

13720N/AFocus the &cmd; window with the search field active.

10320N/A</para>

10320N/A</listitem></varlistentry>

11904N/A<varlistentry>

11904N/A<term><option>q</option>, <option>-quit</option></term>

11904N/A<listitem><para>

11904N/AQuit any running &cmd;.

11904N/A</para>

11904N/A</listitem></varlistentry>

11904N/A<varlistentry>

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

11904N/A<listitem>

11904N/A<para>Standard options available for use with most GNOME applications.

11904N/ASee

11904N/A<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

11904N/Afor more information.</para>

10320N/A</listitem></varlistentry>

10320N/A</variablelist></refsect1>

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

10320N/A<example role="example">

11904N/A<title>Launching &cmd;</title>

10320N/A<para><screen>example% <userinput>&cmd;</userinput></screen></para>

10320N/A</example>

10320N/A<example role="example">

11904N/A<title>Launching &cmd; to search for a function.

10320N/A</title>

10320N/A<para><screen>example% <userinput>&cmd; -s search-string

10320N/A</userinput></screen></para>

10320N/A</example>

10320N/A</refsect1>

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

10320N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>

10320N/A5</manvolnum></citerefentry> for descriptions of the following environment

10320N/Avariables:</para>

10320N/A<variablelist>

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

10320N/A</para>

10320N/A</listitem></varlistentry>

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

10320N/A</listitem></varlistentry>

10320N/A</variablelist></refsect1>

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

10320N/A<para>The following exit values are returned:</para>

10320N/A<variablelist termlength="xtranarrow">

10320N/A<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

10320N/Aexited successfully</para>

10320N/A</listitem></varlistentry>

10320N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

10320N/Aexited with failure</para>

10320N/A</listitem></varlistentry>

10320N/A</variablelist></refsect1>

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

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

10320N/A<variablelist termlength="medium">

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

10320N/AExecutable for GNOME API documentation browser</para>

10320N/A</listitem></varlistentry>

10320N/A</variablelist></refsect1>

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

10320N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

10320N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

10320N/Afor descriptions of the following attributes:</para>

10320N/A<informaltable frame="all">

10320N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

10320N/A<colspec colname="COLSPEC1" colwidth="1*">

10320N/A<thead>

10320N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

10320N/Avalign="middle">ATTRIBUTE VALUE</entry></row>

10320N/A</thead>

10320N/A<tbody>

18745N/A<row><entry><para>Availability</para></entry><entry><para>developer/gnome/devhelp

10320N/A</para></entry></row>

10320N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

10320N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>

10320N/A</tbody>

10320N/A</tgroup>

10320N/A</informaltable>

10320N/A</refsect1>

10320N/A<refsect1 id="devhelp-1-also"><title>&also-tt;</title>

13704N/A<citerefentry><refentrytitle>libdevhelp-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

11904N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

11904N/A<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

10320N/A<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

10320N/A</citerefentry></para>

10320N/A</refsect1>

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

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

10320N/AIt has been written for the Debian GNU/Linux distribution and is distributed

10320N/Aunder the GNU General Public License. As such, it may be used, modified and

10320N/Adistributed by anyone else as long as this copyright notice is preserved.</para>

10320N/A

10320N/A</para>

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

10320N/A</refsect1>

10320N/A</refentry>