Yelp (software)

{{Short description|Help documentation viewer for GNOME}}

{{Infobox software

| title = Yelp

| logo = GNOME Help (Yelp) icon.svg

| logo alt = Icon for the GNOME program Yelp, showing a white floatation ring with four red stripes with rope on each of the red stripes

| screenshot = GNOME Help 47.png

| screenshot alt = Screenshot of the GNOME's Yelp program showing various help descriptions

| author = Mikael Hallendal and Alexander Larsson

| developer =

| released = {{Start date and age|2001|10|27|df=no}}{{Cite web |last=Scorgie |first=Don |date=April 30, 2009 |title=ChangeLog |url=https://gitlab.gnome.org/GNOME/yelp/-/blob/master/ChangeLog |access-date=August 27, 2022 |website=gitlab.gnome.org |archive-date=August 28, 2022 |archive-url=https://web.archive.org/web/20220828040705/https://gitlab.gnome.org/GNOME/yelp/-/blob/master/ChangeLog |url-status=live }}

| ver layout =

| discontinued =

| latest release version = {{wikidata|property|reference|P348}}

| latest release date = {{start date and age|{{wikidata|qualifier|P348|P577}}}}

| repo = {{URL|https://gitlab.gnome.org/GNOME/yelp}}

| qid =

| programming language =

| middleware =

| engine =

| operating system =

| platform =

| included with =

| replaces =

| replaced_by =

| service_name =

| size =

| standard =

| language =

| language count =

| language footnote =

| genre =

| license = GPLv2{{Cite web |last=McCance |first=Shaun |date=April 26, 2016 |title=Copying |url=https://gitlab.gnome.org/GNOME/yelp/-/blob/master/COPYING |access-date=August 27, 2022 |website=gitlab.gnome.org |archive-date=August 28, 2022 |archive-url=https://web.archive.org/web/20220828040739/https://gitlab.gnome.org/GNOME/yelp/-/blob/master/COPYING |url-status=live }}

| website = {{URL|yelp.io}}

| AsOf =

}}

Yelp, also known as the GNOME Help Browser is the default help viewer for GNOME that allows users to access help documentation.{{Cite web |title=Overview of the Yelp Help Browser |url=https://docs.oracle.com/cd/E23824_01/html/E24676/glmei.html |access-date=August 27, 2022 |website=Oracle Corporation |archive-date=August 8, 2015 |archive-url=https://web.archive.org/web/20150808215832/http://docs.oracle.com/cd/E23824_01/html/E24676/glmei.html |url-status=live }} Yelp follows the freedesktop.org help system specification{{Cite web |title=yelp 41.0 |url=https://guix.gnu.org/en/packages/yelp-41.0/ |access-date=August 27, 2022 |website=guix.gnu.org |archive-date=August 28, 2022 |archive-url=https://web.archive.org/web/20220828040705/https://guix.gnu.org/en/packages/yelp-41.0/ |url-status=live }} and reads mallard, DocBook, man pages, info, and HTML documents.{{Cite web |date=January 12, 2019 |title=Apps/Yelp |url=https://wiki.gnome.org/Apps/Yelp |access-date=August 27, 2022 |website=wiki.gnome.org |archive-date=August 24, 2022 |archive-url=https://web.archive.org/web/20220824160205/https://wiki.gnome.org/Apps/Yelp |url-status=live }} HTML is available by using XSLT to render XML documents into HTML.{{Cite report |title=Merging structure and sequence: Software to help teams document and execute mission critical events |last=Cowie |first=Andrew Frederick |date=2004 |citeseerx=10.1.1.202.3756 |s2cid=17334937 }}

Yelp has a search feature{{Cite book |last=Schroder |first=Carla |url=https://www.worldcat.org/oclc/771953312 |title=Linux cookbook |date=2004 |publisher=O'Reilly |isbn=978-0-596-51750-2 |location=Beijing |pages=2 |oclc=771953312 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040701/https://www.worldcat.org/title/771953312 |url-status=live }} as well as a toolbar at the top for navigation through previously viewed documentation.{{Cite book |last=Petersen |first=Richard |url=https://www.worldcat.org/oclc/883396549 |title=Beginning Fedora Desktop |date=2014 |publisher=Apress |isbn=978-1-4842-0067-4 |location=Berkeley, CA |pages=246 |oclc=883396549 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040733/https://www.worldcat.org/title/883396549 |url-status=live }}

Yelp can be accessed by typing {{kbd|yelp}} either into GNOME Shell, after pressing {{key press|Alt|F2}} within GNOME, or within a terminal{{Cite book |last=Sobell |first=Mark G. |url=https://www.worldcat.org/oclc/870467604 |title=A practical guide to Fedora and Red Hat Enterprise Linux |date=2014 |publisher=Prentice Hall |isbn=978-0-13-347744-3 |edition=7th |location=Upper Saddle River, NJ |pages=113 |oclc=870467604 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040703/https://www.worldcat.org/title/870467604 |url-status=live }} using the {{kbd|yelp [file]}} format.{{Cite web |last=Haltom |first=Jerry |title=yelp linux command man page |url=https://www.commandlinux.com/man-page/man1/yelp.1.html |access-date=August 27, 2022 |website=CommandLinux.com}}{{Cite book |last=Shekhar |first=Vijay |url=https://www.worldcat.org/oclc/228137134 |title=Red Hat Linux : the compete bible. |date=2006 |publisher=Laxmi Publications Pvt. Ltd./Firewall Media |isbn=81-7008-863-1 |pages=126 |oclc=228137134 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040703/https://www.worldcat.org/title/228137134 |url-status=live }} The command {{kbd|gnome-help}} can also be used to access Yelp.{{Cite book |last=Fusco |first=John |url=https://www.worldcat.org/oclc/1337943343 |title=The Linux Programmer's Toolbox |date=2007 |publisher=Pearson Education, Limited |isbn=978-0-13-270304-8 |location=Sydney |oclc=1337943343 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040703/https://www.worldcat.org/title/1337943343 |url-status=live }}

Although Yelp is not required for GNOME to function, it is required to view GNOME's help documentation.{{Cite web |title=Yelp-42.1 |url=https://www.linuxfromscratch.org/blfs/view/svn/gnome/yelp.html |access-date=August 27, 2022 |website=Linux From Scratch |archive-date=August 8, 2020 |archive-url=https://web.archive.org/web/20200808204219/http://www.linuxfromscratch.org/blfs/view/svn/gnome/yelp.html |url-status=live }} Ubuntu also uses yelp to provide a customized help interface for its software.{{Cite book |last=Sobell |first=Mark G. |url=https://www.worldcat.org/oclc/890912722 |title=A practical guide to Ubuntu Linux |date=2015 |isbn=978-0-13-392731-3 |edition=Fourth |location=Upper Saddle River, NJ |pages=118 |oclc=890912722}}

A format string vulnerability in GNOME versions 2.19.90 and 2.24 allowed arbitrary code execution through Yelp.{{Cite book |last1=Jackson |first1=Todd |last2=Salamat |first2=Babak |last3=Wagner |first3=Gregor |last4=Wimmer |first4=Christian |last5=Franz |first5=Michael |title=Proceedings of the 6th International Workshop on Security Measurements and Metrics |chapter=On the effectiveness of multi-variant program execution for vulnerability detection and prevention |date=2010 |chapter-url=http://portal.acm.org/citation.cfm?doid=1853919.1853929 |language=en |location=Bolzano, Italy |publisher=ACM Press |pages=4 |doi=10.1145/1853919.1853929 |isbn=978-1-4503-0340-8 |s2cid=6697258 |access-date=2022-08-27 |archive-date=2022-08-28 |archive-url=https://web.archive.org/web/20220828040708/https://dl.acm.org/doi/10.1145/1853919.1853929 |url-status=live }}