Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

OpenSolaris 2009.06 - man page for yelp (opensolaris section 1)

yelp(1) 							   User Commands							   yelp(1)

NAME
yelp, gnome-help - GNOME help browser
SYNOPSIS
yelp | gnome-help [--private-session] [--with-cache-dir=string] [gnome-std-options] url
DESCRIPTION
The GNOME help browser is a utility that allows users to view documentation for GNOME in several formats including man pages, HTML, SGML(DocBook), and GNU info files.
OPTIONS
The following options are supported: --private-session Use a private session. --with-cache-dir=directory Specify which cache directory to use. gnome-std-options Standard options available for use with most GNOME applications. See gnome-std-options(5) for more infor- mation.
OPERANDS
The following operands are supported: url This allows you to view a specific help document by providing the complete url to the documentation that you wish to view. If url starts with "ghelp:", yelp opens the help document within ghelp. If url does not start with "ghelp:", yelp attempts to launch a default Internet browser window and display the contents of the help document within this browser window.
EXTENDED DESCRIPTION
Refer to the GNOME Handbook of Writing Software Documentation: http://developer.gnome.org/projects/gdp/handbook.html To access the API documentation for including help in applications, you must install the developer version of the package.
EXAMPLES
Example 1: Launching GNOME Help Browser example% yelp Example 2: Launching GNOME Help Browser and loading the help information for the GNOME Accessibility guide. example% yelp ghelp:///usr/share/gnome/help/gnome-access-guide/C/gnome-access-guide.xml Example 3: Launching GNOME Help Browser with a standard Internet URL example% yelp http://www.gnome.org The default Internet browser is launched (unless a browser is already running), and this URL is displayed within the browser window.
ENVIRONMENT VARIABLES
See environ(5) for descriptions of the following environment variables: INFOPATH Location of GNU Info files. MANPATH Location of man pages.
EXIT STATUS
The following exit values are returned: 0 Application exited successfully >0 Application exited with failure
FILES
The following files are used by this application: /usr/bin/yelp Executable for GNOME help browser /usr/bin/gnome-help Symbolic link to yelp.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWgnome-help-viewer | +-----------------------------+-----------------------------+ |Interface stability |Volatile | +-----------------------------+-----------------------------+
SEE ALSO
Latest version of the GNOME Desktop User Guide for your platform. scrollkeeper-config(1), scrollkeeper(1), scrollkeeper-devel(1), attributes(5), environ(5), gnome-std-options(5)
NOTES
yelp and gnome-help are both the same application. Written by Matt Keenan, Sun Microsystems Inc., 2003, 2007. SunOS 5.11 08 Nov 2007 yelp(1)