LinuxCommandLibrary

yelp

Browse and view GNOME help documentation

SYNOPSIS

yelp [OPTIONS] [URI]

PARAMETERS

URI
    URI of the document to display. If not specified, opens the home page.

--version
    Display the version number and exit.

--help
    Show help options.

--help-all
    Show all help options.

--help-gtk
    Show GTK+ Options.

DESCRIPTION

yelp is the GNOME help browser, used to display help documentation for GNOME applications and other software. It uses the Mallard markup language for documentation and can also display man pages and info pages.

yelp provides a graphical user interface for navigating and searching help content. It supports features like bookmarks, history, and full-text search. It is tightly integrated with the GNOME desktop environment and provides a consistent look and feel for help documentation across different applications. The command allows users to easily access information about software installed on their system.

CAVEATS

While yelp can display man pages, it is primarily designed for Mallard documentation. Displaying man pages might not always be perfect, especially for complex formatting or non-standard man pages.

USAGE

To open a specific help page, use yelp with the URI of the page. For example, to open the help page for the gedit text editor, use: yelp ghelp:gedit
To open a man page, use: yelp man:command_name
To open the home page, simply run yelp without any arguments.

HISTORY

yelp was developed as part of the GNOME project to provide a modern and user-friendly help browser. It replaced older help browsers and incorporated features like Mallard support for richer documentation. It's evolution is tightly tied to the GNOME desktop environment updates, ensuring compatibility with new technologies and standards.

SEE ALSO

man(1), info(1)

Copied to clipboard