10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13626N/A<!--ARC : LSARC 2002/445 GNOME 2.x help viewer (yelp)-->
10139N/A<!ENTITY cmd "yelp">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
11904N/A<!ENTITY suncopy "Copyright (c) 2003,2007, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<refentry id="yelp-1">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
13805N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
11904N/A<refmiscinfo class="date">08 Nov 2007</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
13805N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>gnome-help
10139N/A</primary></indexterm><indexterm><primary>GNOME help browser</primary></indexterm>
13805N/A<refnamediv id="yelp-1-name"><refname>&cmd;</refname><refname>gnome-help</refname>
10139N/A<refpurpose>GNOME help browser</refpurpose></refnamediv>
10139N/A<refsynopsisdiv id="yelp-1-synp"><title>&synp-tt;</title>
15944N/A<cmdsynopsis><command>&cmd;</command>
11904N/A<arg choice="opt"><option>-private-session</option></arg>
10139N/A<arg choice="opt"><option>-with-cache-dir=<replaceable>string</replaceable></option></arg>
10139N/A<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>
11934N/A<arg choice="plain"><option role="nodash"><replaceable>url</replaceable></option></arg>
10139N/A</cmdsynopsis></refsynopsisdiv>
10139N/A<refsect1 id="yelp-1-desc"><title>&desc-tt;</title>
11990N/A<para>
11990N/AThe GNOME help browser is a utility that allows users to view documentation
10139N/Afor GNOME in several formats including man pages, HTML, SGML(DocBook), and
11990N/AGNU info files.
11990N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="yelp-1-opts"><title>&opts-tt;</title>
10139N/A<para>The following options are supported:</para>
10139N/A<variablelist termlength="wide">
11904N/A<varlistentry>
11904N/A<term><option>-private-session</option></term>
11904N/A<listitem><para>
11904N/AUse a private session.
11904N/A</para></listitem></varlistentry>
11904N/A<varlistentry>
11904N/A<term><option>-with-cache-dir=<replaceable>directory</replaceable></option></term>
11904N/A<listitem><para>
10139N/ASpecify which cache <replaceable>directory</replaceable> to use.
11904N/A</para></listitem></varlistentry>
11990N/A<varlistentry>
11990N/A<term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>
11990N/A<listitem><para>
11990N/AStandard options available for use with most GNOME applications. See
11990N/A<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
11990N/Afor more information.
11990N/A</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="yelp-1-oper"><title>&oper-tt;</title>
10139N/A<para>The following operands are supported:</para>
10139N/A<variablelist termlength="narrow">
11990N/A<varlistentry>
11990N/A<term><option role="nodash"><replaceable>url</replaceable></option></term>
11990N/A<listitem><para>
11990N/AThis allows you to view a specific help document by providing the complete
11990N/A<replaceable>url</replaceable> to the documentation that you wish to view.
11990N/A</para>
11990N/A<para>
11990N/AIf <replaceable>url</replaceable> starts with &ldquo;ghelp:&rdquo;,
11990N/A<command>&cmd;</command> opens the help document within
11990N/A<command>ghelp</command>.
11990N/A</para>
11990N/A<para>
11990N/AIf <replaceable>url</replaceable> does not start with &ldquo;ghelp:&rdquo;,
11990N/A<command>&cmd;</command> attempts to launch a default Internet browser window
11990N/Aand display the contents of the help document within this browser window.
11990N/A</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="yelp-1-exde"><title>&exde-tt;</title>
11934N/A<para>Refer to the GNOME Handbook of Writing Software Documentation:</para>
10139N/A<para><literal>http://developer.gnome.org/projects/gdp/handbook.html</literal></para>
10139N/A<para>To access the API documentation for including help in applications,
10139N/Ayou must install the developer version of the package.</para>
10139N/A</refsect1>
10139N/A<refsect1 id="yelp-1-exam"><title>&exam-tt;</title>
10139N/A<example role="example">
10139N/A<title>Launching GNOME Help Browser</title>
10139N/A<para><screen>example% <userinput>&cmd;</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example">
10139N/A<title>Launching GNOME Help Browser and loading the help information for the GNOME Accessibility guide.
10139N/A</title>
10139N/A<para><screen>example% <userinput>&cmd; ghelp:///usr/share/gnome/help/gnome-access-guide/C/gnome-access-guide.xml
10139N/A</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example">
10139N/A<title>Launching GNOME Help Browser with a standard Internet URL</title>
11933N/A<para><screen>example% <userinput>&cmd; <literal>http://www.gnome.org</literal></userinput></screen></para>
10139N/A<para>The default Internet browser is launched (unless a browser is already
10139N/Arunning), and this URL is displayed within the browser window.</para>
10139N/A</example>
10139N/A</refsect1>
10139N/A<refsect1 id="yelp-1-envr"><title>&envr-tt;</title>
10139N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
10139N/A5</manvolnum></citerefentry> for descriptions of the following environment
10139N/Avariables:</para>
10139N/A<variablelist>
11990N/A<varlistentry>
11990N/A<term>INFOPATH</term>
11990N/A<listitem><para>
11990N/ALocation of GNU Info files.
10139N/A</para>
10139N/A</listitem></varlistentry>
11990N/A<varlistentry>
11990N/A<term>MANPATH</term>
11990N/A<listitem><para>
11990N/ALocation of man pages.
11990N/A</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="yelp-1-exit"><title>&exit-tt;</title>
10139N/A<para>The following exit values are returned:</para>
10139N/A<variablelist termlength="xtranarrow">
11990N/A<varlistentry>
11990N/A<term><returnvalue>0</returnvalue></term>
11990N/A<listitem><para>
11990N/AApplication exited successfully
11990N/A</para>
10139N/A</listitem></varlistentry>
11990N/A<varlistentry>
11990N/A<term><returnvalue>>0</returnvalue></term>
11990N/A<listitem><para>
11990N/AApplication exited with failure
11990N/A</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="yelp-1-file"><title>&file-tt;</title>
10139N/A<para>The following files are used by this application:</para>
10139N/A<variablelist termlength="medium">
11990N/A<varlistentry>
11990N/A<term><filename>/usr/bin/&cmd;</filename></term>
11990N/A<listitem><para>
15944N/AExecutable for GNOME help browser.
11990N/A</para>
10139N/A</listitem></varlistentry>
11990N/A<varlistentry>
11990N/A<term><filename>/usr/bin/gnome-help</filename></term>
11990N/A<listitem><para>
15944N/ASymbolic link to run <command>&cmd;</command>.
11990N/A</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="yelp-1-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
18745N/A<row><entry><para>Availability</para></entry><entry><para>gnome/help-viewer/yelp
10139N/A</para></entry></row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
10139N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="yelp-1-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
10139N/A<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle>
10139N/Afor your platform.</para>
10139N/A<para>
10139N/A<citerefentry><refentrytitle>scrollkeeper-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>scrollkeeper</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>scrollkeeper-devel</refentrytitle><manvolnum>1</manvolnum>,
11904N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
10139N/A</citerefentry></para>
10139N/A</refsect1>
10139N/A<refsect1 id="yelp-1-note"><title>&note-tt;</title>
10139N/A<para><command>&cmd;</command> and gnome-help are both the same application.
10139N/A</para>
11933N/A<para>Written by Matt Keenan, Sun Microsystems Inc., 2003, 2007.</para>
10139N/A</refsect1>
10139N/A</refentry>