Next: gnome-init, Previous: Overview, Up: Top

---

— Function: gnome-help-display (file_name mchars) (link_id mchars) ⇒ (ret bool)

Displays the help file specified by file-name at location link-id in the preferred help browser of the user.

file-name

The name of the help document to display.

link-id

Can be ‘#f’. If set, refers to an anchor or section id within the requested document.

error

A <g-error> instance that will hold the specifics of any error which occurs during processing, or ‘#f’

ret

‘#t’ on success, ‘#f’ otherwise (in which case error will contain the actual error).

— Function: gnome-help-display-with-doc-id (program <gnome-program>) (doc_id mchars) (file_name mchars) (link_id mchars) ⇒ (ret bool)

Displays the help file specified by file-name at location link-id within the doc-id domain in the preferred help browser of the user. Most of the time, you want to call gnome-help-display instead.

This function will display the help through creating a "ghelp" URI, by looking for file-name in the applications installed help location (found by <gnome-file-domain-app-help>) and its app_id. The resulting URI is roughly in the form "ghelp:appid/file_name?link_id". If a matching file cannot be found, ‘#f’ is returned and error is set.

Please note that this only displays application help. To display help files from the global GNOME domain, you will want to use gnome-help-display-desktop.

program

The current application object, or ‘#f’ for the default one.

doc-id

The document identifier, or ‘#f’ to default to the application ID (app_id) of the specified program.

file-name

The name of the help document to display.

link-id

Can be ‘#f’. If set, refers to an anchor or section id within the requested document.

error

A <g-error> instance that will hold the specifics of any error which occurs during processing, or ‘#f’

ret

‘#t’ on success, ‘#f’ otherwise (in which case error will contain the actual error).

— Function: gnome-help-display-desktop (program <gnome-program>) (doc_id mchars) (file_name mchars) (link_id mchars) ⇒ (ret bool)

Displays the GNOME system help file specified by file-name at location link-id in the preferred help browser of the user. This is done by creating a "ghelp" URI, by looking for file-name in the system help domain (<gnome-file-domain-help>) and it's app_id. This domain is determined when the library is compiled. If a matching file cannot be found, ‘#f’ is returned and error is set.

Please note that this only displays system help. To display help files for an application, you will want to use gnome-help-display.

program

The current application object, or ‘#f’ for the default one.

doc-id

The name of the help file relative to the system's help domain (<gnome-file-domain-help>).

file-name

The name of the help document to display.

link-id

Can be ‘#f’. If set, refers to an anchor or section id within the requested document.

error

A <g-error> instance that will hold the specifics of any error which occurs during processing, or ‘#f’

ret

‘#t’ on success, ‘#f’ otherwise (in which case error will contain the actual error).

— Function: gnome-help-display-uri (help_uri mchars) ⇒ (ret bool)

Displays help-uri in the user's preferred viewer. You should never need to call this function directly in code, since it is just a wrapper for gnome-url-show and consequently the viewer used to display the results depends upon the scheme of the URI (so it is not strictly a help-only function).

help-uri

The URI to display.

error

A <g-error> instance that will hold the specifics of any error which occurs during processing, or ‘#f’

ret

‘#t’ on success, ‘#f’ otherwise (in which case error will contain the actual error).