Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

gnome-help (1)

Name

gnome-help - GNOME help browser

Synopsis

yelp  [--private-session] [--with-cache-dir=string] [gnome-std-options]
url

Description

yelp(1)                          User Commands                         yelp(1)



NAME
       yelp, gnome-help - GNOME help browser

SYNOPSIS
       yelp  [--private-session] [--with-cache-dir=string] [gnome-std-options]
       url

DESCRIPTION
       The GNOME help browser is a utility that allows users to view  documen-
       tation for GNOME in several formats including man pages, Mallard, 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(7) for more information.

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  docu-
                       ment 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 Documentation Project webpages:

       https://wiki.gnome.org/DocumentationProject/

EXAMPLES
       Example 1: Launching GNOME Help Browser

       example% yelp

       Example 2: Launching GNOME Help Browser and loading the  help  informa-
       tion 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(7) 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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE     |
       +---------------+------------------------+
       |Availability   | gnome/help-viewer/yelp |
       +---------------+------------------------+
       |Stability      | Pass-through volatile  |
       +---------------+------------------------+
SEE ALSO
       Latest version of the GNOME Desktop User Guide for your platform.

       attributes(7), environ(7), gnome-std-options(7)

NOTES
       yelp and gnome-help are the same application.

       Written by Matt Keenan, Sun Microsystems Inc., 2003, 2007.


       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source        was        downloaded         from          https://down-
       load.gnome.org/sources/yelp/3.22/yelp-3.22.0.tar.xz

       Further information about this software can be found on the open source
       community website at https://wiki.gnome.org/Apps/Yelp.



Solaris 11.4                      7 Apr 2017                           yelp(1)