JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Solaris 11.1 Desktop User's Guide     Oracle Solaris 11.1 Information Library
search filter icon
search icon

Document Information

Preface

1.  Getting Started With the Desktop

2.  Using the Desktop Windows

3.  Using the Desktop Workspaces

4.  Using the Desktop Panels

5.  Using the Desktop Applications

6.  Using the Main Menubar

7.  Using Time Slider

8.  Using the File Manager

9.  Using the Desktop Tools and Utilities

Running Applications

How to Run an Application From the Command Line

Taking Screenshots

Overview of the Yelp Help Browser

Yelp Help Browser Interface

Working With Yelp

How to Open a Document Through the GUI

Searching Documents

How to Open a New Window

How to Display Information About a DocBook Document

How to Print the Current Page

How to Print a Docbook Document

How to Close a Window

How to Set Preferences

How to Add a Bookmark

How to Edit Bookmarks

How to Display Help

Navigating the Yelp Help Browser

Opening Documents from the Command Line

10.  Configuring the Desktop

A.  Using the Mouse

B.  Using the Keyboard

Overview of the Yelp Help Browser

The Yelp Help Browser application enables you to view documentation regarding GNOME and other components through a variety of formats. These formats include docbook files, HTML help pages, man pages, and info pages (support for man pages and info pages might optionally be compiled in). Yelp tries to provide a unified look and feel regardless of the original document format.

The Yelp Help Browser is internationalized, meaning that it has support to view documents in different languages. The documents must be localized or translated for each language and installed for Yelp Help Browser to be able to view them.

You can start Yelp Help Browser in one of the following ways:

Yelp Help Browser Interface

The browser pane displays the table of contents or the documentation. Use the table of contents to navigate to the documentation you need.

Yelp Help Browser contains the elements described in the following table.

Menubar

File

Use this menu to open a new window, view the About this Document page, print the current document, or close the window.

Edit

Use this menu to copy, select, find, or to set preferences.

Go

Use this menu to navigate back or forward, to the Help Topics page. When viewing a docbook document, use this menu to navigate to the next section, the previous section, or to the contents page.

Bookmarks

Use this menu to add or edit bookmarks.

Help

View information about the Yelp Help Browser and contributors to the project through the About menu item. Open this document from the Contents menu item or by pressing F1.

Toolbar

Back

Navigate back in document history.

Forward

Navigate forward in document history.

Home

Return to the main table of contents.

Search

Search all desktop help documents for a particular word or phrase.

Working With Yelp

You can use Yelp to perform the following actions:

How to Open a Document Through the GUI

Searching Documents

This section describes how to search for documents.

How to Search in a Current Page

  1. Choose Edit → Find or press Ctrl+F.

    The search bar appears at the bottom of the window.

  2. In the Find field on the search bar, type the word or phrase that you want to search, and then press Return.

    If the word or phrase is found on the page, the first occurrence is highlighted. Press Return again to highlight the next occurrence.

  3. (Optional) Click Close on the search bar to close it.

How to Search Indexed Documents

  1. Click the Search field on the toolbar or Press Alt+S.
  2. Type the word or phrase that you want to search, and then press Return.

    A list of all the matching documents is shown in which the word or phrase is found.

  3. Click the document name to view a matching page.

    After viewing a matching page, click the Back button on the toolbar to return to the list of search results.

How to Open a New Window

  1. Click File → New Window.
  2. Press Ctrl+N.

How to Display Information About a DocBook Document

This option is only available for DocBook documentation. Legal notices and documentation contributors are listed in this section.

How to Print the Current Page

How to Print a Docbook Document

This option is only available for DocBook documentation.

How to Close a Window

How to Set Preferences

How to Add a Bookmark

  1. Choose Bookmarks → Add Bookmark or press Ctrl+D.

    The Add Bookmark window is displayed.

  2. Type a desired bookmark title in the Title field.
  3. Click Add to add the bookmark.

How to Edit Bookmarks

  1. Choose Bookmarks → Edit Bookmarks or press Ctrl+B.

    The Bookmarks window is displayed. It provides the following options:

    • Open – Opens the selected bookmark in a new window.

    • Rename – Renames the title of a bookmark.

    • Remove – Deletes the bookmark from the collection.

  2. Click Close to exit the Bookmarks window.

How to Display Help

Navigating the Yelp Help Browser

You can navigate within the Yelp Help Browser as follows:

Opening Documents from the Command Line

The Yelp Help Browser supports opening documents from the command line. A number of URIs (Uniform Resource Identifiers) can be used, including the following:

-file:

Accesses a file with Yelp, for example:

yelp file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml
-ghelp: or -gnome-help:

Accesses GNOME help documents, which are written in DocBook format.

yelp ghelp:gcalctool

If you want to open the help document at a particular section, append a question mark to the end of the URI, followed by the section ID.

yelp ghelp:user-guide?yelp-advanced-cmdline
-man:

Accesses a particular man page. You can append the section of the man page you would like to view if there are multiple man pages with the same name. The section number must be enclosed in parenthesis and you might have to escape the argument so that the shell does not interpret the parenthesis.

yelp man:gcalctool

or

yelp 'man:intro(1)'
yelp 'man:intro(2)'
-info:

Accesses the specified GNU info page.

yelp info:make