<!-- $XConsortium: ch03.sgm /main/14 1996/11/11 20:12:39 cdedoc $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="UG.GHelp.div.1">
<title id="UG.GHelp.mkr.1">Getting Help <?X-setsize 13.0 pt><indexterm><primary>online help</primary></indexterm><?X-setsize 13.0 pt></title>
<para>Online help is available for each of the standard applications in the
Common Desktop Environment (CDE). Whether you are using File Manager,
Calendar, or Mailer for example, you request and display help topics in the same way.
You can also view help information on your system using the desktop Help
Manager.</para>
<para>Other applications installed on your desktop may take advantage of using
the desktop's Help System or provide help in other ways.</para>
<informaltable id="UG.GHelp.itbl.1" frame="All">
<tgroup cols="1" colsep="1" rowsep="1">
<colspec colwidth="4.00in">
<tbody>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Requesting
Help42'--><xref role="JumpText" linkend="UG.GHelp.mkr.2"></para></entry></row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Using Help
Windows45'--><xref role="JumpText" linkend="UG.GHelp.mkr.6"></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Selecting
Help Topics46'--><xref role="JumpText" linkend="UG.GHelp.mkr.8"></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Moving
between Help Topics48'--><xref role="JumpText" linkend="UG.GHelp.mkr.12"></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Searching
for Specific Information51'--><xref role="JumpText" linkend="UG.GHelp.mkr.13"></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Viewing
Help on Your System53'--><xref role="JumpText" linkend="UG.GHelp.mkr.17"></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><!--Original XRef content: 'Printing
Help Topics57'--><xref role="JumpText" linkend="UG.GHelp.mkr.20"></para></entry>
</row></tbody></tgroup></informaltable>
<sect1 id="UG.GHelp.div.2">
<title id="UG.GHelp.mkr.2">Requesting Help</title>
<para><literal><indexterm><primary>application help</primary></indexterm></literal>Here
are the ways you can request<?Pub Caret> Help:</para>
<itemizedlist remap="Bullet1"><listitem><para>Press F1&mdash;also known as
the &ldquo;help key&rdquo;&mdash;to get <emphasis>context-sensitive</emphasis>
help</para>
</listitem><listitem><para>Choose a command from an application's Help menu
</para>
</listitem>
<listitem><para>Open the Information Manager subpanel
to open Help Manager or choose On Item Help or help about the desktop</para>
</listitem></itemizedlist>
<sect2 id="UG.GHelp.div.3">
<title>Press F1 <literal>&mdash;</literal> The Help Key<indexterm><primary>help</primary><secondary>using Help key</secondary></indexterm></title>
<para>When you have a question, the quickest and easiest way to get help is
to press F1. When you press F1, the application you are using displays a
help topic most closely related to the component&mdash;a window or button
for example&mdash;that is highlighted.<indexterm><primary>help</primary>
<secondary>context-sensitive</secondary></indexterm> Because the application
determines which help topic is most appropriate, this type of help is called <emphasis>context-sensitive</emphasis>.</para>
<para>The F1 key is a quick way to get help on an application menu or dialog
box. For example, to request help about the File Manager File menu, display
the File menu and press F1. File Manager displays a description of each item
in the menu. Or, if a dialog box is open, pressing F1 will display an explanation
of the dialog box. The F1 key is a shortcut for clicking the dialog box's
Help button.</para>
<note>
<para>Some computers have a dedicated &ldquo;Help&rdquo; key on the keyboard.
If yours does, it may take the place of the F1 key.</para>
</note>
</sect2>
<sect2 id="UG.GHelp.div.4">
<title>Using an Application's Help Menu</title>
<para>Most applications have a Help menu that contains commands for requesting
different types of help such as an introduction, application tasks, or reference
information.</para>
<figure>
<title>CDE application Help menu</title>
<graphic id="UG.GHelp.grph.1" entityref="UG.GHelp.fig.1"></graphic>
</figure>
<para>A typical CDE Help menu includes these commands:</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.13in">
<colspec align="left" colwidth="143*">
<colspec align="left" colwidth="362*">
<tbody>
<row>
<entry align="left" valign="top"><para>Overview</para></entry>
<entry align="left" valign="top"><para>Displays the <emphasis>home topic</emphasis>
for the application. The home topic is the first topic of the application's
help topic hierarchy.</para></entry></row>
<row>
<entry align="left" valign="top"><para>Table of Contents</para></entry>
<entry align="left" valign="top"><para>Displays all the topics
in the the application's help topic hierarchy.
</para></entry></row>
<row>
<entry align="left" valign="top"><para>Tasks</para></entry>
<entry align="left" valign="top"><para>Displays task instructions for most
operations performed with the application.</para></entry></row>
<row>
<entry align="left" valign="top"><para>Reference</para></entry>
<entry align="left" valign="top"><para>Displays reference summaries for various
components, such as windows and dialog boxes, menus, and application resources.
</para></entry></row>
<row>
<entry align="left" valign="top"><para>On Item</para></entry>
<entry align="left" valign="top"><para>Enables you to click an item in any
window of an application and view a description of the item.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>Using Help</para></entry>
<entry align="left" valign="top"><para>Provides help on using the help windows.
</para></entry></row>
<row>
<entry align="left" valign="top"><para>About <emphasis>Application</emphasis></para></entry>
<entry align="left" valign="top"><para>Displays the version and copyright
information for the application.</para></entry></row></tbody></tgroup></informaltable>
<para>Applications can include additional choices. Also, non-CDE applications
may have different commands in their Help menus.</para>
<sect3 id="UG.GHelp.div.5">
<title>On Item Application Help<indexterm><primary>On Item help</primary>
</indexterm><indexterm><primary>help</primary><secondary>On Item help</secondary></indexterm></title>
<para>On Item help is interactive. It enables you to move the pointer to a
specific item (such as a menu, button or dialog box) and click the item to
display its corresponding help.</para>
</sect3>
<sect3 id="UG.GHelp.div.6" role="Procedure">
<title id="UG.GHelp.mkr.3">To Select On Item Help</title>
<orderedlist><listitem><para>Choose On Item from the Help menu.</para>
<para>The pointer changes to a ? (question mark).</para>
</listitem><listitem><para>Move the pointer to an item in the application
and click mouse button 1.</para>
<para>A description of the item is displayed.</para>
</listitem></orderedlist>
</sect3>
</sect2>
<sect2 id="UG.GHelp.div.7">
<title id="UG.GHelp.mkr.4">Using Help Manager<indexterm><primary>Help Manager</primary><secondary>Front Panel control</secondary></indexterm></title>
<para>Help Manager is a special help volume that lists all the online help
registered on your system. Clicking Help Manager in the Information Manager subpanel
opens the Help Manager help volume.
</para>
<figure>
<title id="UG.GHelp.mkr.5">Information Manager subpanel</title>
<graphic id="UG.GHelp.grph.2" entityref="UG.GHelp.fig.2"></graphic>
</figure>
<para>Click any of the underlined titles to view the corresponding help information.
For additional instructions about using Help Manager see <!--Original XRef
content: '&xd2;Viewing Help on
Your System&xd3; on page 53'--><xref role="SecTitleAndPageNum" linkend="UG.GHelp.mkr.17">.
</para>
<para>For convenience, you can also find help about the desktop and the Front
Panel in the Information Manager subpanel. It also provides On Item help for the Front Panel
and its subpanels.</para>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.8">
<title id="UG.GHelp.mkr.6">Using Help Windows</title>
<para>The <emphasis>Help System</emphasis> is
built into each of the CDE applications (and possibly other applications
installed on your system). When you ask for help while using an application,
the application displays a help window.<indexterm><primary>help</primary>
<secondary>windows</secondary></indexterm><indexterm><primary>help windows</primary>
<secondary>types of</secondary></indexterm></para>
<para>Applications can use two types of help windows to display help topics:
a <emphasis>general help window</emphasis> and a <emphasis>quick help window</emphasis>, shown in <!--Original
XRef content: 'Figure 3&hyphen;4'--><xref role="CodeOrFigureOrTable"
linkend="UG.GHelp.mkr.7">.</para>
<figure>
<title id="UG.GHelp.mkr.7">Types of help windows</title>
<graphic id="UG.GHelp.grph.4" entityref="UG.GHelp.fig.4"></graphic>
</figure>
<para><indexterm><primary>topic tree</primary></indexterm><indexterm><primary>topic display area</primary></indexterm><emphasis>General help windows</emphasis>
have a topic tree and a topic display area. The <emphasis>topic tree</emphasis>
is a list of help topics that you can view to find help on a subject. When
you choose a topic, it is displayed in the lower portion of the help window
called the <emphasis>topic display area</emphasis>.<indexterm><primary>help windows</primary><secondary>topic tree</secondary></indexterm><indexterm>
<primary>help windows</primary><secondary>topic display area</secondary>
</indexterm></para>
<para><emphasis>Quick help windows</emphasis> are streamlined help windows.
A quick help window has just a topic display area and one or more buttons.
</para>
</sect1>
<sect1 id="UG.GHelp.div.9">
<title id="UG.GHelp.mkr.8">Selecting Help Topics</title>
<para><indexterm><primary>hyperlink, used in help</primary></indexterm><indexterm>
<primary>help</primary><secondary>displaying topics</secondary></indexterm>There
are two ways to select a help topic. You can choose a topic from the topic
tree. Or, within a help topic, you can select a hyperlink. A <emphasis>hyperlink</emphasis> is an active word or phrase that &ldquo;jumps&rdquo; to another
related help topic. Any underlined text in a help window is a hyperlink.
</para>
<para>Graphic images can also be used as hyperlinks. For more information
about hyperlinks, see <!--Original XRef content: '&xd2;Using Hyperlinks&xd3;
on page 47'--><xref role="SecTitleAndPageNum" linkend="UG.GHelp.mkr.10">.
</para>
<sect2 id="UG.GHelp.div.10">
<title>Using the Topic Tree</title>
<para>The topic tree is an outline of a help volume's major topics. Subtopics
are indented under main topics. The current topic, whose contents are displayed
in the topic display area, is marked with an &ogon; (arrow). You can scroll
the topic display area to see all your choices or resize the entire help window.
</para>
<para>You can also change the size of the topic pane. To do so, drag the sash
control shown in <!--Original XRef content: 'Figure 3&hyphen;5'--><xref
role="CodeOrFigureOrTable" linkend="UG.GHelp.mkr.9">. Then release the mouse
button to set the new size.</para>
<figure>
<title id="UG.GHelp.mkr.9">Resizing the topic tree</title>
<graphic id="UG.GHelp.grph.5" entityref="UG.GHelp.fig.5"></graphic>
</figure>
<sect3 id="UG.GHelp.div.11" role="Procedure">
<title>To Select A Topic</title>
<orderedlist><listitem><para>Move the pointer into the topic tree.</para>
</listitem><listitem><para>Click mouse button 1 on the topic you want to display.
</para>
</listitem></orderedlist>
</sect3>
</sect2>
<sect2 id="UG.GHelp.div.12">
<title id="UG.GHelp.mkr.10">Using Hyperlinks</title>
<para>Any underlined text in a help window is a hyperlink. It is easy to &ldquo;jump&rdquo;
to related help topics using hyperlinks&mdash;just click the underlined text.
</para>
<sect3 id="UG.GHelp.div.13">
<title>What Hyperlinks Look Like</title>
<para>A solid underline identifies a standard hyperlink that displays the
new topic in the current help window. For example, the last paragraph in
<!--Original XRef content: 'Figure 3&hyphen;5'--><xref role="CodeOrFigureOrTable"
linkend="UG.GHelp.mkr.9"> shows a hyperlink of this type.</para>
<para>A dashed underline indicates a <emphasis>definition link</emphasis>,
which displays a quick help window.</para>
<para>A graphic&mdash;an icon, for example&mdash;can also be a hyperlink.
A grey open- cornered border identifies a graphic hyperlink. <!--Original
XRef content: 'Figure 3&hyphen;6'--><xref role="CodeOrFigureOrTable"
linkend="UG.GHelp.mkr.11"> shows the different hyperlink formats that can
be used in help topics.</para>
<figure>
<title id="UG.GHelp.mkr.11">Hyperlink formats</title>
<graphic id="UG.GHelp.grph.6" entityref="UG.GHelp.fig.6"></graphic>
</figure>
</sect3>
<sect3 id="UG.GHelp.div.14">
<title>Links That Display a New Window</title>
<para>Most hyperlinks display the related topic in the same window. However,
if you choose a hyperlink that jumps to a help topic for another application,
a new window is displayed. Links that jump from one application's online
help into another's are called <emphasis>cross-volume</emphasis> or <emphasis>cross-application</emphasis> hyperlinks.</para>
</sect3>
<sect3 id="UG.GHelp.div.15" role="Procedure">
<title>To Select A Hyperlink</title>
<orderedlist><listitem><para>Move the pointer to the underlined text or graphic
image.</para>
</listitem><listitem><para>Click mouse button 1.</para>
</listitem></orderedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.16">
<title id="UG.GHelp.mkr.12">Moving between Help Topics<indexterm><primary>help</primary><secondary>moving between topics</secondary></indexterm><indexterm>
<primary>help commands</primary><secondary>Backtrack</secondary></indexterm><indexterm>
<primary>help commands</primary><secondary>History</secondary></indexterm><indexterm>
<primary>help commands</primary><secondary>Home Topic</secondary></indexterm></title>
<para>To move between help topics, use these commands on the Navigate menu:
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="100*">
<colspec align="left" colwidth="356*">
<tbody>
<row>
<entry align="left" valign="top"><para>Backtrack</para></entry>
<entry align="left" valign="top"><para>Returns to the previous topic. Backtrack
enables you to return to each topic you have visited.</para></entry></row>
<row>
<entry align="left" valign="top"><para>History</para></entry>
<entry align="left" valign="top"><para>Displays a History dialog box that
lists help volumes and topics you have visited. Select a help topic to re-display
it.</para></entry></row>
<row>
<entry align="left" valign="top"><para>Home Topic</para></entry>
<entry align="left" valign="top"><para>Returns to the home topic, or beginning
of the help volume.</para></entry></row></tbody></tgroup></informaltable>
<para>For convenience, Backtrack and History are also provided as push buttons.
</para>
<sect2 id="UG.GHelp.div.17">
<title>Help Pop-up Menu<indexterm><primary>help</primary><secondary>pop-up
menu</secondary></indexterm></title>
<para>In a general help window, you can also use the Help pop-up menu as a
shortcut. The pop-up menu includes both Backtrack and Home Topic, which
are frequently used commands.</para>
<para>Quick help windows do not have a pop-up menu.</para>
<sect3 id="UG.GHelp.div.18" role="Procedure">
<title>To Display the Help Pop-up Menu</title>
<orderedlist><listitem><para>Point to the topic display area and press mouse
button 3.</para>
</listitem><listitem><para>Choose Backtrack or Home Topic.</para>
</listitem></orderedlist>
<figure>
<title>Help pop-up menu</title>
<graphic id="UG.GHelp.grph.7" entityref="UG.GHelp.fig.7"></graphic>
</figure>
</sect3>
</sect2>
<sect2 id="UG.GHelp.div.19">
<title>Knowing Where You Are<indexterm><primary>help volume</primary></indexterm><indexterm>
<primary>help topic</primary></indexterm><indexterm><primary>home topic,
in help volume</primary></indexterm><indexterm><primary>help</primary><secondary>hierarchy of topics</secondary></indexterm></title>
<para>Each application that provides online help has a <emphasis>help volume</emphasis>. A volume consists of a group of <emphasis>help topics</emphasis>
that describe the application and explain how to use its features. For instance,
an application could organize its help using these main topics: Concepts,
Tasks and Reference.</para>
<figure>
<title>Help volume organization</title>
<graphic id="UG.GHelp.grph.8" entityref="UG.GHelp.fig.8"></graphic>
</figure>
<para>The home topic is the first topic, or beginning of the help volume.
Main level topics are accessible from the home topic, or may also be listed
in your application's Help menu.</para>
<sect3 id="UG.GHelp.div.20">
<title>Moving between Different Help Volumes</title>
<para>Frequently hyperlinks take you to another topic in your application's
help volume. While viewing the Tasks topics, for example, you might select
a hyperlink to a topic in the Reference section.</para>
<para>A group of related applications, however, may use hyperlinks to cross-
reference information in different help volumes. For example, an application
could include a hyperlink to the desktop's introductory help volume that
explains basic mouse and keyboard skills.</para>
<para>Because hyperlinks can quickly take you from one piece of information
to another, you may need to know where you are. A quick look at your help
window can give you the information you need.</para>
<itemizedlist remap="Bullet1"><listitem><para>The line located below the menu
bar reports the name of the volume you are viewing. This is helpful when
you have explored several help volumes using Help Manager, the help index,
or cross-volume links.</para>
</listitem></itemizedlist>
<graphic id="UG.GHelp.igrph.1" entityref="UG.GHelp.fig.9"></graphic>
<itemizedlist remap="Bullet1"><listitem><para>Within the topic tree, the first
item is the <emphasis>home topic</emphasis>, or the beginning of the help
volume. After exploring topics, you can easily return to the home topic by
scrolling to the top of the topic tree. Or, you can choose Home Topic from
the Navigate menu or pop-up menu.</para>
</listitem><listitem><para>An &ogon; (arrow) points to the title of the current
topic. As you choose topics, the arrow moves to identify your selection.
Scrolling the topic tree shows you where you are located relative to other
topics.</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="UG.GHelp.div.21">
<title>Knowing Where You've Been</title>
<para>A general help window keeps track of the topics that you have visited.
The History command opens a dialog box that lists the help volumes and help
topics you have visited.</para>
<figure>
<title>History dialog box</title>
<graphic id="UG.GHelp.grph.9" entityref="UG.GHelp.fig.10"></graphic>
</figure>
<sect3 id="UG.GHelp.div.22" role="Procedure">
<title>To Use History To Return to a Topic</title>
<orderedlist><listitem><para>Click the History button.</para>
</listitem><listitem><para>Choose the title of the help volume or topic that
you want to display.</para>
</listitem><listitem><para>When you're done, click Close.</para>
</listitem></orderedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.23">
<title id="UG.GHelp.mkr.13">Searching for Specific Information<indexterm>
<primary>help</primary><secondary>index</secondary></indexterm><indexterm>
<primary>wildcards</primary><secondary>to search help index</secondary></indexterm></title>
<para>Like a book, a help volume has an index of important words and phrases
that you can use to find help topics on a subject. You can view or search
the index of the current volume, selected volumes, or all help volumes available
on your system.</para>
<figure>
<title id="UG.GHelp.mkr.14">Index Search dialog box</title>
<graphic id="UG.GHelp.grph.10" entityref="UG.GHelp.fig.11"></graphic>
</figure>
<para>Because the help index can be quite large even for a single volume,
index entries can be expanded or contracted. A + (plus) sign indicates that
the index entry relates to more than one help topic. The number shows the
count of help topics. You can click the index item to list the topics.</para>
<para>For instance, the result of an index search for the word &ldquo;display&rdquo;
is shown in <!--Original XRef content: 'Figure 3&hyphen;10'--><xref
role="CodeOrFigureOrTable" linkend="UG.GHelp.mkr.14">. The -36 prefix tells
you that there are 36 index entries that contain the keyword &ldquo;display.&rdquo;
Clicking any title marked by a + (plus) expands the list and the + (plus)
changes to a - (minus) sign. The last index entry shown in the figure has
been expanded in this way.</para>
<sect2 id="UG.GHelp.div.24" role="Procedure">
<title id="UG.GHelp.mkr.15">To Search for Topics Using the Help Index</title>
<note>
<para>The help index is available only in a general help window</para>
</note>
<orderedlist><listitem><para>To open the index, click the Index button.<indexterm>
<primary>help commands</primary><secondary>Index</secondary></indexterm></para>
<para>The index lists all of the entries for the current help volume. You
can choose <emphasis>All Volumes</emphasis> to view an index for all available
help volumes or choose <emphasis>Selected</emphasis> if you want to select
only certain volumes.</para>
</listitem><listitem><para>Select the Entries with field, type the word or
phrase you are looking for, and press Return.</para>
<para>Index searches are not case sensitive. Wildcards such as * (asterisk)
and ? (question mark) can be used (see <!--Original XRef content: '&xd2;Pattern
Searches'--><xref role="SectionTitle" linkend="UG.GHelp.mkr.16"> below).
</para>
</listitem><listitem><para>Select the index entry you want to view.</para>
<para>If the entry has a + (plus sign) prefix, the list will expand to show
additional choices. Then select a help topic to view.</para>
<para>You may view as many topics as you want.</para>
</listitem><listitem><para>Click Close when you are done.</para>
</listitem></orderedlist>
<sect3 id="UG.GHelp.div.25">
<title id="UG.GHelp.mkr.16">Pattern Searches</title>
<para>In a pattern search certain characters (known as &ldquo;wildcards&rdquo;)
have special meaning. You can combine these characters in a variety of ways.
</para>
<para>Two frequently used wildcards are asterisk (<filename>*</filename>)
and question mark (<filename>?</filename>). The <filename>*</filename> matches
any string of characters (including no characters), and <filename>?</filename>
matches any single character. Other wildcards include:</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="1.41in">
<colspec align="left" colwidth="4.61in">
<tbody>
<row>
<entry align="left" valign="top"><para>. (period)</para></entry>
<entry align="left" valign="top"><para>Matches any character</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>| (vertical bar)</para></entry>
<entry align="left" valign="top"><para>Specifies two search patterns and matches
either pattern (logical OR)</para></entry></row>
<row>
<entry align="left" valign="top"><para>() (parentheses)</para></entry>
<entry align="left" valign="top"><para>Encloses a pattern expression</para></entry>
</row></tbody></tgroup></informaltable>
<para>To search for a character that has special meaning in a regular expression,
precede the character with a \ (backslash).</para>
<sect4 id="UG.GHelp.div.26">
<title>Examples</title>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.15in">
<colspec align="left" colwidth="168*">
<colspec align="left" colwidth="339*">
<tbody>
<row>
<entry align="left" valign="top"><para>mouse.*clicking</para></entry>
<entry align="left" valign="top"><para>Matches entries that contain the word
&ldquo;mouse&rdquo; followed by any number of characters followed by &ldquo;clicking&rdquo;
</para></entry></row>
<row>
<entry align="left" valign="top"><para>mouse | click</para></entry>
<entry align="left" valign="top"><para>Matches entries that contain the word
&ldquo;mouse&rdquo; or &ldquo;click&rdquo;</para></entry></row>
<row>
<entry align="left" valign="top"><para>(session | style).*manager</para></entry>
<entry align="left" valign="top"><para>Matches entries that contain &ldquo;Session
Manager&rdquo; or &ldquo;Style Manager&rdquo;</para></entry></row></tbody>
</tgroup></informaltable>
</sect4>
</sect3>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.27">
<title id="UG.GHelp.mkr.17">Viewing Help on Your System<indexterm><primary>help</primary><secondary>viewing</secondary></indexterm></title>
<para>You can view all application help volumes registered on your system
without having to start each individual application&mdash;just start Help
Manager from the Front Panel.</para>
<para>At the top level, Help Manager groups help volumes into <emphasis>help
families</emphasis>. For example, the help family Common Desktop Environment
lists help volumes for the standard desktop applications. You can view
and display any of the volumes listed.</para>
<sect2 id="UG.GHelp.div.28" role="Procedure">
<title>To Open Help Manager<indexterm><primary>Help Manager</primary><secondary>opening</secondary></indexterm></title>
<orderedlist>
<listitem>
<para>Click Help Manager in the Information Manager subpanel
(see <!--Original XRef content: 'Figure 3&hyphen;2 on
page 44'--><xref role="CodeOrFigOrTabAndPNum" linkend="UG.GHelp.mkr.5">).
</para>
<para>A help window displays a list of help families with online help. This
is the top level of Help Manager.</para>
<figure>
<title>Top-level view in Help Manager</title>
<graphic id="UG.GHelp.grph.11" entityref="UG.GHelp.fig.12"></graphic>
</figure>
</listitem>
<listitem><para>Scroll the window to find the product group you
are interested in and click its title (underlined).</para>
<para>This lists the help volumes available for that product.</para>
</listitem><listitem><para>To open a particular help volume, click its title
(underlined text).</para>
</listitem><listitem><para>To return to the top level of Help Manager, click
the<indexterm><primary>help commands</primary><secondary>Top Level</secondary>
</indexterm> Top Level button.</para>
</listitem></orderedlist>
<sect3 id="UG.GHelp.div.29">
<title>Example</title>
<para>To view File Manager's online help:</para>
<orderedlist><listitem><para>Click Help Manager in the Information Manager subpanel.</para>
</listitem><listitem><para>Choose Common Desktop Environment.</para>
</listitem><listitem><para>Scroll the list of help volumes until you see File
Manager Help.</para>
</listitem><listitem><para>Click File Manager Help.</para>
<para>File Manager's help is displayed. This is the same help information
you would see if you opened File Manager and chose Overview from the Help
menu.</para>
</listitem></orderedlist>
<figure>
<title>File Manager help viewed in Help Manager</title>
<graphic id="UG.GHelp.grph.12" entityref="UG.GHelp.fig.13"></graphic>
</figure>
</sect3>
</sect2>
<sect2 id="UG.GHelp.div.30" role="Procedure">
<title>To Duplicate a Help Window<indexterm><primary>help commands</primary>
<secondary>New Window</secondary></indexterm><indexterm><primary>help windows</primary><secondary>duplicating</secondary></indexterm></title>
<orderedlist><listitem><para>Choose New Window from the Help Manager File
menu.</para>
<para>The current help window is duplicated. You can size the new window and
select topics independently of the original window.</para>
</listitem><listitem><para>To remove the window, choose Close from the File
menu.</para>
</listitem></orderedlist>
<note>
<para>The New Window command is only available in the Help Manager help window
(see <!--Original XRef content: ''--><xref role="CodeOrFigureOrTable" linkend="UG.GHelp.mkr.4"> <!--Original
XRef content: '&xd2;Viewing Help on Your System&xd3; on page 53'--><xref
role="SecTitleAndPageNum" linkend="UG.GHelp.mkr.17">).</para>
</note>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.31">
<title id="UG.GHelp.mkr.18">Displaying a Man Page<indexterm><primary>man
pages, displaying</primary></indexterm></title>
<para>Manual reference pages, traditionally known as &ldquo;man pages,&rdquo;
can be displayed using the Man Page Viewer action. The action icon is located
in the Desktop_Apps folder in Application Manager.</para>
<figure>
<title>Man Page action icon</title>
<graphic id="UG.GHelp.grph.13" entityref="UG.GHelp.fig.14"></graphic>
</figure>
<sect2 id="UG.GHelp.div.32" role="Procedure">
<title id="UG.GHelp.mkr.19">To Display a Man Page<indexterm><primary>displaying</primary><secondary>man pages</secondary></indexterm><indexterm><primary>man pages, displaying</primary></indexterm></title>
<orderedlist>
<listitem>
<para>Click the Application Manager control in the
Front Panel.
</para>
<graphic id="UG.GHelp.igrph.2" entityref="UG.GHelp.fig.15"></graphic>
</listitem>
<listitem>
<para>Double-click the Desktop_Apps icon.</para>
</listitem>
<listitem>
<para>Click the Man Page Viewer icon.</para>
<para>A dialog box is displayed, prompting you to enter a man page name.
<graphic id="UG.GHelp.igrph.3" entityref="UG.GHelp.fig.16"></graphic>
</para>
</listitem>
<listitem><para>Type the name of the man page you want to see
and press Return.</para>
<para>The man page is displayed in a quick help window.</para>
</listitem><listitem><para>Click Close to dismiss the man page.</para>
</listitem></orderedlist>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.33">
<title id="UG.GHelp.mkr.20">Printing Help Topics<indexterm><primary>printing</primary><secondary>help topics</secondary></indexterm><indexterm><primary>help</primary><secondary>printing help topics</secondary></indexterm></title>
<para>Sometimes you may want to have a printed version of a help topic for
a particular application. You can print an individual help topic, a table
of contents and index, or the entire help volume. Printing options, such
as paper size, number of copies, and destination printer, can also be set
in the Print dialog box.</para>
<para>Printed help topics are directed to your default printer unless you
provide a different printer name in the dialog box. Printed output is text
only.</para>
<sect2 id="UG.GHelp.div.34" role="Procedure">
<title id="UG.GHelp.mkr.21">To Print a Help Topic<indexterm><primary>help
commands</primary><secondary>Print</secondary></indexterm></title>
<orderedlist><listitem><para>Choose Print from the File menu. (In a quick
help window, click the Print button.)</para>
<para>You can use the default values in the Print dialog box and skip to step
5 or enter new values for your print job.
<graphic id="UG.GHelp.igrph.4" entityref="UG.GHelp.fig.17"></graphic>
</para>
</listitem>
<listitem><para>Optional. Type the name of the printer that you
want to use.</para>
</listitem><listitem><para><emphasis>Optional</emphasis>. Type the number
of copies to print.</para>
</listitem><listitem><para><emphasis>Optional.</emphasis> Click the paper
size button to choose a paper size.</para>
</listitem><listitem><para>Select the topic or topics you want to print.</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.07in">
<colspec align="left" colwidth="202*">
<colspec align="left" colwidth="298*">
<tbody>
<row>
<entry align="left" valign="top"><para>Current Topic (the default)</para></entry>
<entry align="left" valign="top"><para>Prints only the current topic</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>Current and Subtopics</para></entry>
<entry align="left" valign="top"><para>Prints the current topic and its subtopics
</para></entry></row>
<row>
<entry align="left" valign="top"><para>Table of Contents and Index</para></entry>
<entry align="left" valign="top"><para>Prints the help volume table of contents
and index</para></entry></row>
<row>
<entry align="left" valign="top"><para>Entire Volume</para></entry>
<entry align="left" valign="top"><para>Prints the contents of the help volume
including the table of contents and index</para></entry></row></tbody></tgroup>
</informaltable>
</listitem><listitem><para>Click Print.</para>
</listitem></orderedlist>
</sect2>
<sect2 id="UG.GHelp.div.35">
<title>Printing Configuration</title>
<para>The Print dialog box displays the name of your default printer. You
can change the default printer name by modifying the LPDEST environment variable.
You can also change the printer for a specific application by modifying the
application's application defaults file.</para>
<sect3 id="UG.GHelp.div.36" role="Procedure">
<title>To Set the Printer Resource for an Application</title>
<orderedlist><listitem><para>Edit your <emphasis>HomeDirectory</emphasis>/ <computeroutput>.Xdefaults</computeroutput> file by adding this resource:</para>
<programlisting><symbol role="Variable">application_name</symbol>*printer: <symbol role="Variable">name</symbol></programlisting>
<para>If you do not have an <computeroutput>.Xdefaults</computeroutput> file,
create the file in your home directory.</para>
</listitem></orderedlist>
<sect4 id="UG.GHelp.div.37">
<title>Example</title>
<para>You want to direct all printed help topics of an application named ImageScan
to a printer named <computeroutput>laser2</computeroutput> rather than to
your default printer.</para>
<para>Add this resource to your <computeroutput>.Xdefaults</computeroutput>
file:</para>
<programlisting>ImageScan*printer: laser2
</programlisting>
</sect4>
</sect3>
</sect2>
</sect1>
<sect1 id="UG.GHelp.div.38">
<title>Modifying Help Window Colors<?X-setsize 12.0 pt><indexterm><primary>help</primary><secondary>window colors</secondary></indexterm><indexterm>
<primary>color</primary><secondary>in help windows</secondary></indexterm><indexterm>
<primary>help windows</primary><secondary>color in</secondary></indexterm></title>
<para>You can change the colors of the topic tree or topic display area of
a help window by setting application resources. Choosing constrasting colors
is important. This ensures that text (foreground color) will be visible against
the background color.</para>
<sect2 id="UG.GHelp.div.39" role="Procedure">
<title id="UG.GHelp.mkr.22">To Change Help Window Colors for an Application</title>
<orderedlist><listitem><para>Edit your <emphasis>HomeDirectory</emphasis>/ <computeroutput>.Xdefaults</computeroutput> file by adding these resources:</para>
<programlisting><symbol role="Variable">application_name</symbol><filename>*DtHelpDialog*DisplayArea.foreground:</filename>   <symbol role="Variable">color</symbol>

<symbol role="Variable">application_name</symbol><filename>*DtHelpDialog*DisplayArea.background:</filename>   <symbol role="Variable">color</symbol>

<symbol role="Variable">application_name</symbol><filename>*DtHelpDialog*TocArea.foreground:</filename>   <symbol role="Variable">color</symbol>

<symbol role="Variable">application_name</symbol><filename>*DtHelpDialog*TocArea.background:</filename>   <symbol role="Variable">color</symbol>

<symbol role="Variable">application_name</symbol><filename>*DtHelpQuickDialog*DisplayArea.foreground:</filename>   <symbol role="Variable">color</symbol>

<symbol role="Variable">application_name</symbol><filename>*DtHelpQuickDialog*DisplayArea.background:</filename>   <symbol role="Variable">color</symbol></programlisting>
<para>Substitute the name of the application whose help windows you want to
change for <emphasis>application_name</emphasis>.</para>
<para>You can ask your system administrator for a list of colors that you
can use or refer to your system documentation.</para>
</listitem>
<listitem><para>Save and close the file.</para>
<para>When you restart your application, it will use the new color values
for the topic tree and topic display area in its help windows.</para>
</listitem></orderedlist>
<sect3 id="UG.GHelp.div.40">
<title>Example</title>
<para>These resource entries change the foreground and background colors of
the topic tree (TocArea) and topic display area (DisplayArea) for an application
named DtCardCatalog.</para>
<programlisting>DtCardCatalog*DtHelpDialog*TocArea.foreground:  yellow

DtCardCatalog*DtHelpDialog*TocArea.background:  blue

DtCardCatalog*DtHelpDialog*DisplayArea.foreground:  yellow

DtCardCatalog*DtHelpDialog*DisplayArea.background:  blue

DtCardCatalog*DtHelpQuickDialog*DisplayArea.foreground:  yellow

DtCardCatalog*DtHelpQuickDialog*DisplayArea.background:  blue
</programlisting>
<para>Quick help windows do not have a topic tree, so the <computeroutput>TocArea</computeroutput> resource is omitted.</para>
<para id="UG.GHelp.mkr.23"></para>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 10:57:19-->
<?Pub *0000054042>
