3 Known Problems and Workarounds
- 1 -
1. Introduction
This release note documents the Silicon Graphics Desktop
Help Software. The Desktop Help Software communicates
directly with the program SGIHelp (the Desktop Help Server
program) to provide an overview of tasks a user would
perform using tools on the desktop. The Desktop Help Index
that gets displayed to the user is a task-orientated means
of accessing help for the desktop. This index can be used to
launch the user straight into the SGIHelp viewer for a
particular topic. Once within the SGIHelp Viewer, the user
can scroll throught the text, navigate via hypertext links,
view glossary terms, and print.
Note: Packaged with this software is a separate sheet that
contains the Software License Agreement. This
software is provided to you solely under the terms
and conditions of the Software License Agreement.
Please take a few moments to review the Agreement.
These release notes contain the following chapters:
1. Introduction
2. Installation Information
3. Known Problems and Workarounds
1.1 Release_Identification_Information
Following is the release identification information for
DesktopHelp:
Software Option Product DesktopHelp
Version 1.0.1
System Software Requirements IRIX 5.2 or later
1.2 Online_Release_Notes
After you install the online documentation for a product
(the relnotes subsystem), you can view the release notes on
your screen.
Select ``Release Notes'' from the Help submenu of the
Toolchest. This displays the grelnotes(1) graphical browser
for the online release notes.
- 2 -
Refer to the grelnotes(1) man page for information on
options to this command.
1.3 Online_Help
After you install the DesktopHelp product, you can view the
online help that is available for the product.
The online help can be accessed from the from the ``Help''
pushbutton of the Index window.
1.4 Product_Support
Silicon Graphics, Inc., provides a comprehensive product
support maintenance program for its products.
If you are in North America and would like support for your
Silicon Graphics-supported products, contact the Technical
Assistance Center at
1-800-800-4SGI.
If you are outside North America, contact the Silicon
Graphics subsidiary or authorized distributor in your
country.
- 1 -
2. Installation_Information
This chapter lists information supplemental to the IRIS
Software Installation Guide. The information listed here is
product-specific; use it with the Installation Guide to
install this product.
2.1 DesktopHelp_Subsystems
This area includes a description of all relevant and
interesting subsystems that apply to the usage of the
DesktopHelp environment.
The DesktopHelp product includes these subsystems:
desktophelp.man.man DesktopHelp man pages
desktophelp.man.relnotes DesktopHelp release
notes (this document)
desktophelp.sw.client DesktopHelp software
Other required subsystems include:
sgihelp.sw.eoe SGIHelp (Desktop Help)
Server
insight.sw.data data files shared by
IRIS InSight and
SGIHelp
desktop_eoe.books.DesktopHelp IndigoMagic Desktop
Help
2.2 DesktopHelp_Subsystem_Disk_Space_Requirements
This section lists the subsystems (and their sizes) of the
DesktopHelp software.
All of the subsystems are installed if you use the ``go''
menu item. To install a different set of subsystems, use
the ``install,'' ``remove,'' ``keep,'' and ``step'' commands
in inst to customize the list of subsystems to be installed,
then select the ``go'' menu item.
Note: The listed subsystem sizes are approximate. Refer to
the IRIS Software Installation Guide for information
on finding exact sizes.
Subsystem Name Subsystem Size
- 2 -
(512-byte blocks)
desktophelp.man.man 5
desktophelp.man.relnotes 15
desktophelp.sw.client 30
2.3 Installation_Method
All of the subsystems for DesktopHelp can be installed using
IRIX. You do not need to use the miniroot. Refer to the
IRIS Software Installation Guide for complete installation
instructions.
2.4 Other_Installation_Information
Refer to the SGIHelp release notes for information about the
installation of the Desktop Help Server, SGIHelp.
Refer to the IRIS InSight release notes for information
about the installation of books (content).
2.5 Execution_After_Installation
After the software has been installed, you might want to
force your shell to re-cache its list of known executables:
rehash
You should never have to explicitely execute the desktophelp
process from a shell. It can be started from the Toolchest
under ``Help - Desktop Help''. Once started, it will
communicate directly with the sgihelp process (Desktop Help
Server) and issues a request for the server to display the
Desktop Help Index.
After the desktophelp process issues the command, the
process quits.
Note that the sgihelp process should be present (installed)
on the user's machine for this to work. If it is not
installed, a warning will be issued to the user. However,
the sgihelp process does not need to be running for the
request to be made. It will be started automatically.
- 1 -
3. Known_Problems_and_Workarounds
This chapter describes the known problems with the current
release of the DesktopHelp Software and how to work around
them.
3.1 DesktopHelp_Software
o If the Desktop Help Server (SGIHelp) is not installed
on the user's machine when a request is made for
Desktop Help, you will receive the following warning
message:
SGIHelp server program (/usr/sbin/sgihelp) not found.
Is sgihelp.sw.eoe installed?
Installing the sgihelp.sw.eoe subsystem should remedy
the problem.
o See the SGIHelp release notes, ``Known Problems and
Workarounds'' for additional information.