CDE/cde/doc/C/guides/man/man4/ifloadil.sgm

<!-- $XConsortium: ifloadil.sgm /main/8 1996/08/30 15:15:52 rws $ -->
<!-- (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="CDE.INFO.DtInfoLoadInfoLib">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.INFO.DtInfoLoadInfoLib">]]>
<RefMeta>
<RefEntryTitle>DtInfo_LoadInfoLib</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">DtInfo_LoadInfoLib</Symbol></RefName>
<RefPurpose>load the specified infolib
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>DtInfo_LoadInfoLib
        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_LoadInfoLib</Symbol> request
will cause <command>dtinfo</command>
to load the specified infolib or the default infolib, if none is specified.
The browser is started if
it is not already running. This request
corresponds to invoking <command>dtinfo</command>
with the <literal>-l</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>
</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>ENVIRONMENT VARIABLES</Title>
<variablelist>
<varlistentry><term><systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem></term>
<listitem>
<para>Specifies the search path for locating information libraries on
local and remote mounted systems.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">DTINFOLIBDEFAULT</systemitem></term>
<listitem>
<para>Specifies the name of the default information library(s) to load when
the File attribute is omitted. Multiple information libraries can be
specified by a comma separated list.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtInfo.Quit;,
<Function>DtInfo_ShowInfoAtLoc</Function> 4
</Para>
</RefSect1>
</RefEntry>