Files
cdesktop/cde/doc/C/guides/man/man4/ifshwial.sgm

109 lines
3.5 KiB
Plaintext

<!-- $XConsortium: ifshwial.sgm /main/9 1996/09/20 11:13:43 cdedoc $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEM.INFO.DtInfoShowInfoAtLoc">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.INFO.DtInfoShowInfoAtLoc">]]>
<RefMeta>
<RefEntryTitle>DtInfo_ShowInfoAtLoc</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">DtInfo_ShowInfoAtLoc</Symbol></RefName>
<RefPurpose>display a specified section or topic
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>DtInfo_ShowInfoAtLoc
Class: TT_REQUEST
File: <Symbol Role="Variable">filename</Symbol>
Operation: DtInfo_LoadInfoLib
Address: TT_PROCEDURE
Handler_ptype: DtInfo
Disposition: TT_START
Scope: TT_SESSION
Status: 0 = OK, 1 = FAIL
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">DtInfo_ShowInfoAtLoc</Symbol> request
is a process-oriented ToolTalk message that causes
<command>dtinfo</command> to display a particular section
of data or topic. ToolTalk starts the browser if it is
not already running. This corresponds to invoking
<command>dtinfo</command> with the <literal>-sect</literal>
option from the command line.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<variablelist>
<varlistentry><term>ARG0 <symbol role="Variable">action</symbol></term>
<listitem>
<para>Name of the action to invoke to start <command>dtinfo</command>
on a remote host, if necessary.
Mode is <systemitem class="constant">TT_IN</systemitem>;
type is string.
</para>
</listitem>
</varlistentry>
<varlistentry><term>ARG1 <symbol role="Variable">exec_host</symbol></term>
<listitem>
<para>Name of the host from which the specified infolib is accessible.
Mode is <systemitem class="constant">TT_IN</systemitem>;
type is string.
</para>
</listitem>
</varlistentry>
<varlistentry><term>ARG2 <symbol role="Variable">locale</symbol></term>
<listitem>
<para>Required locale.
Mode is <systemitem class="constant">TT_IN</systemitem>;
type is string.
</para>
</listitem>
</varlistentry>
<varlistentry><term>ARG3 <symbol role="Variable">section</symbol></term>
<listitem>
<para>Specifies the infolib section, in generalized locator format.
A generalized locator format provides applications with a mechamism for
addressing infolibs as document collections with external
navigation references. This mechanism is more precise than those which
operate on an infolib at the file level, and is required by applications
that want to tightly integrate to their online documentation.
For more information, see "Generalized Locator Format" in
&cdeman.dtinfo;.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>ATTRIBUTES</Title>
<variablelist>
<varlistentry><term>File <symbol role="Variable">filename</symbol></term>
<listitem>
<para>Specifies a file path, relative or absolute, to an information library.
If the filename is not specified, the browser displays the default
information library(s).
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>
<filename>Generalized Locator Format</filename> 4,
&cdeman.DtInfo.LoadInfoLib;,
<Function>DtInfo_Quit</Function> 4
</Para>
</RefSect1>
</RefEntry>