<!-- $XConsortium: dtenvvar.sgm /main/12 1996/09/30 11:29:12 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. -->
<RefEntry Id="CDEMX.MAN101.rsml.1">
<RefMeta>
<RefEntryTitle>dtenvvar</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtenvvar</Literal></RefName>
<RefPurpose>CDE environment variables
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CDE desktop sets up and uses a number of environment variables to
find certain files and do certain things. Components tied into CDE then
use these environment variables to locate specific types of files.
Environment variables used within the CDE desktop are:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>CEPATH</Emphasis></Term>
<ListItem>
<Para>Used by ToolTalk when in Classing Engine mode, where the Classing
Engine where to find the databases.
Refer to
&cdeman.ttsession; and
&cdeman.tt.type.comp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">COLUMNS</SystemItem></Term>
<ListItem>
<Para>Set by the terminal emulator.
Refer to
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DISPLAY</SystemItem></Term>
<ListItem>
<Para>Is set to the associated display name.
Refer to
&cdeman.dtlogin; and
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Used to search for Application Manager applications.
Refer
to
&cdeman.dtappgather; and
&cdeman.dtsearchpath; for more
information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Used to collect filetype and action definitions, as expressed in
<Literal>*.dt</Literal> files.
Refer to
&cdeman.dtsearchpath;, &cdeman.dtaction;, &cdeman.dtactionfile;, and
&cdeman.dtdtsfile; for
more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTHELPSEARCHPATH</Emphasis></Term>
<ListItem>
<Para>System specified variable used to locate desktop help files.
Refer to
&cdeman.dtsearchpath; and
&cdeman.dthelpgen; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTHELPUSERSEARCHPATH</Emphasis></Term>
<ListItem>
<Para>User specified variable used to locate desktop help files.
Refer to
&cdeman.dtsearchpath; and
&cdeman.dthelpgen; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTINFOLIBSEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Used by <command>dtinfo</command> to locate information libraries on
local and remote mounted systems. Refer to
&cdeman.dtsearchpath; and &cdeman.dtdocbook2infolib; for
more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTINFOLIBDEFAULT</SystemItem></Term>
<ListItem>
<Para>Used by <command>dtinfo</command> to identify the default
information library(s) to load if the <literal>-l</literal> or
<literal>-sect</literal> option is not specified. Multiple information
libraries can be specified by a comma separated list. By default,
<systemitem class="environvar">DTINFOLIBDEFAULT</systemitem>
is initialized to the CDE infolib cde.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTMOUNTPOINT</Emphasis></Term>
<ListItem>
<Para>Used to set the name of the file system's mount point, such as '/nfs'
or '/net'.
Refer to &cdeman.dtspcd; and &cdeman.dtsearchpath; for more
information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTCWD</Emphasis></Term>
<ListItem>
<Para>If set to an existing, usable directory, this setting
causes
&cdeman.dtlp; to execute the
<Literal>lp</Literal> command pipeline from that
directory.
By default, this setting uses the current directory
from which
&cdeman.dtlp; is invoked.
Refer to
&cdeman.dtlp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTFILEREMOVE</Emphasis></Term>
<ListItem>
<Para>Remove the file after printing it.
This functionality is intended for temporary files generated by
components such as the Text Editor and Help system files that
don't need to persist beyond the act of printing.
Value must be <SystemItem Class="Constant">True</SystemItem>
or <SystemItem Class="Constant">False</SystemItem> (case is ignored).
Default is <SystemItem Class="Constant">False</SystemItem>.
Refer to
&cdeman.dtlp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTSILENT</Emphasis></Term>
<ListItem>
<Para>Print the file silently, without posting the PRINT dialog.
Value must be <SystemItem Class="Constant">True</SystemItem>
or <SystemItem Class="Constant">False</SystemItem> (case is ignored).
Default is <SystemItem Class="Constant">False</SystemItem>.
Refer to
&cdeman.dtlp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTUSERFILENAME</Emphasis></Term>
<ListItem>
<Para>Use this value as the name of file as it should appear in the
PRINT dialog.
Default is print_file.
Refer to
&cdeman.dtlp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSCREENSAVERLIST</Emphasis></Term>
<ListItem>
<Para>Used to set the default desktop screen saver
action list.
Used by
&cdeman.dtstyle; to determine the list
of available screen savers.
Refer to
&cdeman.dtstyle; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPSYSAPPHOSTS</Emphasis></Term>
<ListItem>
<Para>Used by system administrators as an input to
&cdeman.dtsearchpath; to
create the
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> environment variable.
It is the primary
environment variable and drives the remaining search paths for
filetypes and actions, for desktop icons, and for help files.
Refer
to
&cdeman.dtappgather; and
&cdeman.dtsearchpath; for more
information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPSYSDATABASEHOSTS</Emphasis></Term>
<ListItem>
<Para>Used by system administrators as an input to <Command>dtsearchpath</Command> to
create the
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> environment variable.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPSYSHELP</Emphasis></Term>
<ListItem>
<Para>Used by system administrators as an input to <Command>dtsearchpath</Command> to
create the
<Emphasis>DTHELPSEARCHPATH</Emphasis> environment variable.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPSYSICON</Emphasis></Term>
<ListItem>
<Para>Used by system administrators as an input to <Command>dtsearchpath</Command> to
create the
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem> and
<Emphasis>XMICONBMSEARCHPATH</Emphasis> environment varables.
Refer to
&cdeman.dtsearchpath; for
more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPUSERAPPHOSTS</Emphasis></Term>
<ListItem>
<Para>Used by end users as an input to
<Command>dtsearchpath</Command> to create the
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> environment variable.
Refer to
&cdeman.dtappgather; and
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPUSERDATABASEHOSTS</Emphasis></Term>
<ListItem>
<Para>Used by end users as an input to <Command>dtsearchpath</Command> to
create the
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> environment variable.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPUSERHELP</Emphasis></Term>
<ListItem>
<Para>Used by end users as an input to
&cdeman.dtsearchpath; to
create the
<Emphasis>DTHELPSEARCHPATH</Emphasis> environment variable.
Refer to
<Command>dtsearchpath</Command> for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTSPUSERICON</Emphasis></Term>
<ListItem>
<Para>Used by end users as an input to
&cdeman.dtsearchpath; to create the
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem> and
<Emphasis>XMICONBMSEARCHPATH</Emphasis> environment variables.
Refer
to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="environvar">DTSROCFPATH</systemitem></Term>
<ListItem>
<Para>Used by the <function>DtSearchInit</function> function to locate the
default API configuration <filename>ocf</filename> file. If the
<symbol role="Variable">ocf_file</symbol> argument is NULL,
<function>DtSearchInit</function> looks for an <filename>ocf</filename>
file with a base name of either <filename>dtsearch.ocf</filename> or
<filename>austext.ocf</filename> in the directory specified by
<systemitem class="environvar">DTSROCFPATH</systemitem>, in the current
working directory, or in the <systemitem class="environvar">HOME</systemitem> directory, in that order.
</para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTTAGOPT</SystemItem></Term>
<ListItem>
<Para>Used by
&cdeman.dthelptag;. Refer
to
&cdeman.dthelptag; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem></Term>
<ListItem>
<Para>Used to control the location of the end user's subdirectory where the
Application Manager will be rooted.
Also used by the Help system to
store data on a per user-session-display basis.
Refer to
&cdeman.dtappgather; or
&cdeman.dthelpview; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>EDITOR</Emphasis></Term>
<ListItem>
<Para>Is set to
<Filename>/usr/dt/bin/dtpad</Filename> Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">HOME</SystemItem></Term>
<ListItem>
<Para>Is set to the home directory of the user.
Refer to
&cdeman.dtlogin; and
&cdeman.dtmail; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>KBD_LANG</Emphasis></Term>
<ListItem>
<Para>Is set to the value of
<SystemItem Class="EnvironVar">LANG</SystemItem> for applicable languages.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LANG</SystemItem></Term>
<ListItem>
<Para>Is set to the current NLS language (if any).
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_ALL</Emphasis></Term>
<ListItem>
<Para>Is set to the current NLS language (if any).
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_MESSAGES</Emphasis></Term>
<ListItem>
<Para>Is set to the current NLS language (if any).
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LINES</SystemItem></Term>
<ListItem>
<Para>Set by the terminal emulator.
Refer to
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LOGNAME</SystemItem></Term>
<ListItem>
<Para>Is set to the user name.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LPDEST</SystemItem></Term>
<ListItem>
<Para>Set the printer destination for the file.
Refer to
&cdeman.dtlp; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>MAIL</Emphasis></Term>
<ListItem>
<Para>Is set to
<Filename>/var/mail/$USER</Filename> (system dependent).
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">MAILRC</SystemItem></Term>
<ListItem>
<Para>Used by
&cdeman.dtmail; as the mailer's startup file.
Refer to
&cdeman.dtmail; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>MANPATH</Emphasis></Term>
<ListItem>
<Para>The
&cdeman.dtsearchpath; utility appends <Filename>/usr/dt/man</Filename> to it.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">NLSPATH</SystemItem></Term>
<ListItem>
<Para>Determine the location of message catalogues for the processing of
<Emphasis>LC_MESSAGES</Emphasis>. Refer to
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">PATH</SystemItem></Term>
<ListItem>
<Para>Is set to the value of the
<Literal>userPath</Literal> resource.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">SHELL</SystemItem></Term>
<ListItem>
<Para>Is set to the user's default shell (from
<Filename>/etc/passwd</Filename>). Refer to
&cdeman.dtlogin; and
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TERM</Emphasis></Term>
<ListItem>
<Para>Is set to
<Command>dtterm</Command> the default CDE terminal emulator.
Refer to
&cdeman.dtterm; and
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TERMINAL_EMULATOR</Emphasis></Term>
<ListItem>
<Para>Set by the terminal emulator.
Refer to
&cdeman.dtterm;) for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TTPATH</Emphasis></Term>
<ListItem>
<Para>Used by ToolTalk.
It tells ToolTalk where to find the ToolTalk
types database when in XDR mode.
Refer to
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TTSESSION_CMD</Emphasis></Term>
<ListItem>
<Para>This specifies the shell command to be used by all ToolTalk clients
for auto-starting
<Command>ttsession</Command>. Refer to &cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TT_ARG_TRACE_WIDTH</Emphasis></Term>
<ListItem>
<Para>Used by ToolTalk.
It specifies the number of bytes of argument
and context values to write when in trace mode.
Refer to
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">TT_FILE</SystemItem></Term>
<ListItem>
<Para>Set by
<Command>ttsession</Command> when it invokes a tool to receive a message.
Refer to
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">TT_SESSION</SystemItem></Term>
<ListItem>
<Para>The
<Command>ttsession</Command> utility uses this varible to communicate its session ID
to the tools that it starts.
Refer to
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_TOKEN</Term>
<ListItem>
<Para>Used to inform the ToolTalk client library that it has been invoked
by <Command>ttsession</Command>.
Refer to
&cdeman.ttsession; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>TT_TRACE_SCRIPT</Emphasis></Term>
<ListItem>
<Para>If set, tells libtt to turn on client-side tracing as specified in the
trace script
Refer to
&cdeman.tttrace; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">TZ</SystemItem></Term>
<ListItem>
<Para>Is set to the value of the
<Literal>timeZone</Literal> resource or system default.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">USER</SystemItem></Term>
<ListItem>
<Para>Is set to the user name.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>WINDOWID</Emphasis></Term>
<ListItem>
<Para>Set by the terminal emulator.
Refer to
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">XAPPLRESDIR</SystemItem></Term>
<ListItem>
<Para>Specifies the name of a directory that contains application
specific resources.
Refer to
&cdeman.dtterm; and
&cdeman.dtwm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>XAUTHORITY</Emphasis></Term>
<ListItem>
<Para>May be set to an authority file.
Refer to
&cdeman.dtlogin; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">XENVIRONMENT</SystemItem></Term>
<ListItem>
<Para>Specifies the name of a resource file with user- or machine
specific resources.
Refer to
&cdeman.dtterm; and
&cdeman.dtwm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">XFILESEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Defines a language-dependent location of app-defaults.
Refer to
&cdeman.dtterm; and
&cdeman.dtwm; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Used to locate desktop icons.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>XMICONBMSEARCHPATH</Emphasis></Term>
<ListItem>
<Para>Used to locate bitmap (2 color) desktop icons.
Refer to
&cdeman.dtsearchpath; for more information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>XMODIFIER</Emphasis></Term>
<ListItem>
<Para>Specifies which input method to use.
Refer to
&cdeman.dtterm; for more information.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, &cdeman.dtactionfile;, &cdeman.dtappgather;, &cdeman.dtappintegrate;, &cdeman.dtcm;, &cdeman.dthelpgen;, &cdeman.dthelptag;, &cdeman.dthelpview;, &cdeman.dtlogin;, &cdeman.dtlp;, &cdeman.dtsearchpath;, &cdeman.dtspcd;, &cdeman.dtstyle;, &cdeman.dtterm;, &cdeman.dtdtsfile;, &cdeman.dtwm;, &cdeman.tt.type.comp;, &cdeman.ttsession;, &cdeman.tttrace;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
