debian/cdesktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial import of the CDE 2.1.30 sources from the Open Group.

Browse Source
This commit is contained in:
Peter Howkins
2012-03-10 18:21:40 +00:00
commit 83b6996daa
18978 changed files with 3945623 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
cde/doc/C/guides/man/man4/Deposit.sgm Normal file
View File

@@ -0,0 +1,129 @@
<!-- $XConsortium: Deposit.sgm /main/5 1996/08/30 14:45:29 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN282.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN282.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Deposit</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Deposit</Symbol></RefName>
<RefPurpose>save a document to its backing store
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Deposit.sgm /main/5 1996/08/30 14:45:29 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Deposit(in <Emphasis>mediaType contents</Emphasis>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Deposit</Symbol> request saves a document to its backing store.
This request is different from the
<Symbol Role="Message">Save</Symbol> request in that the requester (not the handler) has the data to be saved.
</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>commission</Emphasis> argument contains the message ID of the
<Symbol Role="Message">Edit</Symbol> request that caused the creation of this buffer.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.load; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.Deposit; function.
</Para>
<Para>The
<Symbol Role="Message">Deposit</Symbol> request is useful for cases where the user may perform
an intermediate save of modifications to a document that is the subject of an
<Symbol Role="Message">Edit</Symbol> or
<Symbol Role="Message">Display</Symbol> request in progress.
In the latter case, the
<Symbol Role="Message">Deposit</Symbol> may fail on a
<SystemItem Class="Constant">TT_DESKTOP_EACCES</SystemItem> error if the handler does not allow updates to the document being displayed.
</Para>
<Para>Handlers receiving this request should reply before deleting
any file named in the message's
<Symbol Role="Variable">file</Symbol> attribute,
but this is optional
and applications should not rely on this.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Deposit</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_EACCES</Term>
<ListItem>
<Para>The document is read-only.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.load;, &cdeman.ttmedia.Deposit;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Display</Symbol>, <Symbol Role="Message">Edit</Symbol>, <Symbol Role="Message">Status</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

155
cde/doc/C/guides/man/man4/Display.sgm Normal file
View File

@@ -0,0 +1,155 @@
<!-- $XConsortium: Display.sgm /main/7 1996/09/08 20:13:45 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN283.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN283.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Display</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Display</Symbol></RefName>
<RefPurpose>display a document
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Display.sgm /main/7 1996/09/08 20:13:45 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Display(in <Emphasis>mediaType contents</Emphasis>
[in title <Emphasis>docName</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Display</Symbol> request causes the handler to display (present or manifest)
a document to the user.
For example, an audio manipulation utility would be said to
``display'' audio documents when it plays them.
</Para>
<Para>The handler must decide issues such as:
</Para>
<ItemizedList>
<ListItem>
<Para>When the display operation can be deemed completed
</Para>
</ListItem>
<ListItem>
<Para>What user gesture signals the completion of the display
</Para>
</ListItem>
<ListItem>
<Para>What the handling tool should do with itself after replying
</Para>
</ListItem>
</ItemizedList>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>docName</Emphasis> argument contains the name of the document.
If the
<Emphasis>docName</Emphasis> argument is absent and the
<Symbol Role="Variable">file</Symbol> attribute is set,
the file name is considered to be the title of the document.
This string would be suitable for display in a window title bar, for example.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
<Para>When the document to be displayed
is read-only or unlikely to be modified
the
<Symbol Role="Message">Display</Symbol> message is frequently used instead of the
<Symbol Role="Message">Edit</Symbol> message.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>To display a PostScript document, the application can send a
<Symbol Role="Message">Display</Symbol> request with a first argument whose vtype is
<Literal>PostScript</Literal>, and whose value is a vector of bytes such as:
</Para>
<InformalExample Remap="indent">
<ProgramListing>%!&bsol;n/inch {72 mul} def...
</ProgramListing>
</InformalExample>
<Para>The
<Literal>&bsol;n</Literal> in the example represents the newline character.
The notation is the same as in the &str-Z3;.
</Para>
<Para>To display a PostScript document contained in a file,
the application can send a
<Symbol Role="Message">Display</Symbol> request with the
<Symbol Role="Variable">file</Symbol> attribute set to that file
and with an unset first argument whose vtype is
<Literal>PostScript</Literal>.</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Display</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Deposit</Symbol>, <Symbol Role="Message">Edit</Symbol>, <Symbol Role="Message">Status</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

245
cde/doc/C/guides/man/man4/DtDndPro.sgm Normal file
View File

@@ -0,0 +1,245 @@
<!-- $XConsortium: DtDndPro.sgm /main/10 1996/08/31 14:54:19 rws $ -->
<!-- (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.MAN89.rsml.1">
<refmeta><refentrytitle>DtDndProtocol</refentrytitle><manvolnum>special file
</manvolnum></refmeta>
<refnamediv><refname><structname role="typedef">DtDndProtocol</structname></refname>
<refpurpose>drag and drop matching and transfer protocols</refpurpose></refnamediv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<refsect1>
<title>DESCRIPTION</title>
<para>The drag and drop protocols provide policy for matching and data transfer
between the drag initiator and the drop receiver of file names, selected text
spans and application-defined structured data formats.</para>
<para>The drag and drop protocols use the standard X11 selection targets,
where available, with the addition of several new selection targets where
required.</para>
<para>These protocols provide for the transfer of the following types of data:
</para>
<itemizedlist>
<!-- merged from xo+cde-->
<listitem><para>Selected Text</para>
</listitem><listitem><para>File Names</para>
</listitem><listitem><para>Buffers</para>
</listitem></itemizedlist>
</refsect1>
<refsect1>
<title>PROTOCOL OVERVIEW</title>
<para>Each protocol consists of the following:</para>
<refsect2>
<title>Drag and Drop API Protocol</title>
<para>Each protocol described corresponds to a specific <structname role="typedef">DtDndProtocol</structname> enumeration value.</para>
</refsect2>
<refsect2>
<title>Export/Import Targets</title>
<para>The Motif drag and drop API provides support for matching of the data
transfer protocol between the drag initiator and the various drop receivers.
This allows the user to determine readily which drop sites will accept the
dragged data.</para>
<para>The drag initiator sets the <systemitem class="Resource">XmNexportTargets</systemitem> resource of the <classname>XmDragContext</classname> to the
list of target atoms that describe the data being dragged. The drop receiver
sets the <systemitem class="Resource">XmNimportTargets</systemitem> resource
of the <Symbol>XmDropSite</Symbol> to the list of target atoms that describe
the data that it will accept. The Motif drag and drop subsystem allows drops
when the <systemitem class="Resource">XmNexportTargets</systemitem> and <systemitem class="Resource">XmNimportTargets</systemitem> have at least one target in
common.</para>
</refsect2>
<refsect2>
<title>Data Transfer Protocol</title>
<para>Once the drag initiator has dropped on the drop receiver, the transfer
of data is begun. The transfer is accomplished using X selections and is controlled
by the drop receiver.</para>
<para>The drop receiver starts all transfers by converting the selection into
the ICCCM <systemitem class="Constant">TARGETS</systemitem> target to get
the set of available selection targets. (See the &str-Zi; for a description
of converting targets.) It then chooses the appropriate selections from that
set and requests that the drag initiator convert each requested selection.
Each protocol has a set of selection targets that are used to transfer all
the necessary data. These target conversions are usually initiated by calling <function>XmDropTransferStart</function>.</para>
</refsect2>
<refsect2>
<title>Move Completion</title>
<para>When the operation of the drop is <systemitem class="Constant">XmDROP_MOVE</systemitem>, the drop receiver must complete the move using an appropriate
method. For most data transfers, this is accomplished by converting the selection
into the ICCCM <systemitem class="Constant">DELETE</systemitem> target to
tell the drag initiator that it may delete the data. For most file name transfers,
this is accomplished via the file system.</para>
</refsect2>
</refsect1>
<refsect1>
<title>TEXT TRANSFER PROTOCOL</title>
<para>The text transfer protocol is used to exchange text selections.</para>
<refsect2>
<title>Drag and Drop API</title>
<para>This is the protocol used when a <structname role="typedef">DtDndProtocol</structname> of <systemitem class="Constant">DtDND_TEXT_TRANSFER</systemitem>
is specified.</para>
</refsect2>
<refsect2>
<title>Export/Import Targets</title>
<para>The export or import targets are any of the following; the target describing
the character encoding of the text selection, <systemitem class="Constant">COMPOUND_TEXT</systemitem>, <systemitem class="Constant">STRING</systemitem>
or <systemitem class="Constant">TEXT</systemitem>.</para>
</refsect2>
<refsect2>
<title>Data Transfer Protocol</title>
<para>The transfer of text selections follows the protocols described in the
ICCCM manual. If the character encoding of the drag initiator and drop receiver
are the same, that target should be converted to get the text selection. If
the character encoding are different, the drop receiver should attempt to
convert the standard text targets in the following order: <systemitem class="Constant">COMPOUND_TEXT</systemitem>, <systemitem class="Constant">STRING</systemitem>
or <systemitem class="Constant">TEXT</systemitem>.</para>
</refsect2>
<refsect2>
<title>Move Completion</title>
<para>The move is completed by converting the selection into the ICCCM <systemitem class="Constant">DELETE</systemitem> target.</para>
</refsect2>
</refsect1>
<refsect1>
<title>FILE NAME TRANSFER PROTOCOL</title>
<para>The transfer protocol is used to exchange file names.</para>
<refsect2>
<title>Drag and Drop API</title>
<para>This is the protocol used when a <structname role="typedef">DtDndProtocol</structname> of <systemitem class="Constant">DtDND_FILENAME_TRANSFER</systemitem>
is specified.</para>
</refsect2>
<refsect2>
<title>Export/Import Targets</title>
<para>The export or import targets are <systemitem class="Constant">FILE_NAME</systemitem> and, optionally, <systemitem class="Constant">_DT_NETFILE</systemitem>
if capable of providing the file name in network canonical form using &cdeman.tt.file.netfile; and &cdeman.tt.netfile.file;.</para>
</refsect2>
<refsect2>
<title>Data Transfer Protocol</title>
<para>If the ICCCM <systemitem class="Constant">HOST_NAME</systemitem> target
is in the list of target atoms, it is converted. If the returned host name
is different than the host name for the drop receiver and the <systemitem class="Constant">_DT_NETFILE</systemitem> target is in the list of target
atoms, it is converted. The drag initiator uses &cdeman.tt.file.netfile; to encode the file names and the drop receiver uses &cdeman.tt.netfile.file; to decode the file names.</para>
<para>If the hosts are the same for both the drag initiator and the drop receiver
or either the <systemitem class="Constant">HOST_NAME</systemitem> or the <systemitem class="Constant">_DT_NETFILE</systemitem> targets are not in the list of target
atoms from the drag initiator, the drop receiver converts the ICCCM <systemitem class="Constant">FILE_NAME</systemitem> target. No encoding of the file names
occurs in this case.</para>
</refsect2>
<refsect2>
<title>Move Completion</title>
<para>Moves of file names can be accomplished atomically using standard file
system operations. Drop receivers are encouraged to use the file system. The
drop receiver may alternatively choose to use the ICCCM <systemitem class="Constant">DELETE</systemitem> target to complete the <systemitem class="Constant">XmDROP_MOVE</systemitem> and the drag initiator must be ready to comply.</para>
</refsect2>
</refsect1>
<refsect1>
<title>BUFFER TRANSFER PROTOCOL</title>
<para>The transfer protocol is used to exchange memory buffers.</para>
<refsect2>
<title>Drag and Drop API</title>
<para>This is the protocol used when a <structname role="typedef">DtDndProtocol</structname> of <systemitem class="Constant">DtDND_BUFFER_TRANSFER</systemitem>
is specified.</para>
</refsect2>
<refsect2>
<title>Export/Import Targets</title>
<para>The export and import targets are <systemitem class="Constant">_DT_BUFFER_DATA</systemitem>, <systemitem class="Constant">_DT_BUFFER_LENGTHS</systemitem>
and, optionally, <systemitem class="Constant">_DT_BUFFER_NAMES</systemitem>.
</para>
</refsect2>
<refsect2>
<title>Data Transfer Protocol</title>
<para>The <systemitem class="Constant">_DT_BUFFER_DATA</systemitem> and <systemitem class="Constant">_DT_BUFFER_LENGTHS</systemitem> targets are converted to
transfer the buffer data.</para>
<para>The data of the buffers is encoded into the <systemitem class="Constant">_DT_BUFFER_DATA</systemitem> target as an array of bytes. The lengths in bytes
of each buffer are encoded into <systemitem class="Constant">_DT_BUFFER_LENGTHS</systemitem>. Each length is used to index into the <systemitem class="Constant">_DT_BUFFER_DATA</systemitem> array.</para>
<para>If the <systemitem class="Constant">_DT_BUFFER_NAMES</systemitem> target
is available, it is converted to transfer the names of the buffers.</para>
</refsect2>
<refsect2>
<title>Move Completion</title>
<para>The move is completed by converting the selection into the ICCCM <systemitem class="Constant">DELETE</systemitem> target.</para>
</refsect2>
</refsect1>
<refsect1>
<title>SELECTION TARGETS</title>
<para>The following table describes the selection targets used in the drag
and drop data matching and transfer protocols.</para>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.08in">
<colspec align="left" colwidth="2.27in">
<colspec align="left" colwidth="2.02in">
<colspec align="left" colwidth="2.87in">
<tbody>
<row>
<entry align="left" valign="top"><structname role="typedef">Atom</structname></entry>
<entry align="left" valign="top"><literal>Type</literal></entry>
<entry align="left" valign="top"><literal>Description</literal></entry></row>
<row>
<entry align="left" valign="top">TARGETS</entry>
<entry align="left" valign="top">ATOM</entry>
<entry align="left" valign="top">A list of valid target atoms. See ICCCM section
2.6.2.</entry></row>
<row>
<entry align="left" valign="top">DELETE</entry>
<entry align="left" valign="top">NULL</entry>
<entry align="left" valign="top">Used to delete the dropped data. If the drop
receiver wishes to perform a move operation on the data, after copying the
data it should request conversion of the <systemitem class="Constant">DELETE</systemitem> target. See ICCCM section 2.6.3.1.</entry></row>
<row>
<entry align="left" valign="top">COMPOUND_TEXT</entry>
<entry align="left" valign="top">COMPOUND_TEXT</entry>
<entry align="left" valign="top">The text selection in compound text format.
See ICCCM section 2.7.1.</entry></row>
<row>
<entry align="left" valign="top">STRING</entry>
<entry align="left" valign="top">STRING</entry>
<entry align="left" valign="top">The text selection in ISO Latin-1 format.
See ICCCM section 2.7.1.</entry></row>
<row>
<entry align="left" valign="top">TEXT</entry>
<entry align="left" valign="top">TEXT</entry>
<entry align="left" valign="top">The text selection in the format preferred
by the selection holder. See ICCCM section 2.7.1.</entry></row>
<row>
<entry align="left" valign="top">HOST_NAME</entry>
<entry align="left" valign="top">TEXT</entry>
<entry align="left" valign="top">The name of the machine running the client
as seen from the machine running the server. See ICCCM section 2.6.2.</entry>
</row>
<row>
<entry align="left" valign="top">FILE_NAME</entry>
<entry align="left" valign="top">TEXT</entry>
<entry align="left" valign="top">The full path name of the files. See ICCCM
section 2.6.2.</entry></row>
<row>
<entry align="left" valign="top">_DT_NETFILE</entry>
<entry align="left" valign="top">TEXT</entry>
<entry align="left" valign="top">The full pathname of the files, each encoded
using &cdeman.tt.file.netfile; and decoded using &cdeman.tt.netfile.file;.</entry></row>
<row>
<entry align="left" valign="top">_DT_BUFFER_DATA</entry>
<entry align="left" valign="top">_DT_BUFFER_DATA</entry>
<entry align="left" valign="top">The buffer data in an array of bytes.</entry>
</row>
<row>
<entry align="left" valign="top">_DT_BUFFER_LENGTHS</entry>
<entry align="left" valign="top">INTEGER</entry>
<entry align="left" valign="top">The lengths in bytes of each buffer in the <systemitem class="Constant">_DT_BUFFER_NAMES</systemitem> array.</entry></row>
<row>
<entry align="left" valign="top">_DT_BUFFER_NAMES</entry>
<entry align="left" valign="top">STRING</entry>
<entry align="left" valign="top">The names of each buffer, suitable for use
as a file name.</entry></row></tbody></tgroup><?Pub Caret></informaltable>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.Dt.Dnd.h;, &cdeman.DtDndDragStart;, &cdeman.DtDndDragStart;, &cdeman.DtDndDropRegister;, &cdeman.DtDndDropUnregister;, &cdeman.XmDropTransferStart;, &cdeman.XmDragContext;, &cdeman.XmDragStart;, &cdeman.XmDropSiteRegister;, &cdeman.XmDropSite;, &cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, <literal>X11/R5 Inter-Client
Communications Conventions Manual (ICCCM)</literal></para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000042458>

170
cde/doc/C/guides/man/man4/Edit.sgm Normal file
View File

@@ -0,0 +1,170 @@
<!-- $XConsortium: Edit.sgm /main/8 1996/09/08 20:13:54 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN284.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN284.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Edit</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Edit</Symbol></RefName>
<RefPurpose>compose or edit a document
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Edit.sgm /main/8 1996/09/08 20:13:54 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Edit([out|inout] <Emphasis>mediaType contents</Emphasis>
[in title <Emphasis>docName</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Edit</Symbol> request causes the handler to edit a document
and reply with the new contents when the editing is completed.
</Para>
<Para>It is up to the handler to decide issues such as:
</Para>
<ItemizedList>
<ListItem>
<Para>When the editing operation can be deemed completed
</Para>
</ListItem>
<ListItem>
<Para>What user gesture signals the completion of the editing
</Para>
</ListItem>
<ListItem>
<Para>What the handling tool should do with itself after replying
</Para>
</ListItem>
</ItemizedList>
<Para>If the handling tool supports some form of intermediate save operation
during editing,
it must send a
<Symbol Role="Message">Deposit</Symbol> request back to the tool that requested the
<Symbol Role="Message">Edit</Symbol>.</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>If the
<Emphasis>contents</Emphasis> argument is of mode
<Literal>out</Literal>, then a new document must be composed
and its contents returned in this argument.
</Para>
<Para>The
<Emphasis>docName</Emphasis> argument contains the name of the document.
If the
<Emphasis>docName</Emphasis> argument is absent and the
<Symbol Role="Variable">file</Symbol> attribute is set,
the file name is considered to be the title of the document.
This string would be suitable for display in a window title bar, for example.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>To edit an X11 XBM bitmap, the application can send an
<Symbol Role="Message">Edit</Symbol> request with a first argument whose vtype is
<Symbol>XBM</Symbol>, and whose value is a string such as:
</Para>
<InformalExample Remap="indent">
<ProgramListing>#define foo_width 44&bsol;n#define foo_height 94&bsol;n
</ProgramListing>
</InformalExample>
<Para>The
<Literal>&bsol;n</Literal> in the example represents the newline character.
The notation is the same as in the &str-Z3;.
</Para>
<Para>To edit an X11 XBM bitmap contained in a file, the application can send an
<Symbol Role="Message">Edit</Symbol> request naming that file in its
<Symbol Role="Variable">file</Symbol> attribute,
with a first argument whose vtype is
<Symbol>XBM</Symbol>, and whose value is not set.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Edit</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ECANCELED</Term>
<ListItem>
<Para>The user overrode the
<Symbol Role="Message">Edit</Symbol> request.
When an
<Symbol Role="Message">Edit</Symbol> request is failed with
<SystemItem Class="Constant">TT_DESKTOP_ECANCELED</SystemItem>, the document should not be updated
as a result, but rather should remain as it was before
the failure reply was received.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Display</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

70
cde/doc/C/guides/man/man4/Get_Env.sgm Normal file
View File

@@ -0,0 +1,70 @@
<!-- $XConsortium: Get_Env.sgm /main/5 1996/08/30 14:47:56 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN285.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN285.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Environment</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Environment</Symbol></RefName>
<RefPurpose>get a tool's environment
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Env.sgm /main/5 1996/08/30 14:47:56 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Environment(in string <Symbol Role="Variable">variable</Symbol>,
out string <Symbol Role="Variable">value</Symbol>
[...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Environment</Symbol> request
reports the value of the indicated environment variable(s).
</Para>
<Para>The
<Symbol Role="Variable">variable</Symbol> argument
is the name of the environment variable to get.
</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument
is the value of the environment variable.
If no value (in other words,
<Literal>(char *)0</Literal>) is returned for this
argument, then the variable was not present in the
handler's environment.
This condition is not an error.
If an empty string (in other words, "&thinsp;")
is returned for this argument, then the variable was present in the
handler's environment, but had a null value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Environment</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Environment</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

76
cde/doc/C/guides/man/man4/Get_Geom.sgm Normal file
View File

@@ -0,0 +1,76 @@
<!-- $XConsortium: Get_Geom.sgm /main/6 1996/08/30 14:48:30 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN286.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN286.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Geometry</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Geometry</Symbol></RefName>
<RefPurpose>get a tool's on-screen geometry
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Geom.sgm /main/6 1996/08/30 14:48:30 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Geometry(out width <Symbol Role="Variable">w</Symbol>,
out height <Emphasis>h</Emphasis>,
out xOffset <Symbol Role="Variable">x</Symbol>,
out yOffset <Symbol Role="Variable">y</Symbol>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Geometry</Symbol> request
reports the on-screen geometry of the optionally specified
window, or of the window primarily associated with the recipient
procid (if no window is specified).
</Para>
<Para>The
<Symbol Role="Variable">w</Symbol>, <Emphasis>h</Emphasis>, <Symbol Role="Variable">x</Symbol> and
<Symbol Role="Variable">y</Symbol> arguments are integer geometry values, in pixels,
representing width, height, x-coordinate and y-coordinate,
respectively.
Negative offset values
are interpreted according to the
<![ %CDE.C.CDE; [<Filename MoreInfo="RefEntry">X11</Filename>(7) man page.
]]><![ %CDE.C.XO; [&str-Zl;.
]]></Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Get_Geometry</Symbol> request.
Also,
<Symbol Role="Message">Get_Geometry</Symbol> can be sent by
&cdeman.ttdt.sender.imprint.on;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Geometry</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

66
cde/doc/C/guides/man/man4/Get_Icon.sgm Normal file
View File

@@ -0,0 +1,66 @@
<!-- $XConsortium: Get_Icon.sgm /main/5 1996/08/30 14:48:56 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN287.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN287.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Iconified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Iconified</Symbol></RefName>
<RefPurpose>get a tool's iconic state
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Icon.sgm /main/5 1996/08/30 14:48:56 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Iconified(out boolean <Emphasis>iconic</Emphasis>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Iconified</Symbol> request
reports the iconic state of the optionally specified
window, or of the window primarily associated with the handling
procid (if no window is specified).
</Para>
<Para>The
<Emphasis>iconic</Emphasis> argument
is a Boolean value indicating whether the specified window is (to be)
iconified.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window(s) in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Get_Iconified</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Iconified</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

105
cde/doc/C/guides/man/man4/Get_Loca.sgm Normal file
View File

@@ -0,0 +1,105 @@
<!-- $XConsortium: Get_Loca.sgm /main/6 1996/09/08 20:14:03 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN288.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN288.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Locale</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Locale</Symbol></RefName>
<RefPurpose>get a tool's locale
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Loca.sgm /main/6 1996/09/08 20:14:03 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Locale(in string <Emphasis>category</Emphasis>,
out string <Symbol Role="Variable">locale</Symbol>
[...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Locale</Symbol> request
reports the
<![ %CDE.C.XO; [XPG4
]]><![ %CDE.C.CDE; [POSIX
]]>locale of the indicated locale categories.
</Para>
<Para>The
<Emphasis>category</Emphasis> argument
is the locale category to get.
A locale category is a
group of data types whose output formatting varies according to
locale in a similar way.
ISO C and &str-XX; locale categories are:
</Para>
<InformalExample Remap="indent">
<ProgramListing>LC_ALL
LC_COLLATE
LC_CTYPE
LC_MESSAGES
LC_MONETARY
LC_NUMERIC
LC_TIME
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument
is the name of the current locale of the indicated category.
The value of
<Symbol Role="Variable">locale</Symbol> is implementation-defined.
<![ %CDE.C.SUN; [For example, Solaris defines such locales as
<Literal>C</Literal>, <Literal>de</Literal>, <Literal>fr</Literal>, <Literal>it</Literal>, etc.
]]></Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return the following error
in processing the
<Symbol Role="Message">Get_Locale</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_EINVAL</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument is not valid on the handler's host.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Locale</Symbol> request.
</Para>
<Para>Also,
<Symbol Role="Message">Get_Locale</Symbol> can be sent by
&cdeman.ttdt.sender.imprint.on;, with the reply being handled transparently.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Function>setlocale</Function>3C <![ %CDE.C.XO; [in the &str-Zk;,
]]><![ %CDE.C.SUN; [<Emphasis>Solaris</Emphasis> <Emphasis>2.3</Emphasis> <Emphasis>Developer's</Emphasis> <Emphasis>Guide</Emphasis> <Emphasis>to</Emphasis> <Emphasis>Internationalization,</Emphasis> ]]>&cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Locale</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

66
cde/doc/C/guides/man/man4/Get_Map.sgm Normal file
View File

@@ -0,0 +1,66 @@
<!-- $XConsortium: Get_Map.sgm /main/5 1996/08/30 14:50:02 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN289.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN289.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Mapped</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Mapped</Symbol></RefName>
<RefPurpose>get whether a tool is mapped to the screen
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Map.sgm /main/5 1996/08/30 14:50:02 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Mapped(out boolean <Symbol Role="Variable">mapped</Symbol>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Mapped</Symbol> request
reports the mapped state of the optionally specified
window, or of the window primarily associated with the handling
procid (if no window is specified).
</Para>
<Para>The
<Symbol Role="Variable">mapped</Symbol> argument
is a Boolean value indicating whether the specified window is (to be)
mapped to the screen.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Get_Mapped</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Mapped</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

99
cde/doc/C/guides/man/man4/Get_Modi.sgm Normal file
View File

@@ -0,0 +1,99 @@
<!-- $XConsortium: Get_Modi.sgm /main/5 1996/08/30 14:50:32 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN290.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN290.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Modified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Modified</Symbol></RefName>
<RefPurpose>ask whether an entity has been modified
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Modi.sgm /main/5 1996/08/30 14:50:32 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Get_Modified(in <Emphasis>type ID</Emphasis>,
out boolean <Emphasis>modified</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Modified</Symbol> request
asks whether any tool has modified a volatile,
non-shared (for example, in-memory) representation of the persistent
state of an entity (such as a file) with the intention of
eventually making that representation persistent.
</Para>
<Para>Thus, a tool should register a dynamic pattern for this request
when it has modified an entity of possible shared interest.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument is the identity of the persistent entity being asked about.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then
<Emphasis>ID</Emphasis> is unset (in other words, has a value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
<Para>The
<Emphasis>modified</Emphasis> argument
argument is a
Boolean value indicating whether a volatile, non-shared
(for example, in-memory) representation of the entity has been
modified with the intention of eventually making that
representation persistent.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Get_Modified</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_ERR_NO_MATCH</Term>
<ListItem>
<Para>Since no handler could be found, the entity in question can be assumed
not to be modified.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function
can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Modified</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Get_Modified</Symbol> request can be sent with
&cdeman.ttdt.file.request;; &cdeman.ttdt.Get.Modified;, can send the
<Symbol Role="Message">Get_Modified</Symbol> request and block on the reply.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.file.join;, &cdeman.ttdt.file.request;, &cdeman.ttdt.file.request;, &cdeman.ttdt.Get.Modified;; <Emphasis>Set_Modified</Emphasis> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

56
cde/doc/C/guides/man/man4/Get_Situ.sgm Normal file
View File

@@ -0,0 +1,56 @@
<!-- $XConsortium: Get_Situ.sgm /main/5 1996/08/30 14:50:57 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN291.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN291.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Situation</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Situation</Symbol></RefName>
<RefPurpose>get a tool's current working directory
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Situ.sgm /main/5 1996/08/30 14:50:57 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Situation(out string <Emphasis>path</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Situation</Symbol> request
reports the current working directory.
</Para>
<Para>The
<Emphasis>path</Emphasis> argument
is the pathname of the working directory that the recipient is using.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Situation</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Situation</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

105
cde/doc/C/guides/man/man4/Get_Stat.sgm Normal file
View File

@@ -0,0 +1,105 @@
<!-- $XConsortium: Get_Stat.sgm /main/6 1996/09/08 20:14:13 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN292.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN292.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Status</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Status</Symbol></RefName>
<RefPurpose>retrieve a tool's current status
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Stat.sgm /main/6 1996/09/08 20:14:13 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Status(out string <Symbol Role="Variable">status</Symbol>,
out string <Emphasis>vendor</Emphasis>,
out string <Emphasis>toolName</Emphasis>,
out string <Emphasis>toolVersion</Emphasis>
[in messageID <Emphasis>operation2Query</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Status</Symbol> request
retrieves the current status of a tool (or,
optionally, of a specific operation being performed by a tool).
</Para>
<Para>The
<Symbol Role="Variable">status</Symbol> argument
is the status retrieved.
</Para>
<Para>The
<Emphasis>vendor</Emphasis> argument
is the name of the vendor of the handling tool.
</Para>
<Para>The
<Emphasis>toolName</Emphasis> argument
is the name of the handling tool.
</Para>
<Para>The
<Emphasis>toolVersion</Emphasis> argument
is the version of the handling tool.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONAL</Title>
<Para>The
<Emphasis>operation2Query</Emphasis> argument
is the ID of the request that initiated the operation the
status of which is being requested.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used to register for, and
help process, the
<Symbol Role="Message">Get_Status</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>After sending a
<SystemItem Class="Constant">TT_REQUEST</SystemItem> and storing its handle in
<StructName Role="typedef">Tt_message</StructName> <Emphasis>request_I_sent</Emphasis>, if the handler identifies itself with a
<Symbol Role="Message">Status</Symbol> notice
saved in
<StructName Role="typedef">Tt_message</StructName> <Emphasis>status_msg_from_handler</Emphasis>, then the status of
<Emphasis>request_I_sent</Emphasis> can be queried as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
tt_message_sender(status_msg_from_handler),
TTDT_GET_STATUS, my_callback);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_IN, Tttk_string,
tt_message_id(request_I_sent));
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.arg.add;, &cdeman.tt.message.id;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.tt.message.sender;, &cdeman.ttdt.session.join;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/man4/Get_Sysi.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: Get_Sysi.sgm /main/6 1996/09/08 20:14:21 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN293.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN293.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Sysinfo</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Sysinfo</Symbol></RefName>
<RefPurpose>get information about a tool's host
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Sysi.sgm /main/6 1996/09/08 20:14:21 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Sysinfo(out string <Emphasis>sysname</Emphasis>,
out string <Emphasis>nodename</Emphasis>,
out string <Emphasis>release</Emphasis>,
out string <Symbol Role="Variable">version</Symbol>,
out string <Emphasis>machine</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Sysinfo</Symbol> request gets information about the handler's host.
</Para>
<Para>The
<Emphasis>sysname</Emphasis> argument
is the name of the host's operating system.
</Para>
<Para>The
<Emphasis>nodename</Emphasis> argument
is the name of the host.
</Para>
<Para>The
<Emphasis>release</Emphasis> and
<Symbol Role="Variable">version</Symbol> arguments are
implementation-specific information about the host's operating system.
</Para>
<Para>The
<Emphasis>machine</Emphasis> argument
is an implementation-specific name that identifies the hardware
on which the operating system is running.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function
can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Sysinfo</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Get_Sysinfo</Symbol> message can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_GET_SYSINFO,
my_callback);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Function>uname</Function>(2) <![ %CDE.C.XO; [in the &str-ZK;,
]]>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.session.join;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

79
cde/doc/C/guides/man/man4/Get_XInf.sgm Normal file
View File

@@ -0,0 +1,79 @@
<!-- $XConsortium: Get_XInf.sgm /main/7 1996/09/08 20:14:29 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCDI.MAN294.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN294.rsml.1">]]><refmeta>
<refentrytitle>Get_XInfo</refentrytitle><manvolnum>special file</manvolnum>
</refmeta><refnamediv><refname><symbol role="Message">Get_XInfo</symbol></refname>
<refpurpose>get a tool's X11 attributes</refpurpose></refnamediv><!-- $XConsortium:
Get_XInf.sgm /main/3 1995/08/30 23:39:15 rws $--><!-- CDE Common Source Format,
Version 1.0.0--><!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company--><!--
(c) Copyright 1993, 1994, 1995 International Business Machines Corp.--><!--
(c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.--><!-- (c) Copyright
1993, 1994, 1995 Novell, Inc.--><refsynopsisdiv>
<synopsis>Get_XInfo(out string <symbol role="Variable">display</symbol>,
out string <emphasis>visual</emphasis>,
out integer <symbol role="Variable">depth</symbol>
[in messageID <emphasis>commission</emphasis>]);</synopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <symbol role="Message">Get_XInfo</symbol> request reports the X11
attributes of the optionally specified window, or of the window primarily
associated with the recipient procid (if no window is specified).</para>
<para>The <symbol role="Variable">display</symbol> argument is an X11 display.
</para>
<para>The <emphasis>visual</emphasis> argument is an X11 visual class (which
determines how a pixel will be displayed as a color). Valid values are:</para>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colwidth="128*">
<colspec align="left" colwidth="143*">
<colspec align="left" colwidth="185*">
<tbody>
<row>
<entry align="left" valign="top"><computeroutput>DirectColor</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>PseudoColor</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>StaticGray</computeroutput></entry>
</row>
<row>
<entry align="left" valign="top"><computeroutput>GrayScale</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>StaticColor</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>TrueColor</computeroutput></entry>
</row></tbody></tgroup><?Pub Caret></informaltable>
<para>The <symbol role="Variable">depth</symbol> argument is the number of
bits in a pixel.</para>
<para>The <emphasis>commission</emphasis> argument is the ID of the ongoing
request with respect to which X11 attributes are being set or reported.</para>
</refsect1><refsect1>
<title>APPLICATION USAGE</title>
<para>The &cdeman.ttdt.session.join;, and &cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for, and
transparently process, the <symbol role="Message">Get_XInfo</symbol> request.
Also, <symbol role="Message">Get_XInfo</symbol> can be sent by &cdeman.ttdt.sender.imprint.on;.</para>
<para>Since the handler may be running on a different host, it is almost always
better to return a <symbol role="Variable">display</symbol> value of <emphasis>hostname</emphasis>:<symbol role="Variable">n</symbol>[. <symbol role="Variable">n</symbol>] instead of :<symbol role="Variable">n</symbol>[. <symbol role="Variable">n</symbol>].)</para>
<para>The <emphasis>commission</emphasis> argument is useful to the extent
that the handler employs different attributes for the different operations
it may be carrying out.</para>
</refsect1><refsect1>
<title>EXAMPLES</title>
<para>The <symbol role="Message">Get_XInfo</symbol> request can be sent as
in the following example:</para>
<informalexample remap="indent">
<programlisting>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_GET_XINFO,
my_callback);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_iarg_add(msg, TT_OUT, Tttk_integer, 0);
tt_message_send(msg);</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.tt.message.iarg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;.</para>
</refsect1></refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
<?Pub *0000033399>

100
cde/doc/C/guides/man/man4/Instanti.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: Instanti.sgm /main/6 1996/09/08 20:14:38 rws $ -->
<!-- (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.MAN98.rsml.1">
<RefMeta>
<RefEntryTitle>Instantiate</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Instantiate</Filename></RefName>
<RefPurpose>open a document factory
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Instanti.sgm /main/6 1996/09/08 20:14:38 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Instantiate(in <Emphasis>mediaType template</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Emphasis>Instantiate</Emphasis> request causes the handler to open a factory for
<Emphasis>mediaType</Emphasis> documents based on
<Emphasis>template</Emphasis>. Usually this means opening an untitled buffer not bound to any file.
The handler replies when the untitled buffer is successfully opened.
</Para>
<Para>The
<Emphasis>template</Emphasis> argument
is the template of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the template to us is in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute. If the
<Symbol Role="Variable">file</Symbol> attribute is also unset, no template has been supplied, and the
factory should use its default template (usually, an empty buffer).
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>template</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>To instantiate an appointment document, the application can send an
<Emphasis>Instantiate</Emphasis> request with a first argument whose vtype is
<Symbol>DT_APPOINTMENT</Symbol>.</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Emphasis>Instantiate</Emphasis> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the template does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The template is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Deposit</Symbol>, <Symbol Role="Message">Edit</Symbol>, <Symbol Role="Message">Status</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

67
cde/doc/C/guides/man/man4/Lower.sgm Normal file
View File

@@ -0,0 +1,67 @@
<!-- $XConsortium: Lower.sgm /main/5 1996/08/30 14:53:19 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN295.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN295.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Lower</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Lower</Symbol></RefName>
<RefPurpose>lower a tool's window(s) to the back
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Lower.sgm /main/5 1996/08/30 14:53:19 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Lower([in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Lower</Symbol> request
lowers the window(s) associated with the handling procid.
If any optional arguments are present, then it
lowers only the indicated window(s).
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the message, if any, that resulted in the creation
of the window(s) that should be lowered.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Lower</Symbol> request.
<![ %CDE.C.CDE; [</Para>
</RefSect1>
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Lower</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
]]></Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Raise</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

128
cde/doc/C/guides/man/man4/Mail.sgm Normal file
View File

@@ -0,0 +1,128 @@
<!-- $XConsortium: Mail.sgm /main/5 1996/08/30 14:53:44 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN296.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN296.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Mail</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Mail</Symbol></RefName>
<RefPurpose>compose or mail a document
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Mail.sgm /main/5 1996/08/30 14:53:44 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Mail(in <Emphasis>mediaType contents</Emphasis>);
[<Symbol Role="Variable">file</Symbol>] Mail([out|inout] <Emphasis>mediaType contents</Emphasis>
[in title <Emphasis>docName</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Mail</Symbol> request causes the handler to route a document to a destination using the
mail message handling system.
The handler is responsible for finding routing information in the document.
</Para>
<Para>When the
<Emphasis>contents</Emphasis> argument is of mode
<Literal>in</Literal>, the handler must deliver the document as is,
without interacting with the user.
</Para>
<Para>When the
<Emphasis>contents</Emphasis> argument is of mode
<Literal>inout</Literal> or
<Literal>out</Literal>, the handler must allow the user to compose or edit the document
(and any embedded routing information)
before it is delivered.
If the handling tool supports some form of intermediate ``save''
operation, it must send a
<Symbol Role="Message">Deposit</Symbol> request back to the tool that initiated the
<Symbol Role="Message">Mail</Symbol> request.
</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>docName</Emphasis> argument contains the name of the document.
If the
<Emphasis>docName</Emphasis> argument is absent and the
<Symbol Role="Variable">file</Symbol> attribute is set,
the file name is considered to be the title of the document.
This string would be suitable for display in a window title bar, for example.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Mail</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Edit</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

69
cde/doc/C/guides/man/man4/Modified.sgm Normal file
View File

@@ -0,0 +1,69 @@
<!-- $XConsortium: Modified.sgm /main/5 1996/08/30 14:54:07 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN297.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN297.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Modified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Modified</Symbol></RefName>
<RefPurpose>an entity has been modified
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Modified.sgm /main/5 1996/08/30 14:54:07 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Modified(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Modified</Symbol> notice
is sent whenever a tool first modifies a volatile,
non-shared (for example, in-memory) representation of the persistent
state of an entity (such as a file), with the intention of
eventually making that representation persistent.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument
is the identity of the modified entity.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Modified</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Modified</Symbol> request can be sent with
&cdeman.ttdt.file.event;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.file.event;. &cdeman.ttdt.file.join;; <Symbol Role="Message">Reverted</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

103
cde/doc/C/guides/man/man4/Pause.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: Pause.sgm /main/6 1996/09/08 20:14:48 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN298.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN298.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Pause</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Pause</Symbol></RefName>
<RefPurpose>pause a tool, operation or data performance
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Pause.sgm /main/6 1996/09/08 20:14:48 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Pause([in messageID <Symbol Role="Variable">operation</Symbol>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Pause</Symbol> request
pauses the specified tool, operation or data performance.
</Para>
<Para>If the optional
<Symbol Role="Variable">operation</Symbol> argument is included, the handler should pause the operation
that was invoked by the specified request.
</Para>
<Para>The
<Symbol Role="Variable">operation</Symbol> argument
is the request that should be paused.
For a request to be eligible for pausing, the handler must have sent a
<Symbol Role="Message">Status</Symbol> notice back to the requester (thus
identifying itself to the requester).
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return the following error
in processing the
<Symbol Role="Message">Pause</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOMSG</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">operation</Symbol> argument does not refer to any message currently known by the handler.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used to register for,
and help process, the
<Symbol Role="Message">Pause</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Pause</Symbol> message can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_PAUSE,
my_callback);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Pause</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Resume</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

164
cde/doc/C/guides/man/man4/Print.sgm Normal file
View File

@@ -0,0 +1,164 @@
<!-- $XConsortium: Print.sgm /main/6 1996/09/08 20:14:58 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN299.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN299.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Print</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Print</Symbol></RefName>
<RefPurpose>print a document
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Print.sgm /main/6 1996/09/08 20:14:58 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Print(in <Emphasis>mediaType contents</Emphasis>,
in boolean <Emphasis>inquisitive</Emphasis>,
in boolean <Emphasis>covert</Emphasis>
[in title <Emphasis>docName</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Print</Symbol> request causes the handler to print a document.
The handler must act as if the user had issued,
(via the handler's user interface)
either a ``Print One'' or ``Print...'' command,
depending on the value of the
<Emphasis>inquisitive</Emphasis> argument.
</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>inquisitive</Emphasis> argument is a
<Literal>boolean</Literal> value
indicating whether the handler is allowed to block on user input
while carrying out the request.
However, even if
<Emphasis>inquisitive</Emphasis> is True, the handler is not required to seek such input.
</Para>
<Para>The
<Emphasis>covert</Emphasis> argument is a
<Literal>boolean</Literal> value indicating whether the handler may make itself apparent to the user
as it carries out the request.
If False, the recipient need not make itself apparent.
</Para>
<Para>If both the
<Emphasis>inquisitive</Emphasis> argument and the
<Emphasis>covert</Emphasis> argument are True, the recipient should attempt to limit its presence
to the minimum needed to receive any user input desired;
for example, through iconification.
</Para>
<Para>The
<Emphasis>docName</Emphasis> argument contains the name of the document.
If the
<Emphasis>docName</Emphasis> argument is absent and the
<Symbol Role="Variable">file</Symbol> attribute is set,
the file name is considered to be the title of the document.
This string would be suitable for display in a window title bar, for example.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttmedia.ptype.declare; function can be used to register for,
and help process, this message.
</Para>
<Para>This message can be sent with the
&cdeman.ttmedia.load; function.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>To print a PostScript document, the application can send a request of the form:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Print(in PostScript <Emphasis>contents</Emphasis>,
in boolean <Emphasis>inquisitive</Emphasis>,
in boolean <Emphasis>covert</Emphasis>);
</ProgramListing>
</InformalExample>
<Para>with a first argument whose value is a vector of bytes such as:
</Para>
<InformalExample Remap="indent">
<ProgramListing>%!&bsol;n/inch {72 mul} def...
</ProgramListing>
</InformalExample>
<Para>The
<Literal>&bsol;n</Literal> in the example represents the newline character.
The notation is the same as in the &str-Z3;.
</Para>
<Para>To print a PostScript document contained in a file,
the application can send the
<Symbol Role="Message">Print</Symbol> request as above,
with the
<Symbol Role="Variable">file</Symbol> attribute set to the relevant file
and with the value of the first argument not set.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Print</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttmedia.ptype.declare;, &cdeman.ttmedia.load;; <Emphasis>Intro</Emphasis>, <Symbol Role="Message">Status</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

166
cde/doc/C/guides/man/man4/Quit.sgm Normal file
View File

@@ -0,0 +1,166 @@
<!-- $XConsortium: Quit.sgm /main/6 1996/09/08 20:15:07 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN300.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN300.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Quit</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Quit</Symbol></RefName>
<RefPurpose>terminate an operation or an entire tool
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Quit.sgm /main/6 1996/09/08 20:15:07 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Quit(in boolean <Emphasis>silent</Emphasis>,
in boolean <Emphasis>force</Emphasis>
[in messageID <Emphasis>operation2Quit</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Quit</Symbol> request
terminates an operation or an entire tool.
Without the optional
<Emphasis>operation2Quit</Emphasis> argument, this request asks the handling procid to quit.
If the request succeeds, one or more ToolTalk procids should call
&cdeman.tt.close;, and zero or more processes should exit.
</Para>
<Para>With the optional
<Emphasis>operation2Quit</Emphasis> argument, this request asks the handler to terminate the indicated request.
(Whether the terminated request must therefore be failed
depends on its semantics.
Often, termination can be considered to
mean that the requested operation has been carried out to the
requester's satisfaction.)
</Para>
<Para>The
<Symbol Role="Message">Quit</Symbol> request should be failed (and the status code set
appropriately) when the termination is not performed&mdash;for
example, because the
<Emphasis>silent</Emphasis> argument was false and the user canceled the quit.
</Para>
<Para>The
<Emphasis>silent</Emphasis> argument affects user notification of termination.
If
<Emphasis>silent</Emphasis> is True, the handler is not allowed to
block on user input before terminating itself (or the indicated operation).
If it is False, however,
the handler may seek such input.
</Para>
<Para>The
<Emphasis>force</Emphasis> argument
is a Boolean value indicating whether the handler should
terminate itself (or the indicated operation) even if circumstances
are such that the tool ordinarily would not perform the termination.
</Para>
<Para>For example, a tool might have a policy of not quitting with
unsaved changes unless the user has been asked whether the
changes should be saved.
When
<Emphasis>force</Emphasis> is true, such a tool should terminate even when doing so would lose
changes that the user has not been asked by the tool about saving.
</Para>
<Para>The
<Emphasis>operation2Quit</Emphasis> argument
is the request that should be terminated.
For a request to be
terminable, the handler must have sent a
<Symbol Role="Message">Status</Symbol> notice back to the requester (thus
identifying itself to the requester).
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Quit</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ECANCELED</Term>
<ListItem>
<Para>The user overrode the
<Symbol Role="Message">Quit</Symbol> request.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOMSG</Term>
<ListItem>
<Para>The
<Emphasis>operation2Quit</Emphasis> argument does not refer to any message currently known by the handler.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used to register for,
and help process, the
<Symbol Role="Message">Quit</Symbol> request.
</Para>
<Para>In the successful case,
``zero or more'' procids
are cited because a single process can instantiate multiple independent
procids, and a single procid can conceivably be implemented by a set
of cooperating processes.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Quit</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_QUIT,
my_callback);
tt_message_iarg_add(msg, TT_IN, Tttk_boolean, 0);
tt_message_iarg_add(msg, TT_IN, Tttk_boolean, 0);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Quit</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<![ %CDE.C.SUN; [
<RefSect1>
<Title>BUGS</Title>
<Para>The
<Emphasis>silent</Emphasis> argument should have its polarity reversed, to be like the
<Emphasis>inquisitive</Emphasis> argument of several of the
<Literal>Media</Literal> messages.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.close;, &cdeman.tt.message.iarg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

82
cde/doc/C/guides/man/man4/Raise.sgm Normal file
View File

@@ -0,0 +1,82 @@
<!-- $XConsortium: Raise.sgm /main/6 1996/09/08 20:15:15 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN301.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN301.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Raise</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Raise</Symbol></RefName>
<RefPurpose>raise a tool's window(s) to the front
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Raise.sgm /main/6 1996/09/08 20:15:15 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Raise([in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Raise</Symbol> request
raises the window(s) associated with the handling procid.
If any optional arguments are present, then it raises
only the indicated window(s).
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the message, if any, that resulted in the creation
of the window(s) that should be raised.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Raise</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Raise</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_RAISE,
my_callback);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Raise</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Lower</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

78
cde/doc/C/guides/man/man4/Resume.sgm Normal file
View File

@@ -0,0 +1,78 @@
<!-- $XConsortium: Resume.sgm /main/5 1996/08/30 14:56:22 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN302.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN302.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Resume</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Resume</Symbol></RefName>
<RefPurpose>resume a tool, operation or data performance
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Resume.sgm /main/5 1996/08/30 14:56:22 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Resume([in messageID <Symbol Role="Variable">operation</Symbol>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Resume</Symbol> request
resumes the specified tool, operation or data performance.
</Para>
<Para>If the optional
<Symbol Role="Variable">operation</Symbol> argument is included, the handler should resume the operation
that was invoked by the specified request.
</Para>
<Para>The
<Symbol Role="Variable">operation</Symbol> argument
is the request that should be resumed.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return the following error
in processing the
<Symbol Role="Message">Resume</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOMSG</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">operation</Symbol> argument does not refer to any message currently known by the handler.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used to register for,
and help process, the
<Symbol Role="Message">Resume</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Pause</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

91
cde/doc/C/guides/man/man4/Revert.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: Revert.sgm /main/5 1996/08/30 14:56:47 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN303.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN303.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Revert</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Revert</Symbol></RefName>
<RefPurpose>discard any modifications to an entity
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Revert.sgm /main/5 1996/08/30 14:56:47 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Revert(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Revert</Symbol> notice
asks that any pending, unsaved modifications to a
persistent entity (such as a file) be discarded.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument is the identity of the entity to revert.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Revert</Symbol> notice:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_UNMODIFIED</Term>
<ListItem>
<Para>The entity had no pending, unsaved modifications.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file to save/revert does not exist.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Revert</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Revert</Symbol> request can be sent with
&cdeman.ttdt.file.request;. Also,
&cdeman.ttdt.Revert;, can send the relevant message and block on the reply.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.Revert;, &cdeman.ttdt.file.join;, &cdeman.ttdt.file.request;; <Symbol Role="Message">Save</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

67
cde/doc/C/guides/man/man4/Reverted.sgm Normal file
View File

@@ -0,0 +1,67 @@
<!-- $XConsortium: Reverted.sgm /main/5 1996/08/30 14:57:14 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN304.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN304.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Reverted</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Reverted</Symbol></RefName>
<RefPurpose>an entity has been reverted
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Reverted.sgm /main/5 1996/08/30 14:57:14 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Reverted(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Reverted</Symbol> notice is
sent when all the modifications (see the
<Symbol Role="Message">Modified</Symbol> notice) to an entity have been discarded.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument
is the identity of the modified or reverted entity.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Reverted</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Reverted</Symbol> request can be sent with
&cdeman.ttdt.file.event;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.file.event;, &cdeman.ttdt.file.join;; <Symbol Role="Message">Saved</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

91
cde/doc/C/guides/man/man4/Save.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: Save.sgm /main/5 1996/08/30 14:57:38 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN305.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN305.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Save</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Save</Symbol></RefName>
<RefPurpose>save any modifications to an entity
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Save.sgm /main/5 1996/08/30 14:57:38 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Save(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Save</Symbol> notice
asks that any pending, unsaved modifications to a
persistent entity (such as a file) be saved.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument is the identity of the entity to save.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Save</Symbol> notice:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_UNMODIFIED</Term>
<ListItem>
<Para>The entity had no pending, unsaved modifications.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file to save/revert does not exist.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Save</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Save</Symbol> request can be sent with
&cdeman.ttdt.file.request;. Also,
&cdeman.ttdt.Save;, can send the relevant message and block on the reply.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.Save;, &cdeman.ttdt.file.join;, &cdeman.ttdt.file.request;; <Symbol Role="Message">Revert</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

65
cde/doc/C/guides/man/man4/Saved.sgm Normal file
View File

@@ -0,0 +1,65 @@
<!-- $XConsortium: Saved.sgm /main/5 1996/08/30 14:58:14 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN306.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN306.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Saved</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Saved</Symbol></RefName>
<RefPurpose>an entity has been saved to persistent storage
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Saved.sgm /main/5 1996/08/30 14:58:14 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Saved(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Saved</Symbol> notice announces that
the persistent storage for an entity (such
as a file) has been updated.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument is the identity of the saved entity.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Saved</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Saved</Symbol> request can be sent with
&cdeman.ttdt.file.event;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.file.event;, &cdeman.ttdt.file.join;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/man4/Set_Env.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: Set_Env.sgm /main/6 1996/09/08 20:15:27 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN307.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN307.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Environment</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Environment</Symbol></RefName>
<RefPurpose>set a tool's environment
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Env.sgm /main/6 1996/09/08 20:15:27 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Environment(in string <Symbol Role="Variable">variable</Symbol>,
in string <Symbol Role="Variable">value</Symbol>
[...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Environment</Symbol> request
replaces the value of the indicated environment variable(s).
</Para>
<Para>The
<Symbol Role="Variable">variable</Symbol> argument
is the name of the environment variable to set.
</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument
is the value of the environment variable.
If this argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), then the
variable should be removed from the environment.
It is not
an error for the variable not to have existed in the first place.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Set_Environment</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Environment</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_ENVIRONMENT,
my_callback);
tt_message_arg_add(msg, TT_IN, Tttk_string, "PATH");
tt_message_arg_add(msg, TT_IN, Tttk_string, "/bin:/usr/ucb");
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Environment</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Environment</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

95
cde/doc/C/guides/man/man4/Set_Geom.sgm Normal file
View File

@@ -0,0 +1,95 @@
<!-- $XConsortium: Set_Geom.sgm /main/7 1996/09/08 20:15:35 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN308.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN308.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Geometry</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Geometry</Symbol></RefName>
<RefPurpose>set a tool's on-screen geometry
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Geom.sgm /main/7 1996/09/08 20:15:35 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Geometry(inout width <Symbol Role="Variable">w</Symbol>,
inout height <Emphasis>h</Emphasis>,
inout xOffset <Symbol Role="Variable">x</Symbol>,
inout yOffset <Symbol Role="Variable">y</Symbol>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Geometry</Symbol> request
sets the on-screen geometry of the optionally specified
window, or of the window primarily associated with the recipient
procid (if no window is specified).
</Para>
<Para>The
<Symbol Role="Variable">w</Symbol>, <Emphasis>h</Emphasis>, <Symbol Role="Variable">x</Symbol> and
<Symbol Role="Variable">y</Symbol> arguments are integer geometry values, in pixels,
representing width, height, x-coordinate and y-coordinate,
respectively.
Negative offset values
are interpreted according to the
<![ %CDE.C.CDE; [<Filename MoreInfo="RefEntry">X11</Filename>(7) man page.
]]><![ %CDE.C.XO; [&str-Zl;.
]]>If any of these arguments are unset, that part of the geometry need
not be changed.
The return values are the actual
new values, in case they differ from the requested new values.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Set_Geometry</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Geometry</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_GEOMETRY,
my_callback);
tt_message_iarg_add(msg, TT_INOUT, Tttk_width, 500);
tt_message_iarg_add(msg, TT_INOUT, Tttk_height, 500);
tt_message_arg_add(msg, TT_INOUT, Tttk_xoffset, 0); /* no value */
tt_message_arg_add(msg, TT_INOUT, Tttk_yoffset, 0); /* no value */
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.arg.add;, &cdeman.tt.message.iarg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Geometry</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

111
cde/doc/C/guides/man/man4/Set_Icon.sgm Normal file
View File

@@ -0,0 +1,111 @@
<!-- $XConsortium: Set_Icon.sgm /main/6 1996/09/08 20:15:43 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN309.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN309.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Iconified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Iconified</Symbol></RefName>
<RefPurpose>set a tool's iconic state
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Icon.sgm /main/6 1996/09/08 20:15:43 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Iconified(in boolean <Emphasis>iconic</Emphasis>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Iconified</Symbol> request
sets the iconic state of the optionally specified
window, or of the window primarily associated with the handling
procid (if no window is specified).
</Para>
<Para>The
<Emphasis>iconic</Emphasis> argument
is a Boolean value indicating whether the specified window is (to be)
iconified.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window(s) in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Set_Iconified</Symbol> request.
</Para>
<Para>If the handler does not map window-system windows one-to-one to
commissions or procids, then it may interpret ``iconic state'' liberally.
For example, consider a
<Symbol Role="Message">Display</Symbol> request on an
<Literal>ISO_Latin_1</Literal> file, handled by a
<Command>gnuemacs</Command> instance that then devotes an
<Command>emacs</Command> ``window'' to the file.
``Windows'' in
<Command>gnuemacs</Command> are not separate X11 windows, and are not separately iconifiable.
However, a
<Symbol Role="Message">Set_Iconified</Symbol> request issued with respect to the ongoing
<Symbol Role="Message">Display</Symbol> request could be liberally interpreted by
<Command>gnuemacs</Command> to mean it should
minimize the screen real estate devoted to the operation, perhaps by
``burying'' the buffer or dividing its window's real estate among
neighboring windows.
And, if the
<Symbol Role="Message">Display</Symbol> request happens to be the only thing
<Command>emacs</Command> is working on at the
moment, it could instead take a literal interpretation, and actually
iconify itself.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Iconified</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_ICONIFIED,
my_callback);
tt_message_iarg_add(msg, TT_IN, Tttk_boolean, 1);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Iconified</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.iarg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Iconified</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

126
cde/doc/C/guides/man/man4/Set_Loca.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: Set_Loca.sgm /main/6 1996/09/08 20:15:52 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN310.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN310.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Locale</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Locale</Symbol></RefName>
<RefPurpose>set a tool's locale
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Loca.sgm /main/6 1996/09/08 20:15:52 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Locale(in string <Emphasis>category</Emphasis>,
in string <Symbol Role="Variable">locale</Symbol>
[...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Locale</Symbol> request
reports the
<![ %CDE.C.XO; [XPG4
]]><![ %CDE.C.CDE; [POSIX
]]>locale of the indicated locale categories.
</Para>
<Para>The
<Emphasis>category</Emphasis> argument
is the locale category to set.
A locale category is a
group of data types whose output formatting varies according to
locale in a similar way.
ISO C and &str-XX; locale categories are:
</Para>
<InformalExample Remap="indent">
<ProgramListing>LC_ALL
LC_COLLATE
LC_CTYPE
LC_MESSAGES
LC_MONETARY
LC_NUMERIC
LC_TIME
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument
is the name of the
locale to set the indicated category to.
The value of
<Symbol Role="Variable">locale</Symbol> is implementation-defined.
<![ %CDE.C.SUN; [For example, Solaris defines such locales as
<Literal>C</Literal>, <Literal>de</Literal>, <Literal>fr</Literal>, <Literal>it</Literal>, etc.
]]></Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return the following error
in processing the
<Symbol Role="Message">Set_Locale</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_EINVAL</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument is not valid on the handler's host.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Set_Locale</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Locale</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_LOCALE,
my_callback);
tt_message_arg_add(msg, TT_IN, Tttk_string, "LC_MONETARY");
tt_message_arg_add(msg, TT_IN, Tttk_string, "de");
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Locale</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Function>setlocale</Function>3C <![ %CDE.C.XO; [in the &str-Zk;,
]]><![ %CDE.C.SUN; [<Emphasis>Solaris</Emphasis> <Emphasis>2.3</Emphasis> <Emphasis>Developer's</Emphasis> <Emphasis>Guide</Emphasis> <Emphasis>to</Emphasis> <Emphasis>Internationalization;</Emphasis> ]]>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Locale</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

89
cde/doc/C/guides/man/man4/Set_Map.sgm Normal file
View File

@@ -0,0 +1,89 @@
<!-- $XConsortium: Set_Map.sgm /main/6 1996/09/08 20:16:01 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN311.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN311.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Mapped</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Mapped</Symbol></RefName>
<RefPurpose>set whether a tool is mapped to the screen
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Map.sgm /main/6 1996/09/08 20:16:01 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Mapped(in boolean <Symbol Role="Variable">mapped</Symbol>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Mapped</Symbol> request
sets the mapped state of the optionally specified
window, or of the window primarily associated with the handling
procid (if no window is specified).
</Para>
<Para>The
<Symbol Role="Variable">mapped</Symbol> argument
is a Boolean value indicating whether the specified window is (to be)
mapped to the screen.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Set_Mapped</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Mapped</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_MAPPED,
my_callback);
tt_message_iarg_add(msg, TT_IN, Tttk_boolean, 1);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Mapped</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.iarg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Mapped</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

79
cde/doc/C/guides/man/man4/Set_Situ.sgm Normal file
View File

@@ -0,0 +1,79 @@
<!-- $XConsortium: Set_Situ.sgm /main/6 1996/09/08 20:16:10 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN312.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN312.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Situation</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Situation</Symbol></RefName>
<RefPurpose>set a tool's current working directory
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Situ.sgm /main/6 1996/09/08 20:16:10 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Set_Situation(in string <Emphasis>path</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Situation</Symbol> request
sets the current working directory.
</Para>
<Para>The
<Emphasis>path</Emphasis> argument
is the pathname of the working directory that the recipient should use.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Set_Situation</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Situation</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SET_SITUATION,
my_callback);
tt_message_arg_add(msg, TT_OUT, Tttk_string, 0);
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Situation</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Situation</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

80
cde/doc/C/guides/man/man4/Signal.sgm Normal file
View File

@@ -0,0 +1,80 @@
<!-- $XConsortium: Signal.sgm /main/6 1996/09/08 20:16:18 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN313.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN313.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Signal</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Signal</Symbol></RefName>
<RefPurpose>send a (POSIX-style) signal to a tool
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Signal.sgm /main/6 1996/09/08 20:16:18 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Signal(in string <Emphasis>theSignal</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Signal</Symbol> request
asks the handling procid to send itself the
indicated POSIX signal.
</Para>
<Para>The
<Emphasis>theSignal</Emphasis> argument
is the signal to send.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Signal</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Signal</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
the_recipient_procid, TTDT_SIGNAL,
my_callback);
tt_message_arg_add(msg, TT_IN, Tttk_string, "SIGHUP");
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Signal</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Function>sigaction</Function>(2) <![ %CDE.C.XO; [in the &str-ZK;;
]]>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.session.join;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

78
cde/doc/C/guides/man/man4/Started.sgm Normal file
View File

@@ -0,0 +1,78 @@
<!-- $XConsortium: Started.sgm /main/9 1996/09/08 20:16:26 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN314.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN314.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Started</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Started</Symbol></RefName>
<RefPurpose>a tool has started
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>Started(in string <Emphasis>vendor</Emphasis>,
in string <Emphasis>toolName</Emphasis>,
in string <Emphasis>toolVersion</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Started</Symbol> notice announces that
a tool has started.
</Para>
<Para>The
<Emphasis>vendor</Emphasis> argument
is the vendor of the started tool.
</Para>
<Para>The
<Emphasis>toolName</Emphasis> argument
is the name of the started tool.
</Para>
<Para>The
<Emphasis>toolVersion</Emphasis> argument
is the version of the started tool.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>A pattern observing the
<Symbol Role="Message">Started</Symbol> request can be registered as
in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_pattern pat = tt_pattern_create();
tt_pattern_category_set(pat, TT_OBSERVE);
tt_pattern_scope_add(pat, TT_SESSION);
char *ses = tt_default_session();
tt_pattern_session_add(pat, ses);
tt_free(ses);
tt_pattern_op_add(pat, Tttk_Started);
tt_pattern_op_add(pat, Tttk_Stopped);
tt_pattern_callback_add(pat, my_callback);
tt_pattern_register(pat);
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Message">Started</Symbol> request can be sent with
&cdeman.ttdt.open;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.free;, &cdeman.tt.pattern.callback.add;, &cdeman.tt.pattern.category.set;, &cdeman.tt.pattern.op.add;, &cdeman.tt.pattern.register;, &cdeman.tt.pattern.scope.add;, &cdeman.tt.pattern.session.add;, &cdeman.ttdt.open;; <Symbol Role="Message">Stopped</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

89
cde/doc/C/guides/man/man4/Status.sgm Normal file
View File

@@ -0,0 +1,89 @@
<!-- $XConsortium: Status.sgm /main/5 1996/08/30 15:01:49 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN315.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN315.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Status</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Status</Symbol></RefName>
<RefPurpose>a tool has some status information to announce
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Status.sgm /main/5 1996/08/30 15:01:49 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Status(in string <Symbol Role="Variable">status</Symbol>,
in string <Emphasis>vendor</Emphasis>,
in string <Emphasis>toolName</Emphasis>,
in string <Emphasis>toolVersion</Emphasis>
[in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Status</Symbol> notice
indicates that
a tool has status information to announce.
</Para>
<Para>The
<Symbol Role="Variable">status</Symbol> argument
is the status being announced.
</Para>
<Para>The
<Emphasis>vendor</Emphasis> argument
is the vendor of the sending tool.
</Para>
<Para>The
<Emphasis>toolName</Emphasis> argument
is the name of the sending tool.
</Para>
<Para>The
<Emphasis>toolVersion</Emphasis> argument
is the version of the sending tool.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the request, if any, that initiated the operation
the status of which is being announced.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.subcontract.manage;, function can be used to register for,
and help process, the
<Symbol Role="Message">Status</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Status</Symbol> request can be sent with
&cdeman.ttdt.message.accept;.</Para>
<Para>The
<Symbol Role="Message">Status</Symbol> notice can be used by handlers of requests invoking protracted
operations to provide periodic point-to-point status reports to the
requester.
Doing so has the nice side effect of identifying the handler to
the requester, so that the requester can issue a
<Symbol Role="Message">Quit</Symbol> request if it wants to.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.subcontract.manage;; <Symbol Role="Message">Quit</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

81
cde/doc/C/guides/man/man4/Stopped.sgm Normal file
View File

@@ -0,0 +1,81 @@
<!-- $XConsortium: Stopped.sgm /main/6 1996/09/08 20:16:36 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN316.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN316.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Stopped</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Stopped</Symbol></RefName>
<RefPurpose>a tool has terminated
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Stopped.sgm /main/6 1996/09/08 20:16:36 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Stopped(in string <Emphasis>vendor</Emphasis>,
in string <Emphasis>toolName</Emphasis>,
in string <Emphasis>toolVersion</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Stopped</Symbol> notice announces that
a tool has exited.
</Para>
<Para>The
<Emphasis>vendor</Emphasis> argument
is the vendor of the terminated tool.
</Para>
<Para>The
<Emphasis>toolName</Emphasis> argument
is the name of the terminated tool.
</Para>
<Para>The
<Emphasis>toolVersion</Emphasis> argument
is the version of the terminated tool.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>A pattern observing the
<Symbol Role="Message">Stopped</Symbol> request can be registered as
in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_pattern pat = tt_pattern_create();
tt_pattern_category_set(pat, TT_OBSERVE);
tt_pattern_scope_add(pat, TT_SESSION);
char *ses = tt_default_session();
tt_pattern_session_add(pat, ses);
tt_free(ses);
tt_pattern_op_add(pat, Tttk_Started);
tt_pattern_op_add(pat, Tttk_Stopped);
tt_pattern_callback_add(pat, my_callback);
tt_pattern_register(pat);
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Message">Stopped</Symbol> request can be sent with
&cdeman.ttdt.close;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.tt.free;, &cdeman.tt.pattern.callback.add;, &cdeman.tt.pattern.category.set;, &cdeman.tt.pattern.op.add;, &cdeman.tt.pattern.register;, &cdeman.tt.pattern.scope.add;, &cdeman.tt.pattern.session.add;, &cdeman.ttdt.close;; <Symbol Role="Message">Started</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

156
cde/doc/C/guides/man/man4/Translat.sgm Normal file
View File

@@ -0,0 +1,156 @@
<!-- $XConsortium: Translat.sgm /main/5 1996/09/08 20:16:44 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN317.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN317.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Translate</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Translate</Symbol></RefName>
<RefPurpose>translate a document from one media type to another
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Translat.sgm /main/5 1996/09/08 20:16:44 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Translate(in <Emphasis>mediaType contents</Emphasis>,
out <Emphasis>mediaType output</Emphasis>,
in boolean <Emphasis>inquisitive</Emphasis>,
in boolean <Emphasis>covert</Emphasis>
[in messageID <Emphasis>counterfoil</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Translate</Symbol> request causes the handler to translate a document from one media type
to another and return the translation.
The translation must be the best possible representation of the document
in the target media type,
even if the resulting representation cannot be exactly translated
back into the original document.
</Para>
<Para>The
<Emphasis>contents</Emphasis> argument
is the contents of the document.
If this argument is unset
(in other words, has a value of
<Literal>(char *)0</Literal>), then the contents of the document are in
the file named in the message's
<Symbol Role="Variable">file</Symbol> attribute.
The data type
(<Emphasis>mediaType</Emphasis>) of the
<Emphasis>contents</Emphasis> argument should be
<Literal>string</Literal>, unless nulls are valid in the given media type,
in which case the data type must be
<Literal>bytes</Literal>.</Para>
<Para>The
<Emphasis>output</Emphasis> argument is the translation of the document.
</Para>
<Para>The
<Emphasis>inquisitive</Emphasis> argument is a
<Literal>boolean</Literal> value
indicating whether the handler is allowed to block on user input
while carrying out the request.
However, even if
<Emphasis>inquisitive</Emphasis> is True, the handler is not required to seek such input.
</Para>
<Para>The
<Emphasis>covert</Emphasis> argument is a
<Literal>boolean</Literal> value indicating whether the handler may make itself apparent to the user
as it carries out the request.
If False, the recipient need not make itself apparent.
</Para>
<Para>If both the
<Emphasis>inquisitive</Emphasis> argument and the
<Emphasis>covert</Emphasis> argument are True, the recipient should attempt to limit its presence
to the minimum needed to receive any user input desired;
for example, through iconification.
</Para>
<Para>The
<Emphasis>counterfoil</Emphasis> argument is a unique string created by the message sender
to give both sender and receiver a way to refer to this request
in other correspondence.
Typically this string is created by concatenating a process ID and a counter.
This argument should be included
if the sender anticipates a need to communicate with the handler
about this request before it is completed; for example, to cancel it.
When this argument is included,
and the handler determines that an immediate reply is not possible,
the handler must immediately send at least one
<Symbol Role="Message">Status</Symbol> notice point-to-point back to the requester,
so as to identify itself to the requester.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>To provide a speech-to-text service, a tool can handle requests of the form:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Translate(in Sun_Audio <Emphasis>contents</Emphasis>,
out ISO_Latin_1 <Emphasis>output</Emphasis>,
...);
</ProgramListing>
</InformalExample>
<Para>To provide an OCR (optical character recognition) service,
a tool can handle requests of the form:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Translate(in GIF <Emphasis>contents</Emphasis>,
out ISO_Latin_1 <Emphasis>output</Emphasis>,
...);
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Translate</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file that was alleged to contain the document does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENODATA</Term>
<ListItem>
<Para>The in-mode
<Emphasis>contents</Emphasis> argument had no value and the
<Symbol Role="Variable">file</Symbol> attribute
of the message was not set.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_MEDIA_ERR_FORMAT</Term>
<ListItem>
<Para>The document is not a valid instance of the media type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Emphasis>Intro</Emphasis>, <Emphasis>Abstract</Emphasis>, <Emphasis>Interpret</Emphasis>, <Symbol Role="Message">Status</Symbol> requests.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

388
cde/doc/C/guides/man/man4/bil.sgm Normal file
View File

@@ -0,0 +1,388 @@
<!-- $XConsortium: bil.sgm /main/7 1996/09/08 20:16:53 rws $ -->
<!-- (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.MAN77.rsml.1">
<RefMeta>
<RefEntryTitle>BIL</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>BIL</Filename></RefName>
<RefPurpose>Builder Interface Language for the CDE Application Builder
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis><Literal>:bil-version</Literal> <Emphasis>major minor</Emphasis>
<Literal>:project</Literal> <Emphasis>project_name</Emphasis>
<Literal>(</Literal>
<Emphasis>project_attributes</Emphasis>
[<Literal>:connection</Literal>
<Literal>(</Literal>
<Emphasis>connection_attributes</Emphasis>
<Literal>)</Literal>]
<Literal>)</Literal>
<Literal>:module</Literal> <Symbol Role="Variable">module_name</Symbol>
<Literal>(</Literal>
<Literal>:element</Literal> <Emphasis>element_name</Emphasis>
<Literal>(</Literal>
<Emphasis>element_attributes</Emphasis>
[<Emphasis>children</Emphasis>]
<Literal>)</Literal>
[<Literal>:connection</Literal>
<Literal>(</Literal>
<Emphasis>connection_attributes</Emphasis>
<Literal>)</Literal>]
<Literal>)</Literal>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>BIL, the Builder Interface Language, is a specialized representation syntax
designed to meet the intermediate storage requirements of the CDE
Application Builder.
It describes the overall attributes of the application (also known as a
"project"), the modules that it contains, the elements that
comprise modules, and the behavioral relationships between objects
("connections").
</Para>
<Para>BIL is not a compiled language.
It is read and written as data by the CDE Application Builder and its
associated code generator.
Even so, the format of BIL is printable ASCII characters with a
"human readable" nature, making it possible for users to examine
the contents of a BIL-formatted file and to process a BIL file
using simple ASCII string-oriented tools and techniques.
</Para>
<Para>Two distinct types of BIL files are recognized by the CDE Application
Builder.
One type is known as a
<Emphasis>project file</Emphasis>, and is used to describe overall attributes of the project (application)
as well as identify the modules that comprise it.
It will also contain any cross-module information, such as connections
that bind together objects in different modules.
</Para>
<Para>A second type of BIL file exists for each module and is known as a
<Emphasis>module file</Emphasis>. It contains all module-specific information, including definition of
the elements that comprise the module and connections that exist within
it.
</Para>
<Para>BIL is structured in an object-oriented fashion.
Objects are defined and named, and sets of parenthesis are used to
enclose declarations of all the object's attributes.
Object types recognized by BIL include project, module, element
and connection.
</Para>
<VariableList>
<VarListEntry>
<Term>:bil-version major minor</Term>
<ListItem>
<!-- ex-TP-->
<Para>Version information is useful to the CDE Application Builder and
code generators in determining how to handle BIL files that may
date from earlier releases.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>:project project_name</Term>
<ListItem>
<!-- ex-TP-->
<Para>The
<Literal>:project</Literal> directive names the project (application).
It encloses a declaration of <Emphasis>project_attributes</Emphasis>
as well as a list of any cross-module <Emphasis>connections</Emphasis>
that may exist within the project.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>:module module_name</Term>
<ListItem>
<!-- ex-TP-->
<Para>The
<Literal>:module</Literal> directive names a module.
It encloses a declaration of all <Symbol Role="Variable">elements</Symbol> that comprise the
module as well as a list of any <Emphasis>connections</Emphasis>
that may exist within the module.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>:element element_name</Term>
<ListItem>
<!-- ex-TP-->
<Para>The
<Literal>:element</Literal> directive names an element.
It encloses a declaration of all <Emphasis>element_attributes</Emphasis>,
including a list of any <Emphasis>children</Emphasis> that may be part of the
element.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>:connection</Term>
<ListItem>
<!-- ex-TP-->
<Para>The
<Literal>:connection</Literal> directive names a connection and
specifies its attributes.
It can occur as part of a
<Emphasis>project</Emphasis> or a
<Symbol Role="Variable">module</Symbol>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>:children</Term>
<ListItem>
<!-- ex-TP-->
<Para>The
<Literal>:children</Literal> directive appears as an attribute of any
element which contains ("parents") other
elements.
It encloses a list of all child elements,
referencing each by its element name.
</Para>
<Para>Project, element and connection attributes take the form:
<Literal>:</Literal><Emphasis>attribute_name</Emphasis> <Emphasis>attribute_value</Emphasis>
Where <Emphasis>attribute_name</Emphasis> is an attribute appropriate for the project,
element or connection, and <Emphasis>attribute_value</Emphasis> is typed according to the
attribute.
Attribute types include integer, string, object name, and keyword, where
the keyword is one of a fixed list used by BIL to identify specific
data values (e.g. :true, :none).
Some attribute values are ordered N-tuples, in which case the
complete set is enclosed in parentheses.
</Para>
<Para>Comments may be placed in a BIL file by starting a line with two slashes (//).
Any comments that occur in a BIL file prior to the
<Literal>:bil-version</Literal> line will be preserved by the
CDE Application Builder
across successive updates to the file.
Comments that occur after the
<Literal>:bil-version</Literal> line will not be retained.
<!--- --><!--- --><!--- "RETURN VALUE"--><!--- This section indicates the possible return values, if any.--><!--- If the implementation can detect errors, "Successful completion" means--><!--- that no error has been detected during execution of the function. If --><!--- the implementation does detect an error, the error indicated.--><!--- For functions where no errors are defined, "Successful completion" --><!--- means that if the implementation checks for errors, no error has been--><!--- detected. If the implementation can detect errors, and an error is--><!--- detected, the indicated return value is returned and errno may be set.--><!--- Use .Cn on a single line to produce a constant font. For example:--><!--- --><!--- .SH "RETURN VALUE"--><!--- Upon successful completion,--><!--- .Fn data or file_ format_name--><!--- returns--><!--- .Cn TRUE--><!--- if such and such has been correctly initialized;--><!--- otherwise, it returns--><!--- .Cn FALSE--><!--- --><!--- When writing, use active voice. For example:--><!--- --><!--- Do not say: When such and such happens, minus one is returned. --><!--- Do say: When such and such happens, the foo function returns minus one.--><!--- --></Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
<!--- --><!--- ERRORS--><!--- Errors are shown under the RETURN VALUES heading.--><!--- --><!--- --><!--- EXAMPLES--><!--- This section gives examples of usage, where appropriate.--><!--- --></Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is an example of a project file:
</para>
<programlisting>
:bil-version 1 0
:project todotool
(
:files (main_window.bil task_dialog.bil)
:connection
(
:from main_window.add_item_btn
:to task_dialog.task_dialog
:when :activate
:action-type :builtin
:action :show
:arg-type :void
)
)
</programlisting>
<Para>A typical module file would contain:
</para>
<programlisting>
:bil-version 1 0
:module task_dialog
(
:element task_dialog
(
:type :dialog
:x 649
:y 499
:width 354
:height 57
:bg-color "white"
:label "Adding a New Task"
:resizable :true
:has-footer :false
:visible :false
:children (
ctrl_panel
activate_panel)
)
:element ctrl_panel
(
:type :container
:container-type :relative
:x 0
:y 0
:width 354
:height 57
:visible :true
:border-frame :none
:north-attachment (:obj task_dialog 0)
:south-attachment (:obj task_dialog 0)
:east-attachment (:obj task_dialog 0)
:west-attachment (:point 0 0)
:children (
task)
)
:element task
(
:type :text-field
:text-type :alphanumeric
:x 28
:y 6
:width -1
:height -1
:border-frame :none
:label-type :string
:label "Task:"
:label-position :west
:num-columns 32
:max-length 80
:read-only :false
:active :true
:visible :true
:north-attachment (:point 0 6)
:south-attachment (:none 0 0)
:east-attachment (:none 0 0)
:west-attachment (:point 0 28)
)
:element activate_panel
(
:type :container
:container-type :activate
:x -1
:y -1
:width -1
:height -1
:visible :true
:border-frame :etched-in
:children (
ok_button
cancel_button
help_button)
)
:element ok_button
(
:type :button
:button-type :push-button
:x -1
:y -1
:width -1
:height -1
:border-frame :none
:label-type :string
:label-alignment :center
:label "OK"
:active :true
:visible :true
:north-attachment (:grid-line 5 0)
:south-attachment (:grid-line 95 0)
:east-attachment (:grid-line 30 0)
:west-attachment (:grid-line 10 0)
)
:element cancel_button
(
:type :button
:button-type :push-button
:x -1
:y -1
:width -1
:height -1
:border-frame :none
:label-type :string
:label-alignment :center
:label "Cancel"
:active :true
:visible :true
:north-attachment (:grid-line 5 0)
:south-attachment (:grid-line 95 0)
:east-attachment (:grid-line 60 0)
:west-attachment (:grid-line 40 0)
)
:element help_button
(
:type :button
:button-type :push-button
:x -1
:y -1
:width -1
:height -1
:border-frame :none
:label-type :string
:label-alignment :center
:label "Help"
:active :true
:visible :true
:north-attachment (:grid-line 5 0)
:south-attachment (:grid-line 95 0)
:east-attachment (:grid-line 90 0)
:west-attachment (:grid-line 70 0)
)
:connection
(
:from ok_button
:to task_dialog
:when :activate
:action-type :builtin
:action :hide
:arg-type :void
)
:connection
(
:from cancel_button
:to task_dialog
:when :activate
:action-type :builtin
:action :hide
:arg-type :void
)
:connection
(
:from ok_button
:when :create
:action-type :call-function
:action confirm_taskCB
:arg-type :void
)
:connection
(
:from cancel_button
:when :create
:action-type :call-function
:action cancel_taskCB
:arg-type :void
)
)
</programlisting>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>Applications and application developers typically do not work
directly with BIL files, instead using them indirectly through
the CDE Application Builder.
It may, however, be useful for them to understand the layout and
scope of BIL to satisfy particular application development needs
(e.g. to add specialized comments to BIL files or to examine them
to examine useful information (such as help text built-into a
application)).
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtbuilder; &cdeman.dtcodegen;
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

796
cde/doc/C/guides/man/man4/dtaction.sgm Normal file
View File

@@ -0,0 +1,796 @@
<!-- $XConsortium: dtaction.sgm /main/13 1996/09/08 20:17:02 rws $ -->
<!-- (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.MAN90.rsml.1">
<refmeta><refentrytitle>dtactionfile</refentrytitle><manvolnum>special file
</manvolnum></refmeta>
<refnamediv><refname><filename>dtactionfile</filename></refname><refpurpose>
define the content of desktop action definition records</refpurpose></refnamediv>
<refsynopsisdiv>
<synopsis>set DtDbVersion=<emphasis>version_number</emphasis>
set <emphasis>VariableName</emphasis>=<emphasis>variable_value</emphasis>
ACTION <emphasis>action_name</emphasis>
{
# <emphasis>Comment</emphasis>
<emphasis>FieldName</emphasis> <emphasis>field_value</emphasis>
<emphasis>FieldName</emphasis> <emphasis>field_value</emphasis>
...
}</synopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>&str-XZ; actions define the behavior of icons, front panel controls
and operations on data objects. Actions are defined in a set of text files
with the <Filename>.dt</Filename> suffix. Each action definition consists of
the word <systemitem class="Constant">ACTION</systemitem> followed by an action
name and a list of Field and Value pairs (one per line) on lines by themselves
and enclosed in brackets.</para>
<para>These text files may also contain data typing information as described
in &cdeman.dtdtsfile;. (See &cdeman.dtdtfile; for
the general syntax and location of the actions and data types database.)</para>
<para>Actions are of one of the following classes: command actions, ToolTalk
message actions or map actions. These action classes are described in the
following sections.</para>
<refsect2>
<title>Command Actions</title>
<para>Command actions are identified by a <systemitem class="Constant">TYPE</systemitem> <systemitem class="Constant">COMMAND</systemitem> field. This
field defines an execution string to invoke and a set of related information,
such as the current working directory for the command and the host where the
command should be executed. The following field names are unique to command
actions: <systemitem class="Constant">EXEC_STRING</systemitem>, <systemitem class="Constant">EXEC_HOST</systemitem>, <systemitem class="Constant">CWD</systemitem>, <systemitem class="Constant">WINDOW_TYPE</systemitem> and <systemitem class="Constant">TERM_OPTS</systemitem>.</para>
</refsect2>
<refsect2>
<title>ToolTalk Message Actions</title>
<para>ToolTalk message actions are identified by a <systemitem class="Constant">TYPE</systemitem> <systemitem class="Constant">TT_MSG</systemitem> field.
This field defines a ToolTalk message to be sent. The following fields are
unique to ToolTalk message actions: <systemitem class="Constant">TT_CLASS</systemitem>, <systemitem class="Constant">TT_SCOPE</systemitem>, <systemitem class="Constant">TT_OPERATION</systemitem>, <systemitem class="Constant">TT_FILE</systemitem>, <systemitem class="Constant">TT_ARGn_MODE</systemitem>, <systemitem class="Constant">TT_ARGn_VTYPE</systemitem>, <systemitem class="Constant">TT_ARGn_REP_TYPE</systemitem> and <systemitem class="Constant">TT_ARGn_VALUE</systemitem>.</para>
</refsect2>
<refsect2>
<title>Map Actions</title>
<para>Map actions are identified by a <systemitem class="Constant">TYPE</systemitem> <systemitem class="Constant">MAP</systemitem> field. This field does not define any specific
behavior; instead, this field specifies a different action name that should
be invoked in place of the original action. Multiple map actions can be chained
together, but the chain must ultimately terminate in a non-map action. The
following field is unique to map actions: <systemitem class="Constant">MAP_ACTION</systemitem>.</para>
</refsect2>
<refsect2>
<title>Common Fields</title>
<para>In addition to the unique action fields listed above, all actions support
the following fields: <systemitem class="Constant">LABEL</systemitem>, <systemitem class="Constant">ICON</systemitem>, <systemitem class="Constant">DESCRIPTION</systemitem>, <systemitem class="Constant">ARG_CLASS</systemitem>, <systemitem class="Constant">ARG_MODE</systemitem>, <systemitem class="Constant">ARG_TYPE</systemitem>, <systemitem class="Constant">ARG_COUNT</systemitem> and <systemitem class="Constant">TYPE</systemitem>.</para>
</refsect2>
<refsect2>
<title>Keywords</title>
<para>The value string for certain action fields may reference special keywords
enclosed within percentage character (%) delimiters. These keywords are evaluated
when the action is invoked and replaced with the appropriate value. In fields
that do not evaluate keywords, the keyword is taken literally. The valid keywords
are:</para>
<variablelist>
<varlistentry><term>%DatabaseHost%</term>
<listitem>
<para>The name of the host where the action definition file is located. This
hostname is specified by the host portion of the <emphasis>host:/</emphasis> <emphasis>path</emphasis> searchpath used to find the action.</para>
</listitem>
</varlistentry>
<varlistentry><term>%DisplayHost%</term>
<listitem>
<para>The name of the host where the X server displaying the &str-XZ; session
is running.</para>
</listitem>
</varlistentry>
<varlistentry><term>%LocalHost%</term>
<listitem>
<para>The name of the host where the application invoking the action is executing.
</para>
</listitem>
</varlistentry>
<varlistentry><term>%SessionHost%</term>
<listitem>
<para>The name of the host where the controlling login manager ( &cdeman.dtlogin;) runs.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Argument References</title>
<para>Arguments passed to actions can be referenced in certain action fields
using special argument keywords enclosed within percent character (%) delimiters.
These argument keywords are evaluated when the action is invoked and replaced
with the appropriate value. In fields that do not evaluate keywords, the keyword
is taken literally. The valid argument keywords are:</para>
<variablelist>
<varlistentry><term>%Arg_<emphasis>n%</emphasis></term>
<listitem>
<para>The <symbol role="Variable">n</symbol>th (starting with 1) argument
of the action. If the action was invoked with fewer than <symbol role="Variable">n</symbol> arguments, the value of the keyword is <systemitem class="Constant">NULL</systemitem>.</para>
</listitem>
</varlistentry>
<varlistentry><term>%Args%</term>
<listitem>
<para>All remaining arguments of the action. If any arguments of the action
have already been referenced within this field by an %Arg_ <symbol role="Variable">n</symbol>% keyword, those arguments are not referenced a second time by %Args%.
</para>
</listitem>
</varlistentry>
<varlistentry><term>%"<emphasis>prompt</emphasis>"%</term>
<listitem>
<para>Prompt the user for a value, using <emphasis>prompt</emphasis> as the
label of a text field.</para>
</listitem>
</varlistentry>
<varlistentry><term>%Arg_<symbol role="Variable">n</symbol>"<emphasis>prompt</emphasis> "%</term>
<listitem>
<para>The <symbol role="Variable">n</symbol>th (starting with 1) argument
of the action. If the action was invoked with fewer than <symbol role="Variable">n</symbol> arguments, prompt the user for a value using <emphasis>prompt</emphasis>
as the label of a text field.</para>
</listitem>
</varlistentry>
</variablelist>
<para>If a keyword references the name of a file argument, the value of the
keyword is expanded to an absolute pathname prior to substitution. In addition,
if the file name is to be passed to a remote system, the file name is first
mapped appropriately (see &cdeman.tt.file.netfile; and &cdeman.tt.netfile.file;).</para>
<para>If the keyword references a buffer argument, the buffer data is placed
in a temporary file and the name of the temporary file is substituted, as
described above. Some action fields provide direct support for data buffers
and do not require use of a temporary file. This behavior is noted in the
description of the appropriate fields.</para>
<para>If the keyword references a string obtained from the user, it is treated
as a simple string and the value substituted without any transformation.</para>
<para>Argument references can be forced to be treated as file names or simple
strings by using the <literal>(File)</literal> or <literal>(String)</literal>
qualifier immediately after the opening % of the keyword. For example:</para>
<informalexample remap="indent">
<programlisting>%(String)Arg_<symbol role="Variable">n</symbol>%
%(File)"<emphasis>prompt</emphasis>"%</programlisting>
</informalexample>
<para>If an action is invoked with more than one argument, and the action
definition only references one or zero arguments, the action is iteratively
invoked with each of the supplied arguments. If the action definition references
more than one argument, any extra arguments are ignored.</para>
</refsect2>
<refsect2>
<title>Action Selection</title>
<para>Multiple actions can be defined with the same name. When the action
is invoked, the appropriate action definition is chosen based on the number
and class of arguments supplied. For example, the <literal>Open</literal>
action may invoke &cdeman.dtpad; if a text file is supplied as
an argument, or it may invoke &cdeman.dticon; if a bitmap file
argument is supplied. The <systemitem class="Constant">ARG_COUNT</systemitem>, <systemitem class="Constant">ARG_CLASS</systemitem>, <systemitem class="Constant">ARG_MODE</systemitem> and <systemitem class="Constant">ARG_TYPE</systemitem> fields
specify the number, mode and types of arguments that are accepted by a particular
action. Because these fields can have shell pattern-matching values such as
*, it is possible that the action database contains multiple actions that
have the same name and are all capable of accepting the arguments that are
supplied. In this case, the following precedence rules are used to choose
a single action definition to invoke:</para>
<itemizedlist>
<!-- merged from xo+cde-->
<listitem><para>Actions with more specific attribute values take precedence
over more general attribute values.</para>
</listitem><listitem><para>For the <systemitem class="Constant">ARG_COUNT</systemitem> field, an exact numerical value (<emphasis>N</emphasis>) is
more specific than a less-than range (<emphasis>&lt;N</emphasis>). A less-than
range (<emphasis>&lt;N</emphasis>) is more specific than a greater-than range
(<emphasis>>N</emphasis>). And a greater-than range (<emphasis>>N</emphasis>)
is more specific than a shell pattern-matching character (*).</para>
</listitem><listitem><para>For the <systemitem class="Constant">ARG_CLASS</systemitem> and <systemitem class="Constant">ARG_TYPE</systemitem> fields,
a single item is more specific than a list of items and a list of items is
more specific than a shell pattern-matching *.</para>
</listitem><listitem><para>For the <systemitem class="Constant">ARG_MODE</systemitem>
field, <literal>w</literal> (writable) and <literal>!w</literal> (not writable)
are more specific than a shell pattern-matching *.</para>
</listitem><listitem><para>The fields have the following precedence, from
high to low: <systemitem class="Constant">ARG_CLASS</systemitem>, <systemitem class="Constant">ARG_TYPE</systemitem>, <systemitem class="Constant">ARG_MODE</systemitem>, <systemitem class="Constant">ARG_COUNT</systemitem>.</para>
</listitem><listitem><para>If two action definitions have equal specificity,
the action definition appearing first in the database load order takes precedence.
Database directories are loaded in the order specified by the <systemitem class="EnvironVar">DTDATABASESEARCHPATH</systemitem> environment variable,
and are loaded in the collation order of their file names.</para>
</listitem></itemizedlist>
</refsect2>
<refsect2>
<title>ARG_CLASS Field</title>
<para>The <systemitem class="Constant">ARG_CLASS</systemitem> field is optional
for all types of actions. This field specifies the class of arguments the
action accepts. If an action is invoked with more than one argument, the class
of only the first argument is checked against the value of the <systemitem class="Constant">ARG_CLASS</systemitem> field. The valid values for this field
are:</para>
<variablelist>
<varlistentry><term>BUFFER</term>
<listitem>
<para>The action accepts arguments that are blocks of data held in memory.
</para>
</listitem>
</varlistentry>
<varlistentry><term>FILE</term>
<listitem>
<para>The action accepts arguments that are file names.</para>
</listitem>
</varlistentry>
<varlistentry><term>*</term>
<listitem>
<para>The action is defined for all classes of arguments.</para>
</listitem>
</varlistentry>
</variablelist>
<para>A comma-separated list of valid values is also allowed and specifies
that the action accepts arguments of any of the listed classes.</para>
<para>If an action is defined to accept a buffer argument, yet the implementation
of the action requires a file name, the buffer is automatically converted
into a temporary file for the action to use. See the description of the <literal>DtTmpDir</literal> resource for information on configuring the location of
these temporary files.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">ARG_CLASS</systemitem> field. The default value of the <systemitem class="Constant">ARG_CLASS</systemitem> field is <literal>*</literal>.</para>
</refsect2>
<refsect2>
<title>ARG_COUNT Field</title>
<para>The <systemitem class="Constant">ARG_COUNT</systemitem> field is optional
for all types of actions. The <systemitem class="Constant">ARG_COUNT</systemitem>
field specifies the number of arguments that the action accepts. The valid
values for this field (where <emphasis>N</emphasis> denotes any non-negative
integer) are:</para>
<variablelist>
<varlistentry><term><emphasis>N</emphasis></term>
<listitem>
<para>The action accepts exactly <emphasis>N</emphasis> arguments.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>&lt;N</emphasis></term>
<listitem>
<para>The action accepts any number of arguments less than <emphasis>N</emphasis>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>>N</emphasis></term>
<listitem>
<para>The action accepts any number of arguments greater than <emphasis>N</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry><term>*</term>
<listitem>
<para>The action accepts any number of arguments.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">ARG_COUNT</systemitem> field. The default value of the <systemitem class="Constant">ARG_COUNT</systemitem> field is <literal>*</literal>.</para>
</refsect2>
<refsect2>
<title>ARG_MODE Field</title>
<para>The <systemitem class="Constant">ARG_MODE</systemitem> field is optional
for all types of actions. This field specifies the mode of arguments the action
accepts. If an action is invoked with more than one argument, the mode of
only the first argument is checked against the value of the <systemitem class="Constant">ARG_MODE</systemitem> field. The valid values for this field are:</para>
<variablelist>
<varlistentry><term><literal>w</literal></term>
<listitem>
<para>The action accepts arguments that writable by the user.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>!w</literal></term>
<listitem>
<para>The action accepts arguments that are not writable by the user.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>*</literal></term>
<listitem>
<para>The action is defined for all classes of arguments.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">ARG_MODE</systemitem> field. The default value of the <systemitem class="Constant">ARG_MODE</systemitem> field is <literal>*</literal>.</para>
</refsect2>
<refsect2>
<title>ARG_TYPE Field</title>
<para>The <systemitem class="Constant">ARG_TYPE</systemitem> field is optional
for all types of actions. This field specifies the types of arguments the
action accepts. If the action is invoked with more than one argument, the
type of only the first argument is checked against the value of this field.
Valid values for this field are * (all data types are accepted), a single
data type name or a comma-separated list of data types. The set of valid data
types are those defined by <systemitem class="Constant">DATA_ATTRIBUTE</systemitem>
records in the data typing database. (See &cdeman.dtdtsfile;
for more information.)</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">ARG_TYPE</systemitem> field. The default value of the <systemitem class="Constant">ARG_TYPE</systemitem> field is <literal>*</literal>.</para>
</refsect2>
<refsect2>
<title>CWD Field</title>
<para>The <systemitem class="Constant">CWD</systemitem> field is optional
for all types of actions. This field specifies the current working directory
to be used when the execution string is invoked. Valid values include any
absolute pathname. If this field is not specified, the current working directory
for the execution string is determined by the following:</para>
<itemizedlist>
<!-- merged from xo+cde-->
<listitem><para>If the application invoking the action specifies a current
working directory, that directory is used.</para>
</listitem><listitem><para>If arguments are supplied to the action and the
first argument is a directory, that directory is used.</para>
</listitem><listitem><para>If arguments are supplied to the action and the
first argument is a file, the directory where the file is located is used.
</para>
</listitem><listitem><para>The current working directory of the application
invoking the action is used.</para>
</listitem></itemizedlist>
<para>Keywords are not evaluated in the <systemitem class="Constant">CWD</systemitem>
field.</para>
</refsect2>
<refsect2>
<title>DESCRIPTION Field</title>
<para>The <systemitem class="Constant">DESCRIPTION</systemitem> field is optional
for <systemitem class="Constant">COMMAND</systemitem> actions. This field
specifies a textual description of the action that is suitable for presentation
to a user requesting information about the action. The description should
contain no formatting information such as tab or newline characters. The application
that presents the information to the user formats the information.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">DESCRIPTION</systemitem> field. There is no default value for the <systemitem class="Constant">DESCRIPTION</systemitem> field.</para>
</refsect2>
<refsect2>
<title>EXEC_HOST Field</title>
<para>The <systemitem class="Constant">EXEC_HOST</systemitem> field is optional
for <systemitem class="Constant">COMMAND</systemitem> actions. This field
specifies the host where the execution string should be invoked. Valid values
for this field include actual hostnames, as well as any of the hostname keywords.
If a comma-separated list of hostnames is provided, execution is attempted
on each of the hosts in the order specified until execution succeeds.</para>
<para>Keywords are evaluated in the <systemitem class="Constant">EXEC_HOST</systemitem> field. The default value of the <systemitem class="Constant">EXEC_HOST</systemitem> field is <literal>%DatabaseHost%,%LocalHost%</literal>.
(See the description of the <literal>ExecutionHosts</literal> resource for
information on how to change this default value.)</para>
</refsect2>
<refsect2>
<title>EXEC_STRING Field</title>
<para>The <systemitem class="Constant">EXEC_STRING</systemitem> field is required
for <systemitem class="Constant">COMMAND</systemitem> actions. This field
specifies an execution string to be invoked. The string is parsed using the
same quoting rules as defined by <command>sh</command>(1); however, the execution
string is not automatically passed to any shell. Therefore, if the execution
string requires shell features such as redirection of standard input, redirection
of standard output, or pipes, the appropriate shell must be specified explicitly
in the execution string. For example:</para>
<informalexample remap="indent">
<programlisting>EXEC_STRING sh &minus;c 'ls &minus;l | more'</programlisting>
</informalexample>
<para>Keywords are evaluated in the <systemitem class="Constant">EXEC_STRING</systemitem> field. There is no default value for the <systemitem class="Constant">EXEC_STRING</systemitem> field.</para>
</refsect2>
<refsect2>
<title>ICON Field</title>
<para>The <systemitem class="Constant">ICON</systemitem> field is optional
for all types of actions. This field specifies the name of an icon that represents
the action. <!--(In &bsol;*(XZ, the file management and front panel
services show actions as icons.
Icons inform the user of what
actions are available and serve as drop sites as part of
drag-and-drop operations.)
--></para>
<para>Icons are found by using the standard &str-XZ; icon search path, so
the value can be either an absolute pathname (for example, <Filename>/foo/icons/myicon.bm</Filename>), a relative pathname (for example, <literal>icons/myicon.bm</literal>)
or a partial filename (for example, <literal>myicon</literal>). Partial filenames
are preferred because they allow the &str-XZ; icon search path to find the
icon with the optimum size and depth for the current environment.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">ICON</systemitem> field. The default value of the <systemitem class="Constant">ICON</systemitem> field is <literal>Dtactn</literal>. (See the description
of the <literal>ActionIcon</literal> resource for information on how to change
this default value.)</para>
</refsect2>
<refsect2>
<title>LABEL Field</title>
<para>The <systemitem class="Constant">LABEL</systemitem> field is optional
for all types of actions. This field specifies a user-visible label for the
action. When actions are presented to the user, the localized <systemitem class="Constant">LABEL</systemitem> field is used to identify the action instead
of the non-localized action name.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">LABEL</systemitem> field. The default value of the <systemitem class="Constant">LABEL</systemitem> field is the name of the action.</para>
</refsect2>
<refsect2>
<title>MAP_ACTION Field</title>
<para>The <systemitem class="Constant">MAP_ACTION</systemitem> field is required
for <systemitem class="Constant">MAP</systemitem> actions. This field specifies
the name of an action that should be invoked in place of the current action.
The specified action is invoked with the same set of arguments that were passed
to the original action.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">MAP_ACTION</systemitem> field. There is no default value for the <systemitem class="Constant">MAP_ACTION</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TERM_OPTS Field</title>
<para>The <systemitem class="Constant">TERM_OPTS</systemitem> field is optional
for <systemitem class="Constant">COMMAND</systemitem> actions. This field
specifies command-line options that are passed to the terminal emulator for
all <systemitem class="Constant">COMMAND</systemitem> actions that are terminal
based. (That is, any <systemitem class="Constant">COMMAND</systemitem> action
other than those that specify <systemitem class="Constant">WINDOW_TYPE</systemitem> <systemitem class="Constant">NO_STDIO</systemitem>.) These command-line options are typically
used to specify a unique terminal-window geometry, font, color or title.</para>
<para>The value of the <systemitem class="Constant">TERM_OPTS</systemitem>
field must be an option string in a form the terminal emulator supports and
it must only affect the appearance of the terminal window. For example, options
such as <literal>&minus;e</literal>, which affect the behavior of the terminal
window, must not be used.</para>
<para>Keywords are evaluated in the <systemitem class="Constant">TERM_OPTS</systemitem> field. The default value of the <systemitem class="Constant">TERM_OPTS</systemitem> field is</para>
<informalexample remap="indent">
<programlisting>&minus;title action_label</programlisting>
</informalexample>
<para>where <emphasis>action_label</emphasis> is the <systemitem class="Constant">LABEL</systemitem> field for the action. See &cdeman.dtterm; (or <command>xterm</command>(1)) for the meaning of <literal>&minus;title</literal>.</para>
</refsect2>
<refsect2>
<title>TT_ARGn_MODE Field</title>
<para>The <systemitem class="Constant">TT_ARGn_MODE</systemitem> field is
optional for <systemitem class="Constant">TT_MSG</systemitem> actions. This
field specifies the value of the ToolTalk mode attribute for the <symbol role="Variable">n</symbol>th message argument, where <symbol role="Variable">n</symbol> is
zero for the first message argument. The valid values for this field are: <systemitem class="Constant">TT_IN</systemitem>, <systemitem class="Constant">TT_INOUT</systemitem> and <systemitem class="Constant">TT_OUT</systemitem>.</para>
<para>(See <filename role="Header">Tt/tt_c.h</filename> for a description
of these values.)</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">TT_ARGn_MODE</systemitem> field. There is no default value for the <systemitem class="Constant">TT_ARGn_MODE</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TT_ARGn_REP_TYPE Field</title>
<para>The <systemitem class="Constant">TT_ARGn_REP_TYPE</systemitem> field
is optional for <systemitem class="Constant">TT_MSG</systemitem> actions.
This field specifies the representation type of the <symbol role="Variable">n</symbol>th ToolTalk message argument, where <symbol role="Variable">n</symbol>
is zero for the first message argument. The valid values for this field are:
</para>
<variablelist>
<varlistentry><term>TT_REP_UNDEFINED</term>
<listitem>
<para>If <systemitem class="Constant">TT_ARGn_VALUE</systemitem> references
a buffer argument, the representation type is a buffer; otherwise, it is a
string.</para>
</listitem>
</varlistentry>
<varlistentry><term>TT_REP_INTEGER</term>
<listitem>
<para>The representation type is an integer.</para>
</listitem>
</varlistentry>
<varlistentry><term>TT_REP_BUFFER</term>
<listitem>
<para>The representation type is a buffer.</para>
</listitem>
</varlistentry>
<varlistentry><term>TT_REP_STRING</term>
<listitem>
<para>The representation type is string.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">TT_ARGn_REP_TYPE</systemitem> field. The default value of the <systemitem class="Constant">TT_ARGn_REP_TYPE</systemitem> field is <systemitem class="Constant">TT_REP_UNDEFINED</systemitem>.</para>
</refsect2>
<refsect2>
<title>TT_ARGn_VALUE Field</title>
<para>The <systemitem class="Constant">TT_ARGn_VALUE</systemitem> field is
optional for <systemitem class="Constant">TT_MSG</systemitem> actions. If
there is no corresponding <systemitem class="Constant">TT_ARGn_MODE</systemitem>
field, the <systemitem class="Constant">TT_ARGn_VALUE</systemitem> field is
ignored. If there is a <systemitem class="Constant">TT_ARGn_MODE</systemitem>
field, the <systemitem class="Constant">TT_ARGn_VALUE</systemitem> field specifies
the value of the <symbol role="Variable">n</symbol>th ToolTalk message argument,
where <symbol role="Variable">n</symbol> is zero for the first message argument.
If there is a <systemitem class="Constant">TT_ARGn_MODE</systemitem> field
with no corresponding <systemitem class="Constant">TT_ARGn_VALUE</systemitem>
field, the value of the <symbol role="Variable">n</symbol>th ToolTalk message
argument is set to <systemitem class="Constant">NULL</systemitem>.</para>
<para>The value of the <systemitem class="Constant">TT_ARGn_VALUE</systemitem>
field must be a single string or action argument. Keywords that reference
a single action argument are evaluated in the <systemitem class="Constant">TT_ARGn_VALUE</systemitem> field, however %Args% is not allowed as it references
multiple action arguments. There is no default value for the <systemitem class="Constant">TT_ARGn_VALUE</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TT_ARGn_VTYPE Field</title>
<para>The <systemitem class="Constant">TT_ARGn_VTYPE</systemitem> field is
required to accompany any <systemitem class="Constant">TT_ARGn_MODE</systemitem>
fields in <systemitem class="Constant">TT_MSG</systemitem> actions. This field
specifies the value of the ToolTalk vtype attribute of the <symbol role="Variable">n</symbol>th message argument, where <symbol role="Variable">n</symbol> is
zero for the first message argument. If this field references an argument
keyword, the <emphasis>MEDIA</emphasis> attribute of the specified argument
is used. If the <emphasis>MEDIA</emphasis> attribute is not defined, the <systemitem class="Constant">DATA_ATTRIBUTE</systemitem> name of the data type is used.
</para>
<para>Keywords are evaluated in the <systemitem class="Constant">TT_ARGn_VTYPE</systemitem> field. There is no default value for the <systemitem class="Constant">TT_ARGn_VTYPE</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TT_CLASS Field</title>
<para>The <systemitem class="Constant">TT_CLASS</systemitem> field is required
for <systemitem class="Constant">TT_MSG</systemitem> actions. This field specifies
the value of the ToolTalk class message field. The valid values for this field
are:</para>
<variablelist>
<varlistentry><term>TT_NOTICE</term>
<listitem>
<para>The action defines a ToolTalk notification message.</para>
</listitem>
</varlistentry>
<varlistentry><term>TT_REQUEST</term>
<listitem>
<para>The action defines a ToolTalk request message.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">TT_CLASS</systemitem> field. There is no default value for the <systemitem class="Constant">TT_CLASS</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TT_FILE Field</title>
<para>The <systemitem class="Constant">TT_FILE</systemitem> field is optional
for <systemitem class="Constant">TT_MSG</systemitem> actions. This field specifies
the value of the ToolTalk file message field. The value of this field must
be a single file name and can either be a specific file name (for example, <Filename>/tmp/foo</Filename>) or an argument keyword (for example, %Arg_<emphasis>1</emphasis>%). %Args% is not allowed because it references multiple action
arguments. If an argument keyword is specified and the corresponding argument
is not a file (that is, it is a buffer), the action invocation fails.</para>
<para>Keywords are evaluated in the <systemitem class="Constant">TT_FILE</systemitem>
field. There is no default value for the <systemitem class="Constant">TT_FILE</systemitem> field; if it is not set, the file attribute of the ToolTalk
message is set to <systemitem class="Constant">NULL</systemitem>.</para>
</refsect2>
<refsect2>
<title>TT_OPERATION Field</title>
<para>The <systemitem class="Constant">TT_OPERATION</systemitem> field is
required for <systemitem class="Constant">TT_MSG</systemitem> actions. This
field specifies the value of the ToolTalk operation message field. Typical
values are operations such as <symbol role="Message">Display</symbol> or
<symbol role="Message">Edit</symbol> that are defined by the Media Exchange Message
Set.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">TT_OPERATION</systemitem> field. There is no default value for the <systemitem class="Constant">TT_OPERATION</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TT_SCOPE Field</title>
<para>The <systemitem class="Constant">TT_SCOPE</systemitem> field is required
for <systemitem class="Constant">TT_MSG</systemitem> actions. This field specifies
the value of the ToolTalk scope message field. (See <filename role="Header">Tt/tt_c.h</filename> for a description of these values.) The valid values
for this field are: <systemitem class="Constant">TT_BOTH</systemitem>, <systemitem class="Constant">TT_FILE</systemitem>, <systemitem class="Constant">TT_FILE_IN_SESSION</systemitem> and <systemitem class="Constant">TT_SESSION</systemitem>.</para>
<para>Keywords are not evaluated in the <systemitem class="Constant">TT_SCOPE</systemitem> field. There is no default value for the <systemitem class="Constant">TT_SCOPE</systemitem> field.</para>
</refsect2>
<refsect2>
<title>TYPE Field</title>
<para>The <systemitem class="Constant">TYPE</systemitem> field is optional
for <systemitem class="Constant">COMMAND</systemitem> actions and required
for <systemitem class="Constant">MAP</systemitem> or <systemitem class="Constant">TT_MSG</systemitem> actions. This field specifies the type of behavior defined
by the action. Valid values for this field are:</para>
<variablelist>
<varlistentry><term>COMMAND</term>
<listitem>
<para>The action invokes a command.</para>
</listitem>
</varlistentry>
<varlistentry><term>MAP</term>
<listitem>
<para>The action specifies a different action name to invoke in place of the
current action.</para>
</listitem>
</varlistentry>
<varlistentry><term>TT_MSG</term>
<listitem>
<para>The action defines a ToolTalk message to be sent.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">TYPE</systemitem> field. The default value of the <systemitem class="Constant">TYPE</systemitem> field is <systemitem class="Constant">COMMAND</systemitem>.
</para>
</refsect2>
<refsect2>
<title>WINDOW_TYPE Field</title>
<para>The <systemitem class="Constant">WINDOW_TYPE</systemitem> field is optional
for <systemitem class="Constant">COMMAND</systemitem> actions. This field
specifies the type of windowing support the execution string requires. Valid
values for this field are:</para>
<variablelist>
<varlistentry><term>NO_STDIO</term>
<listitem>
<para>No windowing support is required. This value is appropriate for execution
strings that have no output or are X Windows applications.</para>
</listitem>
</varlistentry>
<varlistentry><term>PERM_TERMINAL</term>
<listitem>
<para>The execution string requires a terminal window. When the execution
string exits, the terminal window is left open until the user explicitly closes
it. This value is appropriate for applications that write their output to
standard output and then terminate, such as <command>ls</command>(1).</para>
</listitem>
</varlistentry>
<varlistentry><term>TERMINAL</term>
<listitem>
<para>The execution string requires a terminal window. When the execution
string exits, the terminal window is closed. If the execution string exits
``quickly'' (see the description of the <literal>waitTime</literal> resource),
the terminal window is left open to allow the user to view any error messages
that were written to standard output or standard error. This value is appropriate
for full-screen terminal applications such as the <command>vi</command>(1) editor.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>Keywords are not evaluated in the <systemitem class="Constant">WINDOW_TYPE</systemitem> field. The default value of the <systemitem class="Constant">WINDOW_TYPE</systemitem> field is <systemitem class="Constant">PERM_TERMINAL</systemitem>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>The following resources are available to control the behavior of actions.
These resources must be set for the application that is invoking the action.
They can be set for all applications that invoke actions by omitting the application
name or class name.</para>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.19in">
<colspec align="left" colname="col1" colwidth="2.00in">
<colspec align="left" colwidth="2.01in">
<colspec align="left" colwidth="0.94in">
<colspec align="left" colname="col4" colwidth="2.80in">
<spanspec nameend="col4" namest="col1" spanname="1to4">
<tbody>
<row>
<entry align="left" spanname="1to4" valign="top"><literal>X11 Resources That
Modify Action Behavior</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Name</literal></entry>
<entry align="left" valign="top"><literal>Class</literal></entry>
<entry align="left" valign="top"><literal>Type</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>actionIcon</literal></entry>
<entry align="left" valign="top"><literal>ActionIcon</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``Dtactn''</entry></row>
<row>
<entry align="left" valign="top"><literal>dtEnvMapForRemote</literal></entry>
<entry align="left" valign="top"><literal>DtEnvMapForRemote</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``DTAPPSEARCHPATH:DTHELPSEARCHPATH:DTDATABASESEARCHPATH:XMICONSEARCHPATH:XMICONBMSEARCHPATH''</entry></row>
<row>
<entry align="left" valign="top"><literal>dtexecPath</literal></entry>
<entry align="left" valign="top"><literal>DtexecPath</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``/usr/dt/bin/dtexec''</entry></row>
<row>
<entry align="left" valign="top"><literal>dtTmpDir</literal></entry>
<entry align="left" valign="top"><literal>DtTempDir</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``$HOME/.dt/tmp''</entry></row>
<row>
<entry align="left" valign="top"><literal>executionHostLogging</literal></entry>
<entry align="left" valign="top"><literal>ExecutionHostLogging</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``False''</entry></row>
<row>
<entry align="left" valign="top"><literal>executionHosts</literal></entry>
<entry align="left" valign="top"><literal>ExecutionHosts</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``%DatabaseHost%, %LocalHost%''</entry></row>
<row>
<entry align="left" valign="top"><literal>localTerminal</literal></entry>
<entry align="left" valign="top"><literal>LocalTerminal</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">``dtterm''</entry></row>
<row>
<entry align="left" valign="top"><literal>remoteTerminals</literal></entry>
<entry align="left" valign="top"><literal>RemoteTerminals</literal></entry>
<entry align="left" valign="top"><literal>string</literal></entry>
<entry align="left" valign="top">None</entry></row>
<row>
<entry align="left" valign="top"><literal>waitTime</literal></entry>
<entry align="left" valign="top"><literal>WaitTime</literal></entry>
<entry align="left" valign="top"><literal>number</literal></entry>
<entry align="left" valign="top">3</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><literal>actionIcon</literal></term>
<listitem>
<para>Specifies the default value of the <systemitem class="Constant">ICON</systemitem> field for actions that do not define the field. The default
value of this resource is <literal>Dtactn</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>dtEnvMapForRemote</literal></term>
<listitem>
<para>Specifies a colon-separated list of environment variables names. Each
variable contains a colon-separated list of pathnames to be mapped for remote
actions (see &cdeman.tt.file.netfile; and &cdeman.tt.netfile.file;</para>
<para>Only environment variables in the user's current environment (see <emphasis>environ</emphasis>(5)) are mapped. Supplemental environment variables such
as those added by &cdeman.dtspcdenv;, for example, are not
mapped.</para>
<para>If a pathname contains substitution characters, only the portion of
the path up to the first percent character is mapped, with the remaining portion
appended to the resulting mapped portion. For example, if <systemitem class="EnvironVar">NLSPATH</systemitem> is set to <literal>/system/nlslib/%L/%N.cat</literal>,
it maps to <literal>/net/host/system/nlslib/%L/%N.cat</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>dtexecPath</literal></term>
<listitem>
<para>Specifies the location of the &cdeman.dtexec; command that
is used for terminal-based actions. The default value is <Filename>/usr/dt/bin/dtexec</Filename>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>dtTmpDir</literal></term>
<listitem>
<para>Specifies the full pathname of the directory to be used for holding
temporary files created during action invocation. The directory must be visible
to remote hosts used for action execution.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>executionHostLogging</literal></term>
<listitem>
<para>Turns on and off detailed logging to the user's <Filename>$HOME/.dt/errorlog</Filename> of action invocation events. The default value is False, which
disables logging. Logging is enabled if this resource is set to True.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>executionHosts</literal></term>
<listitem>
<para>Specifies the default value of the <systemitem class="Constant">EXEC_HOST</systemitem> field for <systemitem class="Constant">COMMAND</systemitem>
actions that do not define the field. The default value is <literal>%DatabaseHost%,%LocalHost%</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>localTerminal</literal></term>
<listitem>
<para>Specifies an alternative terminal emulator for terminal-based actions
that execute locally. Any terminal emulator specified by this resource must
support the <literal>&minus;title</literal> and <literal>&minus;e</literal>
options as described in &cdeman.dtterm;. The default value is &cdeman.dtterm;.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>remoteTerminals</literal></term>
<listitem>
<para>Specifies the terminal emulator to use for terminal-based actions that
execute on the named system. The value of this resource is a comma-separated
list of the form <symbol role="Variable">host</symbol>:<emphasis>terminal-path</emphasis> where <emphasis>terminal-path</emphasis> is the terminal emulator
used when invoking terminal-based actions on <symbol role="Variable">host</symbol>
host. The default terminal emulator used for any host not specified
by this resource is the emulator specified by the <systemitem class="Constant">localTerminal</systemitem> resource.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>waitTime</literal></term>
<listitem>
<para>Specifies the time threshold used for <systemitem class="Constant">COMMAND</systemitem> actions that specify <systemitem class="Constant">WINDOW_TYPE</systemitem> <systemitem class="Constant">TERMINAL</systemitem>. If the command
exits in less than <emphasis>waitTime</emphasis> seconds, the terminal window
is left open. The default value is 3.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>The following action is defined to pipe its argument through the <command>pr</command>(1) and <command>lp</command>(1) commands:</para>
<informalexample remap="indent">
<programlisting>ACTION PrintText
{
ICON printer
DESCRIPTION Paginate and print a text file to the \
default printer.
ARG_TYPE Text
TYPE COMMAND
EXEC_STRING sh &minus;c 'pr %Arg_1"File to print:"% | lp'
WINDOW_TYPE NO_STDIO
}</programlisting>
</informalexample>
<para>The following action defines that <emphasis>Open</emphasis> on Text
files use the EditText action:</para>
<informalexample remap="indent">
<programlisting>ACTION Open
{
ARG_TYPE Text
TYPE MAP
MAP_ACTION EditText
}</programlisting>
</informalexample>
<para>The following action is defined to send the ToolTalk Display request
message for non-writable objects:</para>
<informalexample remap="indent">
<programlisting>ACTION Display
{
ARG_CLASS BUFFER
ARG_MODE !w
TYPE TT_MSG
TT_CLASS TT_REQUEST
TT_SCOPE TT_SESSION
TT_OPERATION Display
TT_ARG0_MODE TT_IN
TT_ARG0_VTYPE %Arg_1%
TT_ARG0_VALUE %Arg_1%
}</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>APPLICATION USAGE</title>
<para>Errors encountered when loading database files are written to the user's <Filename>$HOME/.dt/errorlog</Filename>. Errors encountered in the value of an action
field cause the field to be rejected. If the field is a required field, the
entire action definition is rejected. Errors encountered when an action is
invoked cause an error dialog to be displayed to the user.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><filename role="Header">Tt/tt_c.h,</filename> &cdeman.dtdtfile;, &cdeman.dtdtsfile;, &cdeman.DtActionInvoke;, &cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.dtterm;.
</para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000075778>

97
cde/doc/C/guides/man/man4/dtbmfile.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: dtbmfile.sgm /main/6 1996/09/08 20:17:12 rws $ -->
<!-- (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.MAN78.rsml.1">
<RefMeta>
<RefEntryTitle>dtbmfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtbmfile</Filename></RefName>
<RefPurpose>format of X11 bitmap format desktop icon files
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis> #define <Symbol Role="Variable">name</Symbol>_width <Symbol Role="Variable">width</Symbol>
#define <Symbol Role="Variable">name</Symbol>_height <Symbol Role="Variable">height</Symbol>
#define <Symbol Role="Variable">name</Symbol>_x_hot <Symbol Role="Variable">x</Symbol>
#define <Symbol Role="Variable">name</Symbol>_y_hot <Symbol Role="Variable">y</Symbol>
static unsigned char <Symbol Role="Variable">name</Symbol>_bits[] = {0x<Emphasis>N</Emphasis>,...}
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>X Bitmap (XBM) files are used for monochrome icons in the CDE.
XBM icons specify background and foreground
color only.
They would be black and white on a black and white
display.
On a color display, they could be any two colors.
XBM files are not used exclusively for black and white icons.
The CDE icon editor component can be used to create or modify a
bitmap icon.
A bitmap file is an ASCII file, but because the data is
simply a binary representation of the icon, it is not realistic
to edit this file by hand.
X Bitmap files can be included directly
in C source code, so the file data is in the form of a bitmap
structure variable.
X version 11 bitmap file format is the only icon file format
officially supported as part of the X Window System at this time.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is an example of a bitmap file named <Literal>julie.bm</Literal>:
</Para>
<InformalExample Remap="indent">
<ProgramListing>#define julie.bm_width 18
#define julie.bm_height 22
#define julie.bm_x_hot 0
#define julie.bm_y_hot 0
static char julie.bm_bits[] = {
0xff, 0xff, 0x03, 0x81, 0xc3, 0x02,
0xf1, 0x98, 0x03, 0x19, 0x18, 0x02,
0x05, 0x59, 0x02, 0x07, 0xdb, 0x02,
0x01, 0xdb, 0x02, 0x01, 0xdb, 0x02,
0x01, 0xdb, 0x02, 0x01, 0xdf, 0x02,
0x01, 0xff, 0x02, 0x01, 0xfe, 0x02,
0x01, 0x7c, 0x02, 0x01, 0x38, 0x02,
0x01, 0x38, 0x02, 0x01, 0x38, 0x02,
0x01, 0x38, 0x02, 0x01, 0x3f, 0x02,
0xe1, 0x33, 0x02, 0xb9, 0x31, 0x02,
0xcf, 0x1c, 0x02, 0xff, 0xff, 0x03};
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>For a description of icon location, usage, design, etc. within the
CDE, refer to &cdeman.dticonfile;.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Literal>X11</Literal>Window<Literal>System</Literal>documentation, &cdeman.dtpmfile;, &cdeman.dticonfile;, &cdeman.dticon;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

33
cde/doc/C/guides/man/man4/dtcm_arc.sgm Normal file
View File

@@ -0,0 +1,33 @@
<!-- $XConsortium: dtcm_arc.sgm /main/2 1995/08/20 22:40:28 rws $ -->
<!-- (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.MAN91.rsml.1">
<RefMeta>
<RefEntryTitle>dtcm_archive</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtcm_archive</Filename></RefName>
<RefPurpose>format of calendar archive file
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The calendar archive file format is not documented
in the &str-XZ; 1.0 Sample Implementation (because there
is no API offered to read or write it).
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

202
cde/doc/C/guides/man/man4/dtcm_ent.sgm Normal file
View File

@@ -0,0 +1,202 @@
<!-- $XConsortium: dtcm_ent.sgm /main/6 1996/09/08 20:17:21 rws $ -->
<!-- (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.MAN92.rsml.1">
<refmeta><refentrytitle>dtcm_entry</refentrytitle><manvolnum>special file
</manvolnum></refmeta>
<refnamediv><refname><filename>dtcm_entry</filename></refname><refpurpose>
format of calendar/appointment entry</refpurpose></refnamediv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<refsect1>
<title>DESCRIPTION</title>
<para>The calendar entry file format defines how one entry is saved to a file
or used in a drag-and-drop transaction with another client. A grammar for
the entry format is:</para>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.02in">
<colspec align="left" colwidth="170*">
<colspec align="left" colwidth="78*">
<colspec align="left" colwidth="248*">
<tbody>
<row>
<entry align="left" valign="top"><computeroutput>appt_file</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>header_string</computeroutput> <computeroutput>entry_definition</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\n\n\t**Calendar Appointment
**\n'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>entry_definition</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>appt_def</computeroutput>
`\n' <computeroutput>old_appt</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>old_appt;</computeroutput></entry>
</row>
<row>
<entry align="left" valign="top"><computeroutput>old_appt</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>date_mark start_mark end_mark
repeat_mark</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>duration_mark text_mark</computeroutput></entry>
</row>
<row>
<entry align="left" valign="top"><computeroutput>date_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tDate: '</computeroutput> <computeroutput>date_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>date_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">Date as <symbol role="Variable">mm</symbol>/ <emphasis>dd</emphasis>/ <emphasis>yyyy</emphasis></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>start_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tStart: '</computeroutput> <computeroutput>start_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>start_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">Entry begin time as <emphasis>hh</emphasis>:<symbol role="Variable">mm</symbol><literal>[</literal><emphasis>ampm</emphasis> <literal>]</literal>, where <emphasis>hh</emphasis> and <symbol role="Variable">mm</symbol>
represent two-digit hours and minutes and the optional <emphasis>ampm</emphasis> suffix is the string <literal>am</literal> or <literal>pm</literal></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>end_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tEnd: '</computeroutput> <computeroutput>end_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>end_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">Entry begin time as <emphasis>hh</emphasis>:<symbol role="Variable">mm</symbol><literal>[</literal><emphasis>ampm</emphasis> <literal>]</literal></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>repeat_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tRepeat: '</computeroutput> <computeroutput>repeat_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>repeat_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`One Time' | `Daily' | `Weekly'
| `Every Two Weeks'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`Monthly By Date' | `Yearly'
| `Monthly By Weekday'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`Monday Thru Friday' | `Mon,
Wed, Fri' | `Tuesday, Thursday'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>duration_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tFor: '</computeroutput> <computeroutput>duration_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>duration_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">Integer that describes the number of repetitions.</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>text_mark</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`\tWhat: '</computeroutput> <computeroutput>text_value</computeroutput></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>text_value</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">Up to 5 lines of text. Each line after the
first must have a leading <keysym>tab</keysym> character.</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>appt_def</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>appt_start_marker</computeroutput> <computeroutput>attr_list</computeroutput> <computeroutput>appt_end_marker</computeroutput></entry>
</row>
<row>
<entry align="left" valign="top"><computeroutput>attr_list</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>attr_def</computeroutput> <computeroutput>att_list</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>attr_def</computeroutput></entry>
</row>
<row>
<entry align="left" valign="top"><computeroutput>appt_start_marker</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>appt_marker</computeroutput>
`:string:begin\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>appt_end_marker</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>appt_marker</computeroutput>
`:string:end\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>appt_marker</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML
ApptDelimiter//EN'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>attr_def</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>attr_name</computeroutput>
`:' <computeroutput>attr_type</computeroutput> `:' <computeroutput>attr_value</computeroutput> `\n'</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>attr_type</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`string' | `integer' | `reminder'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><computeroutput>|</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>`accesslist' | `repeatdefinition'
| `custom'</computeroutput></entry></row>
<row>
<entry align="left" valign="top"><computeroutput>attr_name</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>::=</computeroutput></entry>
<entry align="left" valign="top">XAPIA string. The span of characters that
can be used in the definition of an attribute name is specified in the &str-Za;.</entry></row></tbody></tgroup><?Pub Caret></informaltable>
<para>An example entry:</para>
<informalexample>
<programlisting> ** Calendar Appointment **
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML ApptDelimiter//EN:string:begin
-//XAPIA/CS/API/ENTRYATTR//NONSGML Start Date//EN:integer:775148400
-//XAPIA/CS/API/ENTRYATTR//NONSGML End Date//EN:integer:775148900
-//XAPIA/CS/API/ENTRYATTR//NONSGML Type//EN:string:CSA_TYPE_EVENT
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML Showtime//EN:integer:1
-//XAPIA/CS/API/ENTRYATTR//NONSGML Summary//EN:string:Foundation planning meeting
in Hari's office
-//XAPIA/CS/API/ENTRYATTR//NONSGML Status//EN:integer:0
-//XAPIA/CS/API/ENTRYATTR//NONSGML Recurrence Rule//EN:string:M60 #12
-//XAPIA/CS/API/ENTRYATTR//NONSGML Audio Reminder//EN:reminder:-60:
-//XAPIA/CS/API/ENTRYATTR//NONSGML Flashing Reminder//EN:reminder:-60:
-//XAPIA/CS/API/ENTRYATTR//NONSGML Mail Reminder//EN:reminder:-1800:hseldon@trantor
-//XAPIA/CS/API/ENTRYATTR//NONSGML Popup Reminder//EN:reminder:300:
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML ApptDelimiter//EN:string:end
Date: 7/25/1994
Start: 8:00am
End: 9:00am
Repeat: Every Two Weeks, last
For:26
What: Foundation planning meeting
in Hari's office</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.csa.csa.h;, &cdeman.csa.add.entry;, &cdeman.csa.call.callbacks;, &cdeman.csa.delete.calendar;, &cdeman.csa.delete.entry;, &cdeman.csa.free;, &cdeman.csa.free.time.search;, &cdeman.csa.list.calendar.attributes;, &cdeman.csa.list.calendars;, &cdeman.csa.list.entries;, &cdeman.csa.list.entry.attributes;, &cdeman.csa.list.entry.sequence;, &cdeman.csa.logoff;, &cdeman.csa.logon;, &cdeman.csa.look.up;, &cdeman.csa.query.configuration;, &cdeman.csa.read.calendar.attributes;, &cdeman.csa.read.entry.attributes;, &cdeman.csa.read.next.reminder;, &cdeman.csa.register.callback;, &cdeman.csa.unregister.callback;, &cdeman.csa.update.calendar.attributes;, &cdeman.csa.update.entry.attributes;.</para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000041703>

109
cde/doc/C/guides/man/man4/dtdpfile.sgm Normal file
View File

@@ -0,0 +1,109 @@
<!-- $XConsortium: dtdpfile.sgm /main/6 1996/09/08 20:17:29 rws $ -->
<!-- (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.MAN79.rsml.1">
<RefMeta>
<RefEntryTitle>dtdpfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtdpfile</Filename></RefName>
<RefPurpose>format and location of desktop palette files
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>#<Emphasis>color 1 background RBG data
#</Emphasis><Emphasis>color 2 background RBG data
#</Emphasis><Emphasis>color 3 background RBG data
#</Emphasis><Emphasis>color 4 background RBG data
#</Emphasis><Emphasis>color 5 background RBG data
#</Emphasis><Emphasis>color 6 background RBG data
#</Emphasis><Emphasis>color 7 background RBG data
#</Emphasis><Emphasis>color 7 background RBG data</Emphasis></Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>A palette is a color scheme used to color a CDE
workspace and the CDE components.
</Para>
<Para>A <Literal>palette</Literal> file provides the set of eight background colors that
make up a color palette.
</Para>
<Para>A variety of palettes are provided with the CDE.
As part of the default palette set there are several palettes designed
specifically to work well on monochrome and gray scale displays.
</Para>
<Para>The <Emphasis>Style Manager</Emphasis> is the desktop graphical user interface tool
which is used to add, delete, or modify a color palette.
The end user should never need to act on the palette file directly.
</Para>
<Para>All palette files have a <Filename>.dp</Filename> suffix.
The file contents are the
eight colors of the palette, specified as RGB values in hexadecimal.
</Para>
<Para>The palette files provided with the system are located in the directory
<Filename>/usr/dt/palettes/C</Filename>.
</Para>
<Para>User specific palette files are located in <SystemItem Class="EnvironVar">HOME</SystemItem><Filename>/.dt/palettes</Filename>.
</Para>
<Para>The <Emphasis>Style Manager</Emphasis> resource <Literal>paletteDirectories</Literal> can be used
to specify additional directories where palettes are located.
</Para>
<Para>When a user creates a new palette, it is located in <SystemItem Class="EnvironVar">HOME</SystemItem><Filename>/.dt/palettes</Filename>.
System palettes that the user has modified are also located in this directory.
When a user deletes a palette, that palette is placed in the
<SystemItem Class="EnvironVar">HOME</SystemItem><Filename>/.dt/palettes</Filename> directory with a <Literal>~</Literal> prefix.
If it was a user
specified palette, the original file is removed.
System palettes are never
removed.
If the user has a <Literal>~</Literal> copy of a system palette, that palette
will not appear in the list of available palettes in the <Emphasis>Style Manager</Emphasis>.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is an example of a palette file named <Literal>Julie.dp</Literal>:
</Para>
<InformalExample Remap="indent">
<ProgramListing>#a200e500c600
#3ffc93008d77
#2d2d4e4e7600
#78008900a500
#63ea7e189500
#3ec670ec8a00
#3d157d008400
#61006d098e00
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsession;, &cdeman.dtstyle;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

195
cde/doc/C/guides/man/man4/dtdtfile.sgm Normal file
View File

@@ -0,0 +1,195 @@
<!-- $XConsortium: dtdtfile.sgm /main/7 1996/09/08 20:17:38 rws $ -->
<!-- (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.MAN93.rsml.1">
<RefMeta>
<RefEntryTitle>dtdtfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtdtfile</Filename></RefName>
<RefPurpose>define the format and location of actions and data type database files
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>See
&cdeman.dtactionfile; and
&cdeman.dtdtsfile;.</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The actions and data types database provides definitions for the actions
and data types &str-XZ; clients recognize.
Files containing actions and data type definitions must end
with the
<Filename>.dt</Filename> suffix.
The database is constructed by reading
all files ending in the
<Filename>.dt</Filename> suffix that are found in the search path
specified by the
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> environment variable.
</Para>
<Para>The
&cdeman.dttypes; utility is the tool that allows users to examine and debug their database.
</Para>
<Para>The
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> environment variable contains a comma-separated
list of directories specified in <Literal>[</Literal><Symbol Role="Variable">host</Symbol><Literal>:]/</Literal><Emphasis>path</Emphasis> format.
The
<Symbol Role="Variable">host</Symbol>: portion is optional, but if specified,
<Emphasis>/path</Emphasis> is interpreted relative to
<Symbol Role="Variable">host</Symbol>. In addition,
<Symbol Role="Variable">host</Symbol> defines the
<Emphasis>DatabaseHost</Emphasis> for records defined by files in the
<Emphasis>/path</Emphasis> directory.
Otherwise, the
<Emphasis>DatabaseHost</Emphasis> is the same as the
<Emphasis>LocalHost</Emphasis>. To allow for localized action definitions, the data base
search path supports the string
<Literal>%L</Literal> within the pathname string.
The logic that parses
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> substitutes the
value of the current locale as stored in the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable for the string
<Literal>%L</Literal> (or no characters if
<SystemItem Class="EnvironVar">LANG</SystemItem> is not set).
Other uses of % within the
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> pathnames produce unspecified results.
Directories can be set up for various locales.
Each directory contains localized action definitions for a
single locale.
For examples, see the default search path shown below.
The local system administrator or the user
(in
<Filename>$HOME/.dtprofile</Filename>) can modify the actual value of the search path.
The default search path includes the following directories,
searched in the following sequence:
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>$HOME/.dt/types/</Filename></Term>
<ListItem>
<Para>personal user-defined database files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>/etc/dt/appconfig/types/%L</Literal></Term>
<ListItem>
<Para>locally defined language-specific database files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/types/C</Filename></Term>
<ListItem>
<Para>locally defined default database files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>/usr/dt/appconfig/types/%L</Literal></Term>
<ListItem>
<Para>language-specific database files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/types/C</Filename></Term>
<ListItem>
<Para>implementation-default database files
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>File Format</Title>
<Para>In addition to the version information, comments and variable references
described under other headings in this document, these files may contain action
and data type records, as described in
&cdeman.dtactionfile; and
&cdeman.dtdtsfile;.</Para>
</RefSect2>
<RefSect2>
<Title>Comments</Title>
<Para>Any line whose first non-space character is # is treated as a
comment line, and is ignored during the reading of the database file.
</Para>
</RefSect2>
<RefSect2>
<Title>Database Version</Title>
<Para>The database loader supports a version number, which indicates
the version of the database syntax used by a particular database file.
If a database version number is not specified, then the database
loader assumes that the file uses the version 1.0 syntax, described here.
If a database file specifies a version number, then it
must be the first non-blank, non-comment line in the database file;
if the version is specified anywhere else in the file, then an error
message is generated, and the remainder of that database file is ignored.
The database version number is specified using the following syntax:
</Para>
<InformalExample Remap="indent">
<ProgramListing>set DtDbVersion=<Emphasis>version_number</Emphasis>
</ProgramListing>
</InformalExample>
</RefSect2>
<RefSect2>
<Title>String Variables</Title>
<Para>Database entries can reference string variables that can be set
within the database file.
The scope of a string variable is restricted
to only those record definitions within the database file defining the
string variable.
A string variable is defined using the following syntax:
</Para>
<InformalExample Remap="indent">
<ProgramListing>set <Emphasis>VariableName</Emphasis>=<Emphasis>variable_value</Emphasis>
</ProgramListing>
</InformalExample>
<Para>String variables are referenced using either of the standard shell
variable referencing syntaxes:
$<Emphasis>variable_name</Emphasis> or ${<Emphasis>variable_name</Emphasis>}.
A variable name can be made up of any of the alphanumeric characters
and the underscore.
</Para>
</RefSect2>
<RefSect2>
<Title>Environment Variables</Title>
<Para>Database records may refer to environment variables, using either
of the standard shell variable referencing syntaxes:
$<Emphasis>environment_variable</Emphasis>
or ${<Emphasis>environment_variable</Emphasis>}.
If the environment variable name conflicts
with a string variable name, the string variable takes precedence.
</Para>
</RefSect2>
<RefSect2>
<Title>Line Continuation</Title>
<Para>Any field within a record can be continued onto another line by
ending the line with a &bsol; character.
The &bsol; and any
<KeySym>blank</KeySym>s following the &bsol; and preceding the newline are discarded;
leading
<KeySym>blank</KeySym>s on the following line are preserved in the continued field.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtactionfile;, &cdeman.dtdtsfile;, &cdeman.dttypes;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

1091
cde/doc/C/guides/man/man4/dtdtsfil.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

145
cde/doc/C/guides/man/man4/dtfile_c.sgm Normal file
View File

@@ -0,0 +1,145 @@
<!-- $XConsortium: dtfile_c.sgm /main/4 1996/09/08 20:17:58 rws $ -->
<!-- (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.MAN80.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtfile_config</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtfile_config</Filename></RefName>
<RefPurpose>CDE File Manager configuration file
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<RefSynopsisDiv>
<Synopsis><Literal># Comment
aix:3 = native
hpux:0 = native
sunos:ufs = native
end
#
native: buttonLabel = Modify extended attributes ...
warning = Warning:\nExtended attributes may limit your access
fsDialog = /local/bin/modExtAttr
dismiss = yes</Literal></Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The File Manager properties dialog can be used to change Unix file
attributes. It can also be configured to allow editing of additional,
filesystem-specific, attributes (such as Access Control Lists in AFS
file systems). This ability is currently limited to IBM, Sun, and HP
systems.
</Para>
<Para>Whenever the properties dialog is invoked, File Manager identifies the
type of filesystem using platform-dependent library functions. For AIX
the st_vfstype field returned by stat is used, for HPUX the f_fsid[1]
field returned by statfs is used, and for SUNOS the f_basetype field
returned by statvfs is used. The contents of this field is combined
with the name of the system to create an identifier for the filesystem
(e.g. aix:3). File Manager reads a configuration file (see below for
file format) looking for this compound identifier. If it is not found,
no further action is taken. Any errors which occur while reading the
configuration file are logged in $HOME/.dt/errorlog.
</Para>
<Para>If found, the platform-dependent identifier is mapped to a
platform-independent form (e.g. native). For each platform-independent
identifier, the configuration file provides the name of a program which
can be used to edit filesystem-specific properties. In addition, it
give a label that is used on a button which is added to the properties
dialog. When the button is pressed, File Manager forks a process to
execute the program. While the filesystem-specific dialog appears to
the user to be part of File Manager, it is implemented as a top-level
shell and can be executed from the command line. File Manager provides
only a single argument to the program: the complete path of the file.
An option is also provided for the normal properties dialog to be
Cancelled when the file-system specific dialog is invoked. Note that
this will cause any changes made in the normal properties dialog to be
lost.
</Para>
<Para>The platform-dependent identifier can also be used to present a message
in the properties dialog. This message can appear either on its own or
in conjunction with a pushbutton and properties dialog program as
described above.
</Para>
<RefSect2>
<Title>Location of configuration file</Title>
<Para>File Manager looks in three places for the configuration file, stopping
the search once the file is found. The three locations, in search order,
are $HOME/dtfile.config (user-specific configuraton),
/etc/dt/config/dtfile.config (customized system configuration) and
/usr/dt/config/$LANG/dtfile.config (factory defaults). If none of these
is found, an error message indicating that /usr/dt/config/$LANG/dtfile.config
cannot be found is placed in $HOME/.dt/errorlog. For debugging, File
Manager will use a configuration file defined in the environment
variable DTFSCONFIG before searching any of the other locations.
</Para>
</RefSect2>
<RefSect2>
<Title>Format of configuration file</Title>
<Para>The File Manager configuration file consists of two sections. The first
section maps platform-specific information to a platform-independent
identifier. There are two fields in the platform-specific portion
separated by a colon. The first field identifies the platform: aix,
hpux, sunos. The second field depends on platform; for aix it is an
integer corresponding to the st_vfstype field returned by stat, for hpux
it is an integer corresponding to the f_fsid[1] field returned by
statfs, for sunos it is a string corresponding to the f_basetype field
returned by statvfs. The platform-independent identifier is given
following an equals sign. The keyword "end" delimits the list of
mappings. For example, to define the "native" file systems on several
platforms:
</Para>
<ProgramListing>aix:3 = native
hpux:0 = native
sunos:ufs = native
end
</ProgramListing>
<Para>The second section of the configuration file provides information needed
by File Manager to execute the filesystem-specific dialog. It consists
of a list of platform-independent identifiers followed by a colon and
several fields. Each field consists of a name followed by an equals sign
and a string. The five field names are: buttonLabel, which defines a
label for a button in the permissions dialog; fsDialog, which defines
the path to the program which displays the dialog for editing
file-specific properties; warning, which is optional and defines a
warning message to be displayed in permissions dialog; and dismiss,
which is optional, and specifies if the normal properties dialog is to
be cancelled when the file-system specific dialog is invoked. Dismiss
can be set to either "yes" or "no" and defaults to "no". "\n" can be
included in the warning text to generate a new line. Continuing the
native file system example used above, the following would enable a
file-system specific dialog generated by the program
/local/bin/modExtAttr:
</Para>
<ProgramListing>native: buttonLabel = Modify extended attributes ...
warning = Warning:\nExtended attributes may limit your access
fsDialog = /local/bin/modExtAttr
dismiss = yes
</ProgramListing>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>SEE</Title>
<Para>The factory-default configuration file,
/usr/dt/config/$LANG/dtfile.config, contains further examples. Included
are some test examples that can be enabled by removing comment
characters from the definition lines in the file. Also included are
defaults for AFS file systems which cause a warning message to be added
to the regular properties dialog, but no dialog is provided.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

853
cde/doc/C/guides/man/man4/dtfpfile.sgm Normal file
View File

@@ -0,0 +1,853 @@
<!-- $XConsortium: dtfpfile.sgm /main/8 1996/08/31 14:55:31 rws $ -->
<!-- (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.MAN95.rsml.1">
<refmeta><refentrytitle>dtfpfile</refentrytitle><manvolnum>special file</manvolnum>
</refmeta>
<refnamediv><refname><filename>dtfpfile</filename></refname><refpurpose>format
and locations of front panel configuration files</refpurpose></refnamediv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<refsynopsisdiv>
<synopsis>set DtDbVersion=<emphasis>version_number</emphasis>
set <emphasis>VariableName</emphasis>=<emphasis>variable_value</emphasis>
<emphasis>RecordType</emphasis> <emphasis>record_name</emphasis>
{
# <emphasis>Comment</emphasis>
<emphasis>Keyword</emphasis> <emphasis>Value</emphasis>
<emphasis>Keyword</emphasis> <emphasis>Value</emphasis>
...
}</synopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <literal>dtfpfile</literal> front panel database provides definitions
for the components that define the content and functionality of the front
panel. Files containing front panel definitions must end with the <Filename>.fp</Filename> suffix. Like the action and data type database, the front panel
database is constructed by reading all files ending in the <Filename>.fp</Filename>
suffix found in the search path specified by the <systemitem class="EnvironVar">DTDATABASESEARCHPATH</systemitem> environment variable.</para>
<para>See &cdeman.dtdtfile; for a complete description of the
directory locations where these database files are found and for a description
of the specific syntax for the database files.</para>
<refsect2>
<title>File Format</title>
<para>The general syntax of the front panel configuration files is as described
above in the SYNOPSIS section of this man page.</para>
<para>The <emphasis>Comments</emphasis>, <emphasis>Versions</emphasis> and <emphasis>Variables</emphasis> fields are described in &cdeman.dtdtfile;.
</para>
<para>The front panel record types each have a set of Keyword and Value pairs.
There are six record types defined: <systemitem class="Constant">PANEL</systemitem>, <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem>, <systemitem class="Constant">CONTROL</systemitem> and <systemitem class="Constant">ANIMATION</systemitem>. Each
record type has a set of keywords defined for it. Many of the keywords are
used for multiple record types.</para>
</refsect2>
<refsect2>
<title>Record Types</title>
<variablelist>
<varlistentry><term><Symbol>PANEL</Symbol> <emphasis>front panel name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">PANEL</systemitem> record type defines
the outermost container of the front panel. It can contain one or more <systemitem class="Constant">BOX</systemitem>es and optionally repositioning handles,
a menu and a minimize button. The keywords defined for <systemitem class="Constant">PANEL</systemitem> are described in the following table.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="5.93in">
<colspec align="left" colname="col1" colwidth="229*">
<colspec align="left" colwidth="159*">
<colspec align="left" colname="col3" colwidth="101*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>PANEL Record Type
Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">CONTROL_BEHAVIOR</entry>
<entry align="left" valign="top">(<literal>double_click</literal>/ <literal>single_click</literal>)</entry>
<entry align="left" valign="top">single_click</entry></row>
<row>
<entry align="left" valign="top">DISPLAY_CONTROL_LABELS</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">DISPLAY_HANDLES</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">True</entry></row>
<row>
<entry align="left" valign="top">DISPLAY_MENU</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">True</entry></row>
<row>
<entry align="left" valign="top">DISPLAY_MINIMIZE</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">True</entry></row>
<row>
<entry align="left" valign="top">HELP_STRING</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_TOPIC</entry>
<entry align="left" valign="top"><emphasis>topic name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_VOLUME</entry>
<entry align="left" valign="top"><emphasis>volume name</emphasis></entry>
<entry align="left" valign="top">FPanel</entry></row>
<row>
<entry align="left" valign="top">LOCKED</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">PANEL_GEOMETRY</entry>
<entry align="left" valign="top">{+&minus;}<symbol role="Variable">xoffset</symbol>[{+&minus;}<symbol role="Variable">yoffset</symbol>]</entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">RESOLUTION</entry>
<entry align="left" valign="top">(<literal>high</literal>/<literal>medium</literal> /<literal>low</literal>/<literal>match_display</literal>)</entry>
<entry align="left" valign="top">match_display</entry></row>
<row>
<entry align="left" valign="top">SUBPANEL_UNPOST</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">True</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><Symbol>BOX</Symbol> <emphasis>box name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">BOX</systemitem> record type defines
a container within a <systemitem class="Constant">PANEL</systemitem> that
can hold a row of <systemitem class="Constant">CONTROLS</systemitem> and at
most one <systemitem class="Constant">SWITCH</systemitem> container. Multiple <systemitem class="Constant">BOX</systemitem>es within a <systemitem class="Constant">PANEL</systemitem> are stacked vertically. The keywords defined for <systemitem class="Constant">BOX</systemitem> are described in the following table.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="160*">
<colspec align="left" colwidth="184*">
<colspec align="left" colname="col3" colwidth="112*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>BOX Record Type
Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">CONTAINER_NAME</entry>
<entry align="left" valign="top">front panel name</entry>
<entry align="left" valign="top">NULL (required)</entry></row>
<row>
<entry align="left" valign="top">DELETE</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">HELP_STRING</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_TOPIC</entry>
<entry align="left" valign="top"><emphasis>topic name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_VOLUME</entry>
<entry align="left" valign="top"><emphasis>volume name</emphasis></entry>
<entry align="left" valign="top">FPanel</entry></row>
<row>
<entry align="left" valign="top">LOCKED</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">POSITION_HINTS</entry>
<entry align="left" valign="top">(<literal>first</literal>/<literal>last</literal>/<symbol role="Variable">integer</symbol> &ge; 1)</entry>
<entry align="left" valign="top">first</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><Symbol>SUBPANEL</Symbol> <emphasis>subpanel name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">SUBPANEL</systemitem> record type defines
a secondary container for <systemitem class="Constant">CONTROL</systemitem>s
that slide up from the front panel. <systemitem class="Constant">SUBPANEL</systemitem> s can also contain a drop zone where new controls can be dynamically
added. The keywords defined for <systemitem class="Constant">SUBPANEL</systemitem>
are described in the following table.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="166*">
<colspec align="left" colwidth="121*">
<colspec align="left" colname="col3" colwidth="169*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>SUBPANEL Record
Type Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">CONTAINER_NAME</entry>
<entry align="left" valign="top"><emphasis>control name</emphasis></entry>
<entry align="left" valign="top">NULL (required)</entry></row>
<row>
<entry align="left" valign="top">CONTROL_INSTALL</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">True</entry></row>
<row>
<entry align="left" valign="top">DELETE</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">HELP_STRING</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_TOPIC</entry>
<entry align="left" valign="top"><emphasis>topic name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_VOLUME</entry>
<entry align="left" valign="top"><emphasis>volume name</emphasis></entry>
<entry align="left" valign="top">FPanel</entry></row>
<row>
<entry align="left" valign="top">LOCKED</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">TITLE</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><Symbol>SWITCH</Symbol> <emphasis>switch name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">SWITCH</systemitem> record type defines
a container within a <systemitem class="Constant">BOX</systemitem> that contains
a set of push buttons, each of which give access to a corresponding workspace.
See &cdeman.dtwm; for a description of the multiple workspace capabilities.
Also contained within the <systemitem class="Constant">SWITCH</systemitem>
container is an optional set of <systemitem class="Constant">CONTROL</systemitem>s.
These are presented in a column on each side of the push buttons. The keywords
defined for <systemitem class="Constant">SWITCH</systemitem> are described
in the following table.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="5.93in">
<colspec align="left" colname="col1" colwidth="173*">
<colspec align="left" colwidth="177*">
<colspec align="left" colname="col3" colwidth="139*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>SWITCH Record Type
Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">CONTAINER_NAME</entry>
<entry align="left" valign="top"><emphasis>box name</emphasis></entry>
<entry align="left" valign="top">NULL (required)</entry></row>
<row>
<entry align="left" valign="top">DELETE</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">HELP_STRING</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_TOPIC</entry>
<entry align="left" valign="top"><emphasis>topic name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_VOLUME</entry>
<entry align="left" valign="top"><emphasis>volume name</emphasis></entry>
<entry align="left" valign="top">FPanel</entry></row>
<row>
<entry align="left" valign="top">LOCKED</entry>
<entry align="left" valign="top">(<systemitem class="Constant">True</systemitem>/<systemitem class="Constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">NUMBER_OF_ROWS</entry>
<entry align="left" valign="top"><symbol role="Variable">integer</symbol></entry>
<entry align="left" valign="top">2</entry></row>
<row>
<entry align="left" valign="top">POSITION_HINTS</entry>
<entry align="left" valign="top">(<literal>first</literal>/<literal>last</literal>/<symbol role="Variable">integer</symbol> &ge; 1)</entry>
<entry align="left" valign="top">first</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><Symbol>CONTROL</Symbol> <emphasis>control name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">CONTROL</systemitem> record type defines
the main functional component of the front panel. <systemitem class="Constant">CONTROL</systemitem>s typically have actions defined for them that are invoked
on selection or drag and drop or both. <systemitem class="Constant">CONTROL</systemitem> s are displayed with icons or labels or both and can have iconic
animations associated with them. The keywords defined for <systemitem class="Constant">CONTROL</systemitem> are described in the following table.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="188*">
<colspec align="left" colwidth="178*">
<colspec align="left" colname="col3" colwidth="90*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>CONTROL Record Type
Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">ALTERNATE_ICON</entry>
<entry align="left" valign="top"><emphasis>image name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">CLIENT_GEOMETRY</entry>
<entry align="left" valign="top"><symbol role="Variable">width</symbol> <literal>x</literal> <symbol role="Variable">height</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">CLIENT_NAME</entry>
<entry align="left" valign="top"><emphasis>client name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">CONTAINER_NAME</entry>
<entry align="left" valign="top">(<emphasis>box name</emphasis>/ <emphasis>switch name</emphasis>/<emphasis>subpanel name</emphasis>)</entry>
<entry align="left" valign="top">NULL (required)</entry></row>
<row>
<entry align="left" valign="top">CONTAINER_TYPE</entry>
<entry align="left" valign="top">(<Symbol>BOX</Symbol>/<Symbol>SWITCH</Symbol>/ <Symbol>SUBPANEL</Symbol>)</entry>
<entry align="left" valign="top">NULL (required)</entry></row>
<row>
<entry align="left" valign="top">DATE_FORMAT</entry>
<entry align="left" valign="top"><emphasis>format string</emphasis></entry>
<entry align="left" valign="top">%b%n%e</entry></row>
<row>
<entry align="left" valign="top">DELETE</entry>
<entry align="left" valign="top">(<systemitem class="constant">True</systemitem>/<systemitem class="constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">DROP_ACTION</entry>
<entry align="left" valign="top"><emphasis>action_name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">DROP_ANIMATION</entry>
<entry align="left" valign="top"><emphasis>animation name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">FILE_NAME</entry>
<entry align="left" valign="top"><symbol role="Variable">pathname</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_STRING</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_TOPIC</entry>
<entry align="left" valign="top"><emphasis>topic name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">HELP_VOLUME</entry>
<entry align="left" valign="top"><emphasis>volume name</emphasis></entry>
<entry align="left" valign="top">FPanel</entry></row>
<row>
<entry align="left" valign="top">ICON</entry>
<entry align="left" valign="top"><emphasis>image name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">LABEL</entry>
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">LOCKED</entry>
<entry align="left" valign="top">(<systemitem class="constant">True</systemitem>/<systemitem class="constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">MONITOR_TYPE</entry>
<entry align="left" valign="top">(<literal>none</literal>/<literal>mail</literal>/ <literal>file</literal>)</entry>
<entry align="left" valign="top">none</entry></row>
<row>
<entry align="left" valign="top">POSITION_HINTS</entry>
<entry align="left" valign="top">(<literal>first</literal>/<literal>last</literal>/<symbol role="Variable">integer</symbol> &ge; 1)</entry>
<entry align="left" valign="top">first</entry></row>
<row>
<entry align="left" valign="top">PUSH_ACTION</entry>
<entry align="left" valign="top"><emphasis>action_name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">PUSH_ANIMATION</entry>
<entry align="left" valign="top"><emphasis>animation name</emphasis></entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">PUSH_RECALL</entry>
<entry align="left" valign="top">(<systemitem class="constant">True</systemitem>/<systemitem class="constant">False</systemitem>)</entry>
<entry align="left" valign="top">False</entry></row>
<row>
<entry align="left" valign="top">TYPE</entry>
<entry align="left" valign="top">(<literal>blank</literal>/<literal>busy</literal>/ <literal>client</literal>/<literal>clock</literal>/<literal>date</literal>/ <literal>file</literal>/<literal>icon</literal>)</entry>
<entry align="left" valign="top">icon</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><Symbol>ANIMATION</Symbol> <emphasis>animation name</emphasis></term>
<listitem>
<para>The <systemitem class="Constant">ANIMATION</systemitem> record types
are a sequence of image name and time delay pairs that are displayed by a <systemitem class="Constant">CONTROL</systemitem> on a <systemitem class="Constant">PUSH_ACTION</systemitem> or <systemitem class="Constant">DROP_ACTION</systemitem>.</para>
</listitem>
</varlistentry>
</variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="123*">
<colspec align="left" colwidth="222*">
<colspec align="left" colname="col3" colwidth="111*">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<tbody>
<row>
<entry align="left" spanname="1to3" valign="top"><literal>ANIMATION Record
Type Keywords and Values</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Keyword</literal></entry>
<entry align="left" valign="top"><literal>Value</literal></entry>
<entry align="left" valign="top"><literal>Default</literal></entry></row>
<row>
<entry align="left" valign="top">ANIMATION</entry>
<entry align="left" valign="top"><emphasis>image name</emphasis> [ <emphasis>millisecond delay</emphasis>]</entry>
<entry align="left" valign="top">None [200]</entry></row></tbody></tgroup>
</informaltable>
</refsect2>
<refsect2>
<title>Keyword and Value Descriptions</title>
<para>The following list contains a description of each of the keywords defined
by the front panel.</para>
<variablelist>
<varlistentry><term>ALTERNATE_ICON</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>busy</literal> and <literal>icon</literal>.</para>
<para><systemitem class="Constant">ALTERNATE_ICON</systemitem> defines an
image to be used to replace the normal image within a control with a mail
or file value for the <systemitem class="Constant">MONITOR_TYPE</systemitem>.
The image is displayed when the file being monitored changes. For the <literal>busy</literal> control, <systemitem class="Constant">ALTERNATE_ICON</systemitem>
is cycled with <systemitem class="Constant">ICON</systemitem> to give the
blinking effect.</para>
</listitem>
</varlistentry>
<varlistentry><term>ANIMATION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">ANIMATION</systemitem>.
</para>
<para>Used with control keywords of: <systemitem class="Constant">PUSH_ANIMATION</systemitem> and <systemitem class="Constant">DROP_ANIMATION</systemitem>.
</para>
<para><systemitem class="Constant">ANIMATION</systemitem> defines a sequence
of images to be displayed for either a <systemitem class="Constant">PUSH_ACTION</systemitem> or <systemitem class="Constant">DROP_ACTION</systemitem>. Each
animation within the list is displayed in order with a default time separation
of 200 milliseconds. For a slower or faster sequence, the image name value
can be followed by the amount of time to display the image. If no time value
is specified, the previously specified value is used.</para>
</listitem>
</varlistentry>
<varlistentry><term>CLIENT_GEOMETRY</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control type of: <literal>client</literal>.</para>
<para>Used with control keywords of: <systemitem class="Constant">CLIENT_NAME</systemitem>.</para>
<para><systemitem class="Constant">CLIENT_GEOMETRY</systemitem> specifies
the size (in pixels) needed for the window of a client displayed within the
front panel.</para>
</listitem>
</varlistentry>
<varlistentry><term>CLIENT_NAME</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>client</literal> or <literal>icon</literal>.</para>
<para>Used with control keywords of: <systemitem class="Constant">PUSH_RECALL</systemitem>.</para>
<para><systemitem class="Constant">CLIENT_NAME</systemitem> specifies a name
used to associate a control with an executable. It is necessary for control
types of <literal>client</literal> (an X client running within the front panel)
and for <literal>icon</literal> when the keyword <systemitem class="Constant">PUSH_RECALL</systemitem> is True. The value <emphasis>client name</emphasis>
is the name of the executable or can be set via a command-line argument for
some clients (such as <command>xterm</command> <literal>&minus;name</literal> <emphasis>panelterm</emphasis>). The <emphasis>client name</emphasis> for a running
client can be found by executing xprop. The first string of the <systemitem class="Constant">WM_CLASS</systemitem> property is the value used.</para>
</listitem>
</varlistentry>
<varlistentry><term>CONTAINER_NAME</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">CONTAINER_NAME</systemitem> associates
a component with its parent. For example, the <systemitem class="Constant">CONTAINER_NAME</systemitem> value for a <systemitem class="Constant">SWITCH</systemitem> tells the front panel into which <systemitem class="Constant">BOX</systemitem> it should be placed. Since controls can reside in several
different component types, <systemitem class="Constant">CONTAINER_NAME</systemitem>
is used in conjunction with <systemitem class="Constant">CONTAINER_TYPE</systemitem>
to define a control's parent.</para>
</listitem>
</varlistentry>
<varlistentry><term>CONTAINER_TYPE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para><systemitem class="Constant">CONTAINER_TYPE</systemitem> defines a control's
parent type. This is used to identify a control uniquely so that it can be
created within the proper parent.</para>
</listitem>
</varlistentry>
<varlistentry><term>CONTROL_BEHAVIOR</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para><systemitem class="Constant">CONTROL_BEHAVIOR</systemitem> provides
the mechanism for setting the user model for front panel controls. Controls
can be set to invoke their <systemitem class="Constant">PUSH_ACTION</systemitem>
by either a single or double click.</para>
</listitem>
</varlistentry>
<varlistentry><term>CONTROL_INSTALL</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">SUBPANEL</systemitem>.
</para>
<para><systemitem class="Constant">CONTROL_INSTALL</systemitem> enables or
disables dynamic control installation into subpanels. A value of True causes
the control installation area to be displayed within the subpanel.</para>
</listitem>
</varlistentry>
<varlistentry><term>DATE_FORMAT</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>date</literal>.</para>
<para><systemitem class="Constant">DATE_FORMAT</systemitem> specifies the
layout of the date string for a control of type <literal>date</literal>. The
format is the same used by the UNIX <function>strftime</function>(3) function.
</para>
</listitem>
</varlistentry>
<varlistentry><term>DELETE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">DELETE</systemitem> is used to override
and remove a non-locked component from the front panel. This is necessary
to eliminate system default front panel components without replacing the default
files. To use <systemitem class="Constant">DELETE</systemitem>, a copy of
the component definition with the additional <systemitem class="Constant">DELETE</systemitem> keyword is stored in a file with an <Filename>.fp</Filename>
suffix in the user's or application type's directory.</para>
</listitem>
</varlistentry>
<varlistentry><term>DISPLAY_CONTROL_LABELS</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para><systemitem class="Constant">DISPLAY_CONTROL_LABELS</systemitem> specifies
whether the controls contained within the front panel's boxes have their labels
displayed.</para>
</listitem>
</varlistentry>
<varlistentry><term>DISPLAY_HANDLES</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para>If <systemitem class="Constant">DISPLAY_HANDLES</systemitem> is set
to True, the move handles are displayed along the left and right edges of
the front panel.</para>
</listitem>
</varlistentry>
<varlistentry><term>DISPLAY_MENU</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para>If <systemitem class="Constant">DISPLAY_MENU</systemitem> is set to
True, and <systemitem class="Constant">DISPLAY_HANDLES</systemitem> is also
set to True, the system menu button is displayed in the upper left hand corner
of the front panel.</para>
</listitem>
</varlistentry>
<varlistentry><term>DISPLAY_MINIMIZE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para>If <systemitem class="Constant">DISPLAY_MINIMIZE</systemitem> is set
to True, and <systemitem class="Constant">DISPLAY_HANDLES</systemitem> is
also set to True, the minimize button is displayed in the upper right hand
corner of the front panel.</para>
</listitem>
</varlistentry>
<varlistentry><term>DROP_ACTION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para><systemitem class="Constant">DROP_ACTION</systemitem> specifies the
function that is invoked when a drop occurs on the control.</para>
</listitem>
</varlistentry>
<varlistentry><term>DROP_ANIMATION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with all control types except: <literal>client</literal>.</para>
<para><systemitem class="Constant">DROP_ANIMATION</systemitem> specifies the
name of an animation record to be displayed when a drop occurs on the control.
The control must have a <systemitem class="Constant">DROP_ACTION</systemitem>
defined for the animation to be used.</para>
</listitem>
</varlistentry>
<varlistentry><term>FILE_NAME</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>icon</literal> and <literal>file</literal>.</para>
<para>For the control type of <literal>file</literal>, <systemitem class="Constant">FILE_NAME</systemitem> is the pathname of the file to be used for the control.
The file's file type, actions and images are extracted from the action database
for the control.</para>
<para>For <systemitem class="Constant">MONITOR_TYPE</systemitem> <literal>mail</literal> and <literal>file</literal>, <systemitem class="Constant">FILE_NAME</systemitem> specifies the pathname of the file the front panel
monitors for either mail arrival or some other user-defined data.</para>
<para>For <systemitem class="Constant">MONITOR_TYPE</systemitem> <literal>file</literal>, the <systemitem class="Constant">ALTERNATE_ICON</systemitem>
image is displayed when the monitored file is non-empty. The <systemitem class="Constant">ICON</systemitem> image is displayed if the file is empty or non-existent.
</para>
<para>For <systemitem class="Constant">MONITOR_TYPE</systemitem> <literal>mail</literal>, the <systemitem class="Constant">ALTERNATE_ICON</systemitem>
image is displayed when the file increases in size.</para>
</listitem>
</varlistentry>
<varlistentry><term>HELP_STRING</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>, <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">HELP_STRING</systemitem> specifies an on-line
help string to display when help is requested over a front panel component.
Since each component type can have a help string associated with it, there
is a precedence used in deciding which help string to display. Control help
takes precedence over box help, switch help and subpanel help. Box help takes
precedence over subpanel help. The <systemitem class="Constant">HELP_STRING</systemitem> value is used only if no <systemitem class="Constant">HELP_TOPIC</systemitem> value is defined.</para>
</listitem>
</varlistentry>
<varlistentry><term>HELP_TOPIC</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>, <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">HELP_TOPIC</systemitem> specifies an on-line
help topic that is used with either the default help volume or a help volume
specified by the <systemitem class="Constant">HELP_VOLUME</systemitem> keyword
to display help information when requested over a front panel component. Like
the <systemitem class="Constant">HELP_STRING</systemitem> keyword, each component
type can have a help topic associated with it and the same precedence rules
are used.</para>
</listitem>
</varlistentry>
<varlistentry><term>HELP_VOLUME</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>, <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para>When <systemitem class="Constant">HELP_VOLUME</systemitem> is used in
conjunction with <systemitem class="Constant">HELP_TOPIC</systemitem>, it
defines the help information to be displayed for a front panel component.
</para>
</listitem>
</varlistentry>
<varlistentry><term>ICON</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>icon</literal>, <literal>file</literal>
and <literal>busy</literal>.</para>
<para><systemitem class="Constant">ICON</systemitem> specifies the image to
be displayed within a control.</para>
</listitem>
</varlistentry>
<varlistentry><term>LABEL</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>icon</literal>, <literal>file</literal>, <literal>clock</literal> and <literal>busy</literal>.</para>
<para><systemitem class="Constant">LABEL</systemitem> specifies the string
to be displayed when a control is in a subpanel.</para>
</listitem>
</varlistentry>
<varlistentry><term>LOCKED</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>, <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SUBPANEL</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">LOCKED</systemitem> provides the mechanism
to prevent a component definition of identical type, name and parent from
overriding (replacing) this definition. Since the front panel can be defined
within multiple configuration files, it provides the flexibility to override
components found earlier in the search path. Like actions and file types,
this allows the front panel to be customized at several levels.</para>
</listitem>
</varlistentry>
<varlistentry><term>MONITOR_TYPE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control types of: <literal>icon</literal> and <literal>file</literal></para>
<para><systemitem class="Constant">MONITOR_TYPE</systemitem> specifies the
method of checking the file being monitored, specified by the keyword <systemitem class="Constant">FILE_NAME</systemitem>.</para>
</listitem>
</varlistentry>
<varlistentry><term>NUMBER_OF_ROWS</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">SWITCH</systemitem>.
</para>
<para><systemitem class="Constant">NUMBER_OF_ROWS</systemitem> provides control
over the layout of the workspace switch buttons. The switch buttons are arranged
in a row and column layout with the <systemitem class="Constant">NUMBER_OF_ROWS</systemitem> keyword defining the number of rows in the layout. The number
of columns is derived from this value and the total number of switch buttons.
</para>
</listitem>
</varlistentry>
<varlistentry><term>PANEL_GEOMETRY</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para><systemitem class="Constant">PANEL_GEOMETRY</systemitem> specifies a
non-default location to position the front panel when it is created. By default,
the front panel is centered along the bottom of the display.</para>
</listitem>
</varlistentry>
<varlistentry><term>POSITION_HINTS</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">BOX</systemitem>, <systemitem class="Constant">SWITCH</systemitem> and <systemitem class="Constant">CONTROL</systemitem>.</para>
<para><systemitem class="Constant">POSITION_HINTS</systemitem> specifies the
ordering of boxes in the front panel, the switch and controls in boxes, and
controls in subpanels. When two components have the same value for <systemitem class="Constant">POSITION_HINTS</systemitem>, the first one read from the
configuration file is placed first.</para>
</listitem>
</varlistentry>
<varlistentry><term>PUSH_ACTION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para><systemitem class="Constant">PUSH_ACTION</systemitem> specifies the
function that is invoked when a selection occurs on the control.</para>
</listitem>
</varlistentry>
<varlistentry><term>PUSH_ANIMATION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with all control types except: <literal>client</literal>.</para>
<para><systemitem class="Constant">PUSH_ANIMATION</systemitem> specifies the
name of an animation record to be displayed when a selection occurs on the
control. The control must have a <systemitem class="Constant">PUSH_ACTION</systemitem> defined for the animation to be used.</para>
</listitem>
</varlistentry>
<varlistentry><term>PUSH_RECALL</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>Used with control keywords of: <systemitem class="Constant">CLIENT_NAME</systemitem>.</para>
<para>When <systemitem class="Constant">PUSH_RECALL</systemitem> is set to
True, it specifies that only one process can be started by the control. If
the process is already running, it is displayed within the current workspace
and shuffled to the top of the window stack. The value for the <systemitem class="Constant">CLIENT_NAME</systemitem> keyword is used to identify the
process for push recall behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term>RESOLUTION</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para><systemitem class="Constant">RESOLUTION</systemitem> allows the icon
set for the front panel to be forced to a particular set. By default, the
front panel determines the display resolution at runtime and chooses the high
resolution icon set if the display width is 1024 pixels or wider.</para>
</listitem>
</varlistentry>
<varlistentry><term>SUBPANEL_UNPOST</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">PANEL</systemitem>.
</para>
<para>When <systemitem class="Constant">SUBPANEL_UNPOST</systemitem> is set
to True, it causes a subpanel to hide itself whenever a <systemitem class="Constant">PUSH_ACTION</systemitem> occurs on one of the subpanel controls. If the subpanel
has been torn off of the front panel, the behavior of the subpanel is forced
to remain posted on <systemitem class="Constant">PUSH_ACTION</systemitem>.
</para>
</listitem>
</varlistentry>
<varlistentry><term>TITLE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">SUBPANEL</systemitem>.
</para>
<para><systemitem class="Constant">TITLE</systemitem> specifies the string
to be displayed in the title area of the subpanel.</para>
</listitem>
</varlistentry>
<varlistentry><term>TYPE</term>
<listitem>
<para>Used with record types of: <systemitem class="Constant">CONTROL</systemitem>.
</para>
<para>A number of different control types are defined by the front panel:
</para>
<variablelist>
<varlistentry><term><literal>blank</literal></term>
<listitem>
<para>Space-holder control</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>busy</literal></term>
<listitem>
<para>Busy light</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>client</literal></term>
<listitem>
<para>A client window</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>clock</literal></term>
<listitem>
<para>Front panel clock</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>date</literal></term>
<listitem>
<para>Fro<?Pub Caret>nt panel date</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>file</literal></term>
<listitem>
<para>References a file on the file system and uses that file's actions and
image</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>icon</literal></term>
<listitem>
<para>Front panel general control</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>FILES</title>
<para>The default front panel configuration file is <Filename>/usr/dt/appconfig/types/C/dtwm.fp</Filename>.</para>
<para>Files containing the attributes of dynamically created front panel components
are in the directory <Filename>$HOME/.dt/types/fp_dynamic</Filename>.</para>
</refsect1>
<refsect1>
<title>APPLICATION USAGE</title>
<para>Errors encountered when loading front panel database files are written
to the user's <Filename>$HOME/.dt/errorlog</Filename> file.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtwm;, <function>strftime</function>(3), &cdeman.dtdtfile;.</para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000074083>

389
cde/doc/C/guides/man/man4/dthelpta.sgm Normal file
View File

@@ -0,0 +1,389 @@
<!-- $XConsortium: dthelpta.sgm /main/6 1996/09/08 20:18:06 rws $ -->
<!-- (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.MAN96.rsml.1">
<RefMeta>
<RefEntryTitle>dthelptagdtd</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dthelptagdtd</Filename></RefName>
<RefPurpose>markup syntax specification for authored &str-XZ; help information
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>The
<Emphasis>HelpTag</Emphasis> markup syntax (ISO 8879: 1986) SGML.
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Emphasis>HelpTag</Emphasis> is a markup
language used for authoring &str-XZ; help volumes.
It is based on the ISO 8879:&thinsp;1986 Standard Generalized Markup Language
(SGML) standard and is defined with the following
Document Type Description (DTD).
</Para>
<Para>The HelpTag marked-up help information is part of the source code
for a conforming &str-XZ; application.
The compilation process that is required to install
this information into help volumes for the &str-XZ; help services
is implementation dependent.
</Para>
</RefSect1>
<RefSect1>
<Title>SGML DECLARATION</Title>
<InformalExample>
<ProgramListing>&lt;!SGML "ISO 8879:1986"
CHARSET
BASESET "ISO 646-1983//CHARSET International Reference Version
(IRV)//ESC 2/5 4/0"
DESCSET 0 9 UNUSED
9 2 9
11 2 UNUSED
13 1 13
14 18 UNUSED
32 95 32
127 1 UNUSED
BASESET "ISO Registration Number 100//CHARSET ECMA-94
Right Part of Latin Alphabet Nr. 1//ESC 2/13 4/1"
DESCSET 128 32 UNUSED
160 5 32
165 1 UNUSED
166 88 38
254 1 127
255 1 UNUSED
CAPACITY SGMLREF
TOTALCAP 350000
ENTCAP 100000
ENTCHCAP 50000
ELEMCAP 50000
GRPCAP 210000
EXGRPCAP 50000
EXNMCAP 50000
ATTCAP 50000
ATTCHCAP 50000
AVGRPCAP 50000
NOTCAP 50000
NOTCHCAP 50000
IDCAP 50000
IDREFCAP 50000
MAPCAP 210000
LKSETCAP 50000
LKNMCAP 50000
SCOPE DOCUMENT
SYNTAX -- The Core Reference Syntax except with ATTCNT, LITLEN, NAMELEN,
GRPCNT, and GRPGTCNT changed --
SHUNCHAR CONTROLS 0 1 2 3 4 5 6 7 8 9
10 11 12 13 14 15 16 17 18 19
20 21 22 23 24 25 26 27 28 29
30 31 127 255
BASESET "ISO 646-1983//CHARSET International Reference Version
(IRV)//ESC 2/5 4/0"
DESCSET 0 128 0
FUNCTION RE 13
RS 10
SPACE 32
TAB SEPCHAR 9
NAMING
LCNMSTRT ""
UCNMSTRT ""
LCNMCHAR "-."
UCNMCHAR "-."
NAMECASE
GENERAL YES
ENTITY YES
DELIM
GENERAL SGMLREF
SHORTREF SGMLREF -- Removed short references --
NAMES SGMLREF
QUANTITY SGMLREF
ATTCNT 140
LITLEN 4096
NAMELEN 64
GRPCNT 100
GRPGTCNT 253
TAGLVL 48
FEATURES
MINIMIZE
DATATAG NO
OMITTAG NO
RANK NO
SHORTTAG YES
LINK
SIMPLE NO
IMPLICIT NO
EXPLICIT NO
OTHER
CONCUR NO
SUBDOC NO
FORMAL NO
APPINFO NONE
>
&lt;!DOCTYPE helpvolume [
&lt;!ELEMENT helpvolume - - (metainfo?,
hometopic?,
(chapter* | (s1*, rsect*)),
message?,
glossary?)
+(memo | idx) >
&lt;!ELEMENT metainfo - - (idsection, abstract?, otherfront*)
-(footnote) >
&lt;!ELEMENT idsection - - (title, copyright?) >
&lt;!ELEMENT title - - (partext)
-(memo | location | idx) >
&lt;!ELEMENT partext - - ((#PCDATA | acro | emph | computer |
user | term | var | circle |
quote | keycap | graphic | super |
sub | book | xref | footnote |
esc | link | location | newline )*) >
&lt;!ELEMENT acro - - ((#PCDATA | esc | super | sub)*) >
&lt;!ELEMENT emph - - (partext) -(emph) >
&lt;!ELEMENT computer - - ((#PCDATA | quote | var | user | esc)*) >
&lt;!ELEMENT user - - ((#PCDATA | var | esc)*) >
&lt;!ELEMENT term - - (partext)
-(emph | computer | term | var |
quote | user | book | footnote) >
&lt;!ATTLIST term base CDATA #IMPLIED
gloss (gloss | nogloss) gloss >
&lt;!ELEMENT var - - ((#PCDATA | esc)*) >
&lt;!ELEMENT circle - - CDATA >
&lt;!ELEMENT quote - - (partext) -(quote) >
&lt;!ELEMENT keycap - - ((#PCDATA | super | sub | esc)+) >
&lt;!ELEMENT graphic - O EMPTY >
&lt;!ATTLIST graphic id ID #IMPLIED
entity ENTITY #REQUIRED >
&lt;!ELEMENT super - - (#PCDATA) >
&lt;!ELEMENT sub - - (#PCDATA) >
&lt;!ELEMENT book - - (partext) -(book) >
&lt;!ELEMENT xref - O EMPTY >
&lt;!ATTLIST xref id IDREF #REQUIRED >
&lt;!ELEMENT footnote - - (p+) -(footnote) >
&lt;!ELEMENT esc - - CDATA >
&lt;!ELEMENT link - - (partext) -(link | xref) >
&lt;!ATTLIST link hyperlink CDATA #REQUIRED
type (jump |
jumpnewview |
definition |
execute |
appdefined |
man) jump
description CDATA #IMPLIED >
&lt;!ELEMENT location - - (partext) -(location) >
&lt;!ATTLIST location id ID #REQUIRED >
&lt;!ELEMENT copyright - - (text)
-(memo | location | idx) >
&lt;!ELEMENT text - - ((p | note | caution | warning |
lablist | list | ex | vex |
esc | otherhead | procedure | syntax |
figure | image )*) >
&lt;!ELEMENT p - - (head?, partext)
+(newline) >
&lt;!ATTLIST (p | image) indent (indent) #IMPLIED
id ID #IMPLIED
gentity ENTITY #IMPLIED
gposition (left | right) left
ghyperlink CDATA #IMPLIED
glinktype (jump |
jumpnewview |
definition |
execute |
appdefined |
man) jump
gdescription CDATA #IMPLIED >
&lt;!ELEMENT head - - (partext)
-(memo | location | idx) >
&lt;!ELEMENT newline - O EMPTY >
&lt;!ELEMENT (note |
caution |
warning) - - (head?, text)
-(note | caution | warning | footnote) >
&lt;!ELEMENT lablist - - (head?, labheads?, lablistitem+) >
&lt;!ATTLIST lablist spacing (loose | tight) loose
longlabel (wrap | nowrap) wrap >
&lt;!ELEMENT labheads - - (labh, labhtext)
-(memo | location | idx) >
&lt;!ELEMENT labh - - (partext) >
&lt;!ELEMENT labhtext - - (partext) >
&lt;!ELEMENT lablistitem - - (label, text) >
&lt;!ELEMENT label - - (partext) >
&lt;!ELEMENT list - - (head?, item+) >
&lt;!ATTLIST list type (order |
bullet |
plain |
check) bullet
ordertype (ualpha |
lalpha |
arabic |
uroman |
lroman) arabic
spacing (tight |
loose) tight
continue (continue) #IMPLIED >
&lt;!ELEMENT item - - (text) >
&lt;!ATTLIST item id ID #IMPLIED >
&lt;!ELEMENT ex - - (head?, (exampleseg, annotation?)+)
-(ex |
vex |
note |
caution |
warning |
syntax |
footnote) >
&lt;!ATTLIST ex notes (side | stack) side
lines (number |
nonumber) nonumber
textsize (normal |
smaller |
smallest) normal >
&lt;!ELEMENT exampleseg - - (partext) +(lineno) >
&lt;!ELEMENT annotation - - (partext) +(newline) >
&lt;!ELEMENT lineno - O EMPTY >
&lt;!ATTLIST lineno id ID #IMPLIED >
&lt;!ELEMENT vex - - CDATA >
&lt;!ATTLIST vex lines (number |
nonumber) nonumber
textsize (normal |
smaller |
smallest) normal >
&lt;!ELEMENT otherhead - - (head, text?) >
&lt;!ELEMENT procedure - - (chaphead, text?)
-(procedure) >
&lt;!ELEMENT chaphead - - (head, abbrev?)
-(memo | location | idx | footnote) >
&lt;!ELEMENT abbrev - - (partext) -(footnote) >
&lt;!ELEMENT syntax - - (head?, synel) >
&lt;!ELEMENT synel - - ((#PCDATA | esc | var |
optblock | reqblock )+) >
&lt;!ELEMENT (optblock |
reqblock) - - (synel+) >
&lt;!ELEMENT figure - - (caption?)
-(figure | graphic) >
&lt;!ATTLIST figure number NUMBER #IMPLIED
tonumber (number |
nonumber) number
id ID #IMPLIED
entity ENTITY #REQUIRED
figpos (left |
center |
right) #IMPLIED
cappos (capleft |
capcenter |
capright) #IMPLIED
ghyperlink CDATA #IMPLIED
glinktype (jump |
jumpnewview |
definition |
execute |
appdefined |
man) jump
gdescription CDATA #IMPLIED >
&lt;!ELEMENT caption - - (partext, abbrev?)
-(memo | location | idx) >
&lt;!ELEMENT image - - (head?, partext) -(footnote) >
&lt;!ELEMENT abstract - - (head?, text?, frontsub*) >
&lt;!ELEMENT frontsub - - (head?, text) >
&lt;!ELEMENT otherfront - - (head?, text?, frontsub*) >
&lt;!ATTLIST otherfront id ID #IMPLIED >
&lt;!ELEMENT hometopic - - (chaphead, text?) >
&lt;!ELEMENT chapter - - (chaphead, text?, (s1*, rsect*)) >
&lt;!ATTLIST (chapter |
s1 |
s2 |
s3 |
s4 |
s5 |
s6 |
s7 |
s8 |
s9) id ID #IMPLIED >
&lt;!ELEMENT s1 - - (chaphead, text?, s2*, rsect*) >
&lt;!ELEMENT s2 - - (chaphead, text?, s3*, rsect*) >
&lt;!ELEMENT s3 - - (chaphead, text?, s4*, rsect*) >
&lt;!ELEMENT s4 - - (chaphead, text?, s5*, rsect*) >
&lt;!ELEMENT s5 - - (chaphead, text?, s6*, rsect*) >
&lt;!ELEMENT s6 - - (chaphead, text?, s7*, rsect*) >
&lt;!ELEMENT s7 - - (chaphead, text?, s8*, rsect*) >
&lt;!ELEMENT s8 - - (chaphead, text?, s9*, rsect*) >
&lt;!ELEMENT s9 - - (chaphead, text?) >
&lt;!ELEMENT rsect - - (chaphead, text?, rsub*) >
&lt;!ATTLIST rsect id ID #IMPLIED >
&lt;!ELEMENT rsub - - (chaphead, text?) >
&lt;!ELEMENT message - - (chaphead?, text?, (msg+ | msgsub+)) >
&lt;!ELEMENT msg - - (msgnum?, msgtext, explain?) +(newline) >
&lt;!ELEMENT msgnum - - ((#PCDATA | esc)+) >
&lt;!ELEMENT msgtext - - (partext) >
&lt;!ELEMENT explain - - (text) >
&lt;!ELEMENT msgsub - - (chaphead, text?, msg+) >
&lt;!ELEMENT glossary - - (text?, glossent+) >
&lt;!ELEMENT glossent - - (dterm, definition) >
&lt;!ELEMENT dterm - - (partext) -(term) >
&lt;!ELEMENT definition - - (text) >
&lt;!ELEMENT idx - - (indexprimary, indexsub?)
-(term | footnote | location | idx) >
&lt;!ELEMENT indexprimary - - (partext, sort?) >
&lt;!ELEMENT indexsub - - (partext, sort?) >
&lt;!ELEMENT sort - - ((#PCDATA | esc)+) >
&lt;!ELEMENT memo - - CDATA >
&lt;!ENTITY MINUS SDATA "-">
&lt;!ENTITY PM SDATA '[plusmn]'> &lt;!-- ISOnum -->
&lt;!ENTITY DIV SDATA '[divide]'> &lt;!-- ISOnum -->
&lt;!ENTITY TIMES SDATA '[times ]'> &lt;!-- ISOnum -->
&lt;!ENTITY LEQ SDATA '[le ]'> &lt;!-- ISOtech -->
&lt;!ENTITY GEQ SDATA '[ge ]'> &lt;!-- ISOtech -->
&lt;!ENTITY NEQ SDATA '[ne ]'> &lt;!-- ISOtech -->
&lt;!ENTITY COPY SDATA '[copy ]'> &lt;!-- ISOnum -->
&lt;!ENTITY REG SDATA '[reg ]'> &lt;!-- ISOnum -->
&lt;!ENTITY TM SDATA '[trade ]'> &lt;!-- ISOnum -->
&lt;!ENTITY ELLIPSIS SDATA '[hellip]'> &lt;!-- ISOpub -->
&lt;!ENTITY VELLIPSIS SDATA '[vellip]'> &lt;!-- ISOpub -->
&lt;!ENTITY PELLIPSIS SDATA "...."> &lt;!-- ellipsis followed by a period -->
&lt;!ENTITY A.M. SDATA "a.m.">
&lt;!ENTITY P.M. SDATA "p.m.">
&lt;!ENTITY MINUTES SDATA '[prime ]'> &lt;!-- ISOtech -->
&lt;!ENTITY SECONDS SDATA '[Prime ]'> &lt;!-- ISOtech -->
&lt;!ENTITY DEG SDATA '[deg ]'> &lt;!-- ISOnum -->
&lt;!ENTITY SQUOTE SDATA "`">
&lt;!ENTITY DQUOTE SDATA '"'>
&lt;!ENTITY ENDASH SDATA "-">
&lt;!ENTITY EMDASH SDATA '[mdash ]'> &lt;!-- ISOpub -->
&lt;!ENTITY VBLANK SDATA "_">
&lt;!ENTITY CENTS SDATA '[cent ]'> &lt;!-- ISOnum -->
&lt;!ENTITY STERLING SDATA '[pound ]'> &lt;!-- ISOnum -->
&lt;!ENTITY SPACE SDATA " ">
&lt;!ENTITY SIGSPACE SDATA "&amp; ">
&lt;!ENTITY SIGDASH SDATA "&amp;-">
&lt;!ENTITY MICRO SDATA '[micro ]'> &lt;!-- ISOnum -->
&lt;!ENTITY OHM SDATA '[ohm ]'> &lt;!-- ISOnum -->
&lt;!ENTITY UP SDATA '[uarr ]'> &lt;!-- ISOnum -->
&lt;!ENTITY DOWN SDATA '[darr ]'> &lt;!-- ISOnum -->
&lt;!ENTITY LEFT SDATA '[larr ]'> &lt;!-- ISOnum -->
&lt;!ENTITY RIGHT SDATA '[rarr ]'> &lt;!-- ISOnum -->
&lt;!ENTITY HOME SDATA "home key">
&lt;!ENTITY BACK SDATA "&lt;--">
&lt;!ENTITY HALFSPACE SDATA " ">
&lt;!ENTITY % user-defined-entities SYSTEM "helptag.ent">
%user-defined-entities;
] >
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtHelpDialog;, &cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpReturnSelectedWidgetId;, &cdeman.DtHelpDialog;, &cdeman.DtHelpQuickDialog;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

184
cde/doc/C/guides/man/man4/dthffile.sgm Normal file
View File

@@ -0,0 +1,184 @@
<!-- $XConsortium: dthffile.sgm /main/6 1996/09/08 20:18:15 rws $ -->
<!-- (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.MAN81.rsml.1">
<RefMeta>
<RefEntryTitle>dthffile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dthffile</Filename></RefName>
<RefPurpose>define the format of CDE Help Family files
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>CDE
<Literal>Help</Literal> <Literal>Family</Literal> file format description.
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The Family file is based on the X11 syntax for application resources.
Family files are used in conjunction with
&cdeman.dthelpgen; to generate a browser Help volume
that allows users to navigate through all of the available Help information.
</Para>
<Para>The Family file,
<Literal>&lt;filename>.hf</Literal>, contains the following fields: character set,
title, abstract, volume list and an optional image name.
</Para>
<Para>The
<Literal>charSet</Literal> field specifies the standard CDE locale and code set value to be used in
parsing the title and abstract fields of the Family file.
The default
value is <Literal>en_US.iso8859-1</Literal>.
See the
<Emphasis>CDE</Emphasis> <Emphasis>Help</Emphasis> <Emphasis>System</Emphasis> <Emphasis>Author's</Emphasis> <Emphasis>and</Emphasis> <Emphasis>Programmer's</Emphasis> for a complete list of supported locales and code sets.
The Family title and abstract must not contain any HelpTag
markup as this file is not processed by the HelpTag
software.
</Para>
<Para>The
<Literal>title</Literal> field specifies the title of the family, as displayed in the top-level of
the browser Help volume.
</Para>
<Para>The
<Literal>abstract</Literal> field specifies the abstract for the Family.
Used to describe the family, it
gives information about what type of volumes are in this Family or
why these volumes are related.
For long abstracts, the
backslash character can be used to continue to the next line.
</Para>
<Para>The
<Literal>volumes</Literal> field specifies which volumes belong to the Family.
The
volumes are listed in the order they appear on this line.
A volume may
be listed in more than one Family.
This is a list of volume
names separated by spaces.
The ending <Filename>.sdl</Filename>
extension must be specified if the search path contains a
<Literal>%H</Literal> rather than an
<Literal>%H.sdl</Literal>. See
&cdeman.DtHelpDialog; for more information about CDE Help search path syntax and use.
</Para>
<Para>The
<Literal>[bitmap]</Literal> field specifies the image that pictorially describes the Family.
This image is displayed in the top-level browser volume just under the
Family title, and to the left of the abstract text.
</Para>
<Para>The
<Literal>icon</Literal> file is optional.
If one is provide, the
path used to specify the location of the file should be a complete
pathname.
If an icon file is not provided, the
<Literal>*.bitmap</Literal> resource in the Family file should not be provided.
</Para>
<Para><Literal>Supported</Literal> <Literal>Graphics</Literal> <Literal>Formats:</Literal></Para>
<VariableList>
<VarListEntry>
<Term><Literal>*.xwd</Literal></Term>
<ListItem>
<Para>X11 XWD file
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.tif</Literal></Term>
<ListItem>
<Para>TIFF 5.0 image file
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.pm</Literal></Term>
<ListItem>
<Para>X11 X Pixmap file
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.bm</Literal></Term>
<ListItem>
<Para>X11 Bitmap file
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>Registering A Product Family</Title>
<Para>To register a product family, create and install a Help
Family file (<Literal>product.hf</Literal>) with the rest of the product's Help files.
Register the Family file by running the
<Command>dtappintegrate</Command> script, which
creates a symbolic link to the <Literal>product.hf</Literal> file.
For most products, the
appropriate place for the link is
<Filename>/etc/dt/appconfig/help/language/</Filename>. See
&cdeman.dtappintegrate; for more information on registering Help within the desktop.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<VariableList>
<VarListEntry>
<Term><Literal>*.charSet:</Literal></Term>
<ListItem>
<Para>iso8859-1
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.title:</Literal></Term>
<ListItem>
<Para>Developer's Information About The Help System
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.abstract:</Literal></Term>
<ListItem>
<Para>Abstract giving a short description about the Help system.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.volumes:</Literal></Term>
<ListItem>
<Para>helpkit.sdl helpdemo.sdl
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>*.bitmap:</Literal></Term>
<ListItem>
<Para><Filename>/usr/local/bitmap/helpGraphic.bm</Filename>
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelpgen;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

376
cde/doc/C/guides/man/man4/dticonfi.sgm Normal file
View File

@@ -0,0 +1,376 @@
<!-- $XConsortium: dticonfi.sgm /main/9 1996/09/08 20:18:23 rws $ -->
<!-- (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.MAN97.rsml.1">
<refmeta><refentrytitle>dticonfile</refentrytitle><manvolnum>special file
</manvolnum></refmeta>
<refnamediv><refname><filename>dticonfile</filename></refname><refpurpose>
icon conventions for &str-XZ; icons</refpurpose></refnamediv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- *************************************************************************-->
<refsynopsisdiv>
<synopsis>The conventions used within the &str-XZ; for icon
sizes, naming, location, and usage are specified.</synopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>Both X Pixmap and X Bitmap icon file formats are used within the &str-XZ;.
X Pixmap (XPM) icons are multi-color images based on the XPM format developed
by Arnaud Le Hors. A pixmap file is an ASCII file that can be read and modified
by hand, in addition to using color pixmap editors (like the &str-XZ; Icon
Editor). X Bitmap (XBM) icons are monochrome (two-color) images based on the
official X11 Bitmap File Format. Bitmap files are ASCII files; however, the
data is simply a binary representation of the bitmap, and as such is not easily
read or modified by hand. The &str-XZ; icon editor can create and modify XBM
icons. The icon editor has the ability to write out any icon in either the
XPM or XBM file format. For a more detailed description of these file formats
and the icon editor, see the &cdeman.dtbmfile;, &cdeman.dtpmfile; and &cdeman.dticon; man pages.</para>
<refsect2>
<title>File Naming</title>
<para>&str-XZ; icon file names are typically in one of the following forms:
</para>
<informalexample remap="indent">
<programlisting><emphasis>basename</emphasis>.<symbol role="Variable">format</symbol>
<emphasis>basename</emphasis>.<symbol role="Variable">size</symbol>.<symbol role="Variable">format</symbol></programlisting>
</informalexample>
<para>The <emphasis>basename</emphasis> is the logical name of the icon. The
basenames for icons that are installed with &str-XZ; begin with either <literal>Dt</literal> or <literal>Fp</literal>. <literal>Dt</literal> is the default
prefix for all &str-XZ; icons. The <literal>Fp</literal> prefix is used for
icons that appear in the front panel when an icon other than the default <literal>Dt</literal> icon is desired. In this case, the basename is the same.</para>
<para>If an additional icon is needed for the client <literal>iconImage</literal>
(iconified client window icon), a third prefix, <literal>Ic</literal>, is
used.</para>
<para>The <symbol role="Variable">format</symbol> is <literal>pm</literal>
for a pixmap file and <literal>bm</literal> for a bitmap file. Size is a single
letter: <literal>l</literal> for large, <literal>m</literal> for medium, <literal>s</literal> for small and <literal>t</literal> for tiny. Many of the logical
icons are provided in multiple sizes for both color and monochrome. This allows &str-XZ;
to use the optimal color and size combination for the specific task and configuration
the user is running. Many bitmap icons have a mask associated with the icon.
These are named <emphasis>basename.size</emphasis><literal>_m.</literal><symbol role="Variable">format</symbol>.
All icons are named so that the longest filename
associated with that icon is 14 bytes or less; this allows it to be used on
a short filename system. The longest filename can be described as <literal>Dt</literal><emphasis>xxxxx</emphasis><literal>_m.l.pm</literal>, where <emphasis>xxxxx</emphasis> is the logical icon name.</para>
</refsect2>
<refsect2>
<title>Example</title>
<para>This is an example of icon files that might be associated with the icon <literal>foo</literal>. The single logical icon <literal>foo</literal> contains tiny,
small, medium and large bitmap icons (with mask) and pixmap icons.</para>
<informalexample remap="indent">
<programlisting>Dtfoo.t.pm
Dtfoo.t.bm
Dtfoo.t_m.bm
Dtfoo.s.pm
Dtfoo.s.bm
Dtfoo.s_m.bm
Dtfoo.m.pm
Dtfoo.m.bm
Dtfoo.m_m.bm
Dtfoo.l.pm
Dtfoo.l.bm
Dtfoo.l_m.bm</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>Icon Sizes</title>
<para>Icons of the following sizes and with the following suffixes are supported:
</para>
<variablelist>
<varlistentry><term>Large</term>
<listitem>
<para>48&thinsp;&times;&thinsp;48 icon with <Filename>.l</Filename> suffix</para>
</listitem>
</varlistentry>
<varlistentry><term>Medium</term>
<listitem>
<para>32&thinsp;&times;&thinsp;32 icon with <Filename>.m</Filename> suffix</para>
</listitem>
</varlistentry>
<varlistentry><term>Small</term>
<listitem>
<para>24&thinsp;&times;&thinsp;24 icon with <Filename>.s</Filename> suffix</para>
</listitem>
</varlistentry>
<varlistentry><term>Tiny</term>
<listitem>
<para>16&thinsp;&times;&thinsp;16 icon with <Filename>.t</Filename> suffix</para>
</listitem>
</varlistentry>
</variablelist>
<para>The icon sizes used varies for different components, and is dependent
on the display hardware.</para>
</refsect2>
<refsect2>
<title>Table Of Icon Sizes Used</title>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.07in">
<colspec align="left" colwidth="182*">
<colspec align="left" colwidth="190*">
<colspec align="left" colwidth="128*">
<tbody>
<row>
<entry align="left" valign="top"><literal>&str-XZ; Component</literal></entry>
<entry align="left" valign="top"><literal>HiRes,MedRes</literal></entry>
<entry align="left" valign="top"><literal>LoRes(vga)</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>Front Panel</literal></entry>
<entry align="left" valign="top"><literal>48&thinsp;&times;&thinsp;48</literal></entry>
<entry align="left" valign="top"><literal>32&thinsp;&times;&thinsp;32</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>FP Subpanels</literal></entry>
<entry align="left" valign="top"><literal>32&thinsp;&times;&thinsp;32</literal></entry>
<entry align="left" valign="top"><literal>24&thinsp;&times;&thinsp;24</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>FP Inset FP</literal></entry>
<entry align="left" valign="top"><literal>24&thinsp;&times;&thinsp;24</literal></entry>
<entry align="left" valign="top"><literal>16&thinsp;&times;&thinsp;16</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>WMgr ClientIcon</literal></entry>
<entry align="left" valign="top"><literal>48&thinsp;&times;&thinsp;48</literal></entry>
<entry align="left" valign="top"><literal>32&thinsp;&times;&thinsp;32</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>File Mgr (Large)</literal></entry>
<entry align="left" valign="top"><literal>32&thinsp;&times;&thinsp;32</literal></entry>
<entry align="left" valign="top"><literal>32&thinsp;&times;&thinsp;32</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>File Mgr (Small)</literal></entry>
<entry align="left" valign="top"><literal>16&thinsp;&times;&thinsp;16</literal></entry>
<entry align="left" valign="top"><literal>16&thinsp;&times;&thinsp;16</literal></entry>
</row></tbody></tgroup></informaltable>
</refsect2>
<refsect2>
<title>Icon Colors</title>
<para>These colors are used in &str-XZ; icons. The dynamic colors use color
cells from one of the color sets in the user's color palette (except none,
which requires no color cell).</para>
<para>The eight icon color names are already included in the <literal>rgb.txt</literal> file. The eight icon gray color names should be added to each &str-XZ;
vendor's <literal>rgb.txt</literal>.</para>
<informaltable remap="center" orient="port">
<tgroup cols="2" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="4.17in">
<colspec align="left" colwidth="164*">
<colspec align="left" colwidth="179*">
<tbody>
<row>
<entry align="left" valign="top"><literal>Color Name (rgb.txt)</literal></entry>
<entry align="left" valign="top"><literal>Symbolic Name (&lt;icon>.pm)</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>&lt; dynamic ></literal></entry>
<entry align="left" valign="top"><literal>none</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>&lt; dynamic ></literal></entry>
<entry align="left" valign="top"><literal>background</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>&lt; dynamic ></literal></entry>
<entry align="left" valign="top"><literal>selectColor</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>&lt; dynamic ></literal></entry>
<entry align="left" valign="top"><literal>topShadowColor</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>&lt; dynamic ></literal></entry>
<entry align="left" valign="top"><literal>bottomShadowColor</literal></entry>
</row>
<row>
<entry align="left" valign="top"><literal>black</literal></entry>
<entry align="left" valign="top"><literal>iconColor1</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>white</literal></entry>
<entry align="left" valign="top"><literal>iconColor2</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>red</literal></entry>
<entry align="left" valign="top"><literal>iconColor3</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>green</literal></entry>
<entry align="left" valign="top"><literal>iconColor4</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>blue</literal></entry>
<entry align="left" valign="top"><literal>iconColor5</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>yellow</literal></entry>
<entry align="left" valign="top"><literal>iconColor6</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>cyan</literal></entry>
<entry align="left" valign="top"><literal>iconColor7</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>magenta</literal></entry>
<entry align="left" valign="top"><literal>iconColor8</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray1</literal></entry>
<entry align="left" valign="top"><literal>iconGray1</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray2</literal></entry>
<entry align="left" valign="top"><literal>iconGray2</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray3</literal></entry>
<entry align="left" valign="top"><literal>iconGray3</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray4</literal></entry>
<entry align="left" valign="top"><literal>iconGray4</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray5</literal></entry>
<entry align="left" valign="top"><literal>iconGray5</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray6</literal></entry>
<entry align="left" valign="top"><literal>iconGray6</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray7</literal></entry>
<entry align="left" valign="top"><literal>iconGray7</literal></entry></row>
<row>
<entry align="left" valign="top"><literal>iconGray8</literal></entry>
<entry align="left" valign="top"><literal>iconGray8</literal></entry></row>
</tbody></tgroup></informaltable>
</refsect2>
<refsect2>
<title>Icon File Locations</title>
<para>&str-XZ; has default locations where it looks to find system and user
icon files. See the &cdeman.dtappintegrate; manual page for detailed
information on where to install icons. See the &cdeman.dtsearchpath;
manual page for information on the icon lookup path.</para>
</refsect2>
<refsect2>
<title>Icon Usage In &str-XZ;</title>
<para>Icons are used in a variety of ways within &str-XZ;. Following are examples
of some of the general areas in which users can use icons to customize &str-XZ;
configurations. A system administrator can also do this on a system- or network-wide
basis. For more detailed information on any of these topics, see the documentation
for that component or configuration file.</para>
</refsect2>
<refsect2>
<title>Actions And Data Types</title>
<para>An icon is associated with an action or data type using the <systemitem class="Constant">ICON</systemitem> keyword in the action or data type definition
(located in <Filename>.dt</Filename> files). If &str-XZ; naming conventions
are followed, there is no need to specify the path or icon suffix. The size
and format used is determined at runtime based on the system configuration.
</para>
</refsect2>
<refsect2>
<title>Example</title>
<informalexample remap="indent">
<programlisting>ACTION IslandPaintOpenDoc
{
ICON Ipaint
WINDOW_TYPE NO_STDIO
EXEC_HOST MyMachine
EXEC_STRING /usr/bin/IslandPaint %(File)Arg_1"File to open:"
}</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>Client Icons</title>
<para>An icon is associated with a client's iconified window through the iconImage
window manager resource as follows:</para>
<informalexample remap="indent">
<programlisting><literal>Dtwm*</literal><emphasis>clientName</emphasis><literal>*iconImage: IconFilename</literal></programlisting>
</informalexample>
<para>The icon may be a pixmap or bitmap format icon. Some clients do not
allow their default icon to be overridden.</para>
</refsect2>
<refsect2>
<title>Example</title>
<informalexample remap="indent">
<programlisting>Dtwm*IslandPaint*clientIcon: IslandPaint.bm</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>Front Panel</title>
<para>Icons can be displayed as controls in the front panel using the <systemitem class="Constant">ICON</systemitem> keyword in control definitions. Either
pixmap- or bitmap-format icons can be used. For controls that are of type <literal>icon</literal> with <systemitem class="Constant">MONITOR_TYPE</systemitem>
set to <literal>file</literal> or <literal>mail</literal>, an alternate image
can be specified using the keyword <systemitem class="Constant">ALTERNATE_ICON</systemitem>. The alternate icon is used when the file size has grown. Controls
of type <literal>busy</literal> can also have an alternate icon, which is
cycled with the <systemitem class="Constant">ICON</systemitem> to give a blinking
effect. For controls that allow a <systemitem class="Constant">PUSH_ACTION</systemitem> or a <systemitem class="Constant">DROP_ACTION</systemitem>,
push or drop animation can be defined using multiple icons that create animation
visual effects.</para>
</refsect2>
<refsect2>
<title>Example</title>
<informalexample remap="indent">
<programlisting>CONTROL DirectoryTerm
{
TYPE icon
IMAGE directoryTerm
DROP_ACTION f.action StartDirectoryTerm
PUSH_ACTION f.action StartDirectoryTerm
PUSH_ANIMATION DirAnimation
}
ANIMATION DirAnimation
{
ANIMATION frame1 300
ANIMATION frame2
...
}</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>Backdrops</title>
<para>The backdrop icons show up in a list in the Backdrop Dialog of the Style
Manager. The user can select a single backdrop per workspace to be used as
the background for that workspace. This is a visual clue to help the user
distinguish one workspace from another. Backdrops are available in both monochrome
(bitmap) and color (pixmap) format (all backdrops are unique; there are not
bitmap and pixmap versions of the same backdrop). Although backdrops use the
same file format as other icons, they are not used like what is typically
referred to as an icon. They would be more accurately described as an image.
The image is repeated (tiled) to fill the entire background of a workspace.
This is not typically done with an icon. The &str-XZ; comes with a set of
standard backdrops. Some are monochrome and some are in color. Custom backdrops
can be added to system-installed backdrops using the Style Manager and Window
Manager <literal>backdropDirectories</literal> resource. Backdrops can be
either bitmap or pixmap format. A system administrator can add system-wide
backdrops to the system-wide default backdrop directory, <Filename>/usr/dt/backdrops/C</Filename>.</para>
</refsect2>
<refsect2>
<title>Example</title>
<informalexample remap="indent">
<programlisting>*backdropDirectories: /users/julie/.dt/icons/myBackdrops
</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>File Manager As Icon Browser</title>
<para>The File Manager can be used as an icon browser. In this mode, when
you change to a directory that contains icons ( <Filename>.bm</Filename> or <Filename>.pm</Filename> files), each icon is displayed next to the icon file name. To
enable icon browsing, copy the file <Filename>/usr/dt/contrib/types/IconBrowse.dt</Filename> into your <Filename>$HOME/.dt/types</Filename> directory. Then reload
the action database by executing the <literal>ReloadActions</literal> action.
For large icons, or on systems with little memory, this could cause delays
on some directories. To disable icon browsing, remove personal copies of the <literal>IconBrowse.dt</literal> file and reload the <?Pub Caret>action database again.
</para>
</refsect2>
<refsect2>
<title>Design Recommendations</title>
<para>In order to allow colorful icons while minimizing the number of colors
used by the &str-XZ;, it is recommended that the colors used be limited to
those available in the Icon Editor. These include the dynamic Motif widget
colors, as well as a set of static colors and static gray colors. The dynamic
colors include foreground, background, top shadow, bottom shadow, select and
a transparent color. The static colors include black, white, red, blue, green,
yellow, magenta and cyan. The static gray colors are eight varying shades
of gray, from nearly black to nearly white.</para>
</refsect2>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtpmfile;, &cdeman.dtbmfile;, &cdeman.dticon;, &cdeman.dtfpfile;, &cdeman.dtdtfile;, &cdeman.dtactionfile;, &cdeman.dtdtsfile;, &cdeman.dtstyle;, &cdeman.dtenvvar;, <function>xmgeticonfilename</function>(3).
</para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000047663>

160
cde/doc/C/guides/man/man4/dtpmfile.sgm Normal file
View File

@@ -0,0 +1,160 @@
<!-- $XConsortium: dtpmfile.sgm /main/9 1996/09/08 20:18:32 rws $ -->
<!-- (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.MAN82.rsml.1">
<RefMeta>
<RefEntryTitle>dtpmfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtpmfile</Filename></RefName>
<RefPurpose>format of X Pixmap (XPM) format desktop icon files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis> /* XPM */
static char * <Emphasis>icon_name</Emphasis>[] = {
"<Emphasis>width height num_colors chars_per_pixel [x_hot y_hot]</Emphasis>",
"<Emphasis>char {key color}+</Emphasis>",
...
" <Symbol Role="Variable">pixels</Symbol> ",
...
};
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Pixmap icons are multi-color images based on the XPM (X PixMap) format.
A pixmap file is an ASCII file, which can
be read and modified by hand, in addition to the use of color pixmap
editors (like the Icon Editor).
The XPM format was designed specifically
for small "icon" images.
XPM files can be included directly in C source
code, so the file data is in the form of a pixmap structure variable.
A pixmap file can be broken down into three main components: generic
pixmap information, pixmap colors, and the actual pixmap data.
</Para>
<Para>The generic pixmap file contains the following information:
</Para>
<ItemizedList>
<ListItem>
<Para>pixmap name
</Para>
</ListItem>
<ListItem>
<Para>pixmap width
</Para>
</ListItem>
<ListItem>
<Para>pixmap height
</Para>
</ListItem>
<ListItem>
<Para>number of colors used in pixmap
</Para>
</ListItem>
<ListItem>
<Para>number of characters per pixel
</Para>
</ListItem>
<ListItem>
<Para>x hot-spot and y hot-spot (optional)
</Para>
</ListItem>
</ItemizedList>
<Para>Each color used in the pixmap is defined by a string containing the
following information:
</Para>
<ItemizedList>
<ListItem>
<Para>character(s) used to represent this color in pixmap data
</Para>
</ListItem>
<ListItem>
<Para>symbolic name for this color
</Para>
</ListItem>
<ListItem>
<Para>mono visual to use for this color (that is, black/white)
</Para>
</ListItem>
<ListItem>
<Para>color visual by name ("red") or RGB value ("#9696c8c8afaf")
</Para>
</ListItem>
<ListItem>
<Para>gray scale visuals (most CDE icons do not include gray scale data)
</Para>
</ListItem>
</ItemizedList>
<Para>The data itself is simply strings of symbols representing colors.
There is one string per column of the pixmap, and this data will
resemble the actual icon.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is a pixmap that can be used to represent an executable
file. The icon has a 3-D border around it and contains a lightning bolt.
</Para>
<InformalExample Remap="indent">
<ProgramListing>static char ** execute = {
"22 22 7 1",
"R s iconGray1 m white c #e1e1e1e1e1e1",
"B s iconGray3 m white c #afafafafafaf",
"~ s iconColor6 m white c yellow",
"Y s iconColor1 m black c black",
"X s iconGray2 m white c #c8c8c8c8c8c8",
"+ s iconGray7 m black c #4b4b4b4b4b4b",
"@ s iconGray5 m black c #7d7d7d7d7d7d",
"RRRRRRRRRRRRRRRRRRRBRR",
"RRRRRRRRRRRRRRRR~~BRRY",
"RRBBBBBBBBBBBBX~~YBBYY",
"RRBBBBBBBBBBBB~~YBBBYY",
"RRBBBBBBBBBB~~~YBBBBYY",
"RRBBBBBBBBX~~~YBBBBBYY",
"RRBBBBBBBB~~~YBBBBBBYY",
"RRBBBBBBX~~~~~~~~XYBYY",
"RRBBBBX~~~~~~~~XYYBBYY",
"RRBBBBBYYYY~~~XYBBBBYY",
"RRBBBBBBX~~~XYYBBBBBYY",
"RRBBBBBX~~XYYBBBBBBBYY",
"RRBBBX~~~YYYBBBBBBBBYY",
"RRBB~~~~~~~~~~~XYBBBYY",
"RRX~~~~~~~~~~X+YBBBBYY",
"RRBYYYY~~~~X+YBBBBBBYY",
"RRBBBBB~~B@YBBBBBBBBYY",
"RRBBBB~X@YYBBBBBBBBBYY",
"RRBBB~B+YBBBBBBBBBBBYY",
"RRBB~+YBBBBBBBBBBBBBYY",
"RRY~YYYYYYYYYYYYYYYYYY",
"RYYYYYYYYYYYYYYYYYYYYY"};
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>For a description of icon location, usage, design, etc. within the
CDE, refer to
&cdeman.dticonfile;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Literal>X11</Literal>Window<Literal>System</Literal>documentation,
&cdeman.dticonfile;, &cdeman.dticon;,
&cdeman.dtbmfile;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

123
cde/doc/C/guides/man/man4/dtresour.sgm Normal file
View File

@@ -0,0 +1,123 @@
<!-- $XConsortium: dtresour.sgm /main/9 1996/09/08 20:18:41 rws $ -->
<!-- (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.MAN83.rsml.1">
<RefMeta>
<RefEntryTitle>dtresourcesfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtresourcesfile</Filename></RefName>
<RefPurpose>format and location of desktop resource files
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The desktop default resources can be found in
/usr/dt/config/$LANG/sys.resources.
These resources will be
made available to each user's session via the
<Symbol Role="Define">RESOURCE_MANAGER</Symbol> property.
This file should not be edited as it will be unconditionally
overwritten upon subsequent desktop installations.
</Para>
<Para>A system administrator may augment the system default resources
by creating
<Filename>/etc/dt/config/$LANG/sys.resources</Filename>. In this file, a
system administrator may override system default resources or
specify additional resources.
As this file is merged into the
desktop default resources during session startup, it is preferrable
that only new or updated resource specifications be placed in this
file, rather than a copy being made of the desktop default resource
file.
Resources specified in this file will be made available to
each user's session via the
<Symbol Role="Define">RESOURCE_MANAGER</Symbol> property.
Resources
specified in this file take precedence over those specified in
the desktop default resource file.
</Para>
<Para>A user may augment the desktop default and system administrator
resources via their $HOME/.Xdefaults file.
Resources specified in
this file will be made available to only that user's session via
the RESOURCE_MANAGER property.
Resources specified in this file
take precedence over those specified in the desktop default or
system administrator resource files.
</Para>
<Para><Symbol Role="Define">NOTE</Symbol> <Literal>:</Literal> The X Toolkit Intrinsics specifies that it will load resources
for an application from either
<Symbol Role="Define">RESOURCE_MANAGER</Symbol> or from
<Filename>$HOME/.Xdefaults</Filename>, but not both.
Ordinarily, this would mean that
the user's
<Filename>$HOME/.Xdefaults</Filename> file would be ignored.
However, the
session manager accomodates
<Filename>$HOME/.Xdefaults</Filename> by merging it into
the
<Symbol Role="Define">RESOURCE_MANAGER</Symbol> at session startup as described above.
If
a user changes the
<Filename>$HOME/.Xdefaults</Filename>, the changes will not be
visible to new applications until the user invokes the
ReloadResources action.
</Para>
<Para>The ReloadResources action will instruct the session manager to
reload the
<Symbol Role="Define">RESOURCE_MANAGER</Symbol> with the system, system administrator
and user specified resources.
This is useful to make available to
new applications changes made to system administrator or user
specified resource files.
</Para>
</RefSect1>
<RefSect1>
<Title>FILE FORMAT</Title>
<Para>The desktop resource files use X resource syntax.
See
<Filename MoreInfo="RefEntry">X</Filename>(1) for
the precise syntax.
</Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><Filename>/usr/dt/config/$LANG/sys.resources</Filename></Term>
<ListItem>
<Para>The desktop default resources.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/config/$LANG/sys.resources</Filename></Term>
<ListItem>
<Para>System administrator specified resources.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.Xdefaults</Filename></Term>
<ListItem>
<Para>User specified resources.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsession;, &cdeman.dtsessionaction;, <Filename MoreInfo="RefEntry">X</Filename>(1), <Literal>Xlib Resource Manager documentation</Literal>,
<Literal>Xt resource documentation</Literal>.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

8201
cde/doc/C/guides/man/man4/dtsdldtd.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

124
cde/doc/C/guides/man/man4/dtsdlfil.sgm Normal file
View File

@@ -0,0 +1,124 @@
<!-- $XConsortium: dtsdlfil.sgm /main/5 1996/08/31 14:56:06 rws $ -->
<!-- (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.MAN85.rsml.1">
<RefMeta>
<RefEntryTitle>dtsdlfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtsdlfile</Filename></RefName>
<RefPurpose>CDE runtime help volume files
</RefPurpose>
</RefNameDiv>
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Semantic Delivery Language (sdl) files are used for presenting online
information or application specific contextual help information in CDE.
They
are refered to as Help Volumes, and contain the equivalent of a runtime
version of the original, authored help information.
Help Volumes can be
viewed via one of the two CDE help dialog widgets provided as part of the CDE
Development Environment.
</Para>
<RefSect2>
<Title>File Generation</Title>
<Para>Refer to the
&cdeman.dthelptag; man page for detailed information on the creation of <Filename>*.sdl</Filename> files within CDE.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The CDE Help system uses two environment variables for locating
Help volumes and Family files
within the desktop environment:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>DTHELPSEARCHPATH</Emphasis></Term>
<ListItem>
<Para><Emphasis>System</Emphasis> search path environment variable for locating
Help volumes on local and/or remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTHELPUSERSEARCHPATH</Emphasis></Term>
<ListItem>
<Para><Emphasis>Users</Emphasis> search path environment variable for locating user
specific Help volumes on local and/or remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The environment variables contain colon-separated lists of directory paths.
Each directory path can contain environment variable names as well as
special field descriptors that are expanded at runtime.
</Para>
<Para>Field descriptors consist of a <Literal>%</Literal>
followed by a single character.
Field descriptors and their substitution values are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>%H</Literal></Term>
<ListItem>
<Para>This value is replaced with the current volume or Family name being searched
for.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%L</Literal></Term>
<ListItem>
<Para>Replaced with the current value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%%</Literal></Term>
<ListItem>
<Para>Replaced with a single <Literal>%</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The default value for
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> is:
</Para>
<Para><Filename>$HOME/.dt/help/$DTUSERSESSION/%H:$HOME/.dt/help/$DTUSERSESSION/%H.sdl:$HOME/.dt/help/$DTUSERSESSION/%H.hv:$HOME/.dt/help/%H:$HOME/.dt/help/%H.sdl:$HOME/.dt/help/%H.hv</Filename>
</Para>
<Para>The
<Emphasis>DTHELPUSERSEARCH</Emphasis> is first searched for the requested volume.
If
the volume is not found, the
<Emphasis>DTHELPSEARCHPATH</Emphasis> value is searched.
</Para>
<Para>The default value for
<Emphasis>DTHELPSEARCHPATH</Emphasis> path is:
</Para>
<Para><Filename>/etc/dt/appconfig/help/%L/%H:/etc/dt/appconfig/help/%L/%H.sdl:/etc/dt/appconfig/help/%L/%H.hv:/etc/dt/appconfig/help/C/%H:/etc/dt/appconfig/help/C/%H.sdl:/etc/dt/appconfig/help/C/%H.hv:/usr/dt/appconfig/help/%L/%H:/usr/dt/appconfig/help/%L/%H.sdl:/usr/dt/appconfig/help/%L/%H.hv:/usr/dt/appconfig/help/C/%H:/usr/dt/appconfig/help/C/%H.sdl:/usr/dt/appconfig/help/C/%H.hv</Filename>
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtCreateHelpDialog;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.dthelptag;, <Emphasis>CDE Help System Author's and Programmer's Guide</Emphasis>
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

131
cde/doc/C/guides/man/man4/dtsessdb.sgm Normal file
View File

@@ -0,0 +1,131 @@
<!-- $XConsortium: dtsessdb.sgm /main/6 1996/09/08 20:19:12 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. -->
<refentry id="CDE.SESS.dtsessiondb">
<refmeta><refentrytitle>
dtsessiondb
</refentrytitle><manvolnum>special file</manvolnum>
</refmeta>
<refnamediv><refname><filename>dtsessiondb</filename></refname><refpurpose>
format and location of desktop session database</refpurpose></refnamediv>
<refsect1>
<title>DESCRIPTION</title>
<para>During a session checkpoint, the Session Manager creates a database
of its clients and for each client saves the values of the following
properties:
</para>
<simplelist>
<member>
<literal>CurrentDirectory</literal>
</member>
<member>
<literal>Program</literal>
</member>
<member>
<literal>RestartCommand</literal>
</member>
<member>
<literal>CloneCommand</literal>
</member>
<member>
<literal>DiscardCommand</literal>
</member>
<member>
<literal>Environment</literal>
</member>
<member>
<literal>RestartStyleHint</literal>
</member>
</simplelist>
<para>The Session Manager also saves a client's host name and session id.
If a client's screen number is available, the Session Manager
will save the screen number.
</para>
<para>CDEnext session databases (<Filename>dtsession.db</Filename>)
supersede CDE1.0 session databases (described in
&cdeman.dtsessionfile;). The CDEnext Session Manager
can read CDE 1.0 session databases but not write
to them. It will write only to CDEnext session databases.
</para>
<Para>At session startup, the session manager restarts any applications
that were saved as part of the selected session. The system default set of
applications to be restored as part of the user's Initial Session can be found in
/usr/dt/config/$LANG/sys.session. This file should not be edited as
it will be unconditionally overwritten upon subsequent desktop
installations.
</Para>
<Para>A system administrator may replace the set of applications that
are restored as part of the user's Initial Session by creating
a file named /etc/dt/config/$LANG/sys.session. Unlike the resource
files, this file will be used as a complete replacement for the
desktop default file, so it is valid to make a copy of the system
default file and make any necessary modifications.
</Para>
</refsect1>
<refsect1>
<title>FORMAT</title>
<para>The CDEnext Session Manager database format is based upon Xrm and
is as follows:
</para>
<programlisting>! dtsession.db
!
.version: &lt;dtsession version>
.dtsessionID: &lt;dtsession's session ID>
!
Client.&lt;ClientID>: &lt;ClientID>
&lt;ClientID>.SessionID: &lt;client's session ID>
&lt;ClientID>.Program:
&lt;ClientID>.host:
&lt;ClientID>.screen:
&lt;ClientID>.RestartCommand.0:
&lt;ClientID>.RestartCommand.1:
&lt;ClientID>.RestartCommand.&lt;n>:
&lt;ClientID>.CloneCommand.0:
&lt;ClientID>.CloneCommand.1:
&lt;ClientID>.CloneCommand.&lt;n>:
&lt;ClientID>.DiscardCommand.0:
&lt;ClientID>.DiscardCommand.1:
&lt;ClientID>.DiscardCommand.&lt;n>:
&lt;ClientID>.Environment.0:
&lt;ClientID>.Environment.1:
&lt;ClientID>.Environment.&lt;n>:
!
ProxyClient.&lt;proxy_client_num>: &lt;proxy_client_num>
&lt;proxy_client_num>.screen:
&lt;proxy_client_num>.host:
&lt;proxy_client_num>.cmd:
</programlisting>
<para>&lt;ClientID> is a sequential number for the XSMP-based session clients.
&lt;proxy_client_num> is a sequential number for the proxy or ICCCM-based
session clients.
</para>
<para>The <literal>RestartCommand</literal>, <literal>CloneCommand</literal>,
<literal>DiscardCommand</literal>, and <literal>Environment</literal> properties
are of format ARRAY8. To facilitate the storage of these properties, the
Session Manager stores them as separate resources, with appropriate suffixes
for their positions in the array.
</para>
<para>The CDEnext Session Manager includes its version number when it writes a
session database. CDE 1.0 session databases do not contain version information.
</para>
<para>The Session Manager sets only the <literal>_DT_SESSION_HINTS</literal>
property if the started session is from a CDE 1.0 session database.
The CDEnext Window Manager uses the <literal>_DT_SESSION_HINTS</literal>
property if it is defined. It saves this information in its state file.
The Session Manager does not store any window manager
information in its database.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsession;,
&cdeman.dtsessionfile;
</para>
</refsect1>
</refentry>

131
cde/doc/C/guides/man/man4/dtsessio.sgm Normal file
View File

@@ -0,0 +1,131 @@
<!-- $XConsortium: dtsessio.sgm /main/8 1996/09/08 20:19:21 rws $ -->
<!-- (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.MAN86.rsml.1">
<RefMeta>
<RefEntryTitle>dtsessionfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtsessionfile</Filename></RefName>
<RefPurpose>format and location of desktop session files
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note>
<para>CDEnext session databases (<Filename>dtsession.db</Filename>)
supersede CDE1.0 session databases.
The CDEnext Session Manager can read CDE 1.0 session databases but not write
to them. It will write only to CDEnext session databases.
For more information see, &cdeman.dtsessiondb;.
</para>
</note>
<Para>At session startup, the session manager will restart any applications
that were saved as part of the session. The system default set of
applications to be
restored as part of the user's Initial Session can be found in
/usr/dt/config/$LANG/sys.session. This file should not be edited as
it will be unconditionally overwritten upon subsequent desktop
installations.
</Para>
<Para>A system administrator may replace the set of applications that
are restored as part of the user's Initial Session by creating
a file named /etc/dt/config/$LANG/sys.session. Unlike the resource
files, this file will be used as a complete replacement for the
desktop default file, so it is valid to make a copy of the system
default file and make any necessary modifications.
</Para>
</RefSect1>
<RefSect1>
<Title>FILE FORMAT</Title>
<Para>A session file contains a line for each application to be started
during a user's Initial Session. Empty lines or lines beginning with
a "#" are ignored. Each application to be started should have a line
in the session file of the form:
</Para>
<Para>dtsmcmd -cmd "application command line and options"
</Para>
<Para>For example, to start the file manager with options:
</Para>
<Para>dtsmcmd -cmd "/usr/dt/bin/dtfile -dir ~ -geometry +700+0"
</Para>
<Para>More specifically, a session file consists of one or
more SessionLine's:
</Para>
<VariableList>
<VarListEntry>
<Term>SessionLine</Term>
<ListItem>
<Para>= Comment | SessionSpec | &lt;empty line>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Comment</Term>
<ListItem>
<Para>= "#" {&lt;any character except null or newline>}
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>SessionSpec</Term>
<ListItem>
<!-- ex-TP-->
<Para>= "dtsmcmd -cmd " Quote CommandSpec Quote
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Quote</Term>
<ListItem>
<Para>= """
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>CommandSpec</Term>
<ListItem>
<Para>= "&lt;application command line and options>"
</Para>
<Para>Elements separated by vertical bar (|) are alternatives.
Curly braces ({...}) indicate zero or more repetitions of
the enclosed elements. Quotes ("...") are
used around literal characters.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term>/usr/dt/config/$LANG/sys.session</Term>
<ListItem>
<Para>The desktop default set of applications for the
user's Initial Session.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>/etc/dt/config/$LANG/sys.session</Term>
<ListItem>
<Para>System administrator specified set of applications for
the user's Initial Session.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsession;</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

229
cde/doc/C/guides/man/man4/dtspcden.sgm Normal file
View File

@@ -0,0 +1,229 @@
<!-- $XConsortium: dtspcden.sgm /main/6 1996/09/08 20:19:30 rws $ -->
<!-- (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.MAN87.rsml.1">
<RefMeta>
<RefEntryTitle>dtspcdenv</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtspcdenv</Filename></RefName>
<RefPurpose>environment Variable File for the CDE Subprocess Control Service
</RefPurpose>
</RefNameDiv>
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CDE Subprocess Control service provides the
ability for a process running on one system to
invoke another process on a different system.
By default, the environment variables of the
parent process are passed unmodified to the
child process (on the remote host);
however, there are some environment
variables that are given special handling.
In
addition, the user or system administrator can
specify environment variables that should be
modified when they are passed to the child process.
</Para>
<Para>The system-wide environment files are:
<Filename>/etc/dt/config/dtspcdenv</Filename> and
<Filename>/usr/dt/config/dtspcdenv</Filename>
and the user-specific environment file is:
<Filename>$HOME/.dt/dtspcdenv</Filename>.
The file
<Filename>/usr/dt/config/dtspcdenv</Filename> is created
when CDE is installed.
This file may be overwritten
by subsequent CDE installations.
Consequently, local
variable definitions should be placed in the file
<Filename>/etc/dt/config/dtspcdenv</Filename> because this file is not
overwritten during installation.
</Para>
<Para>The environment variable files are evaluated in the following order:
</Para>
<ProgramListing>local host: <Filename>/usr/dt/config/dtspcdenv</Filename>
local host: <Filename>/etc/dt/config/dtspcdenv</Filename>
local host: <Filename>$HOME/.dt/dtspcdenv</Filename>
remote host: <Filename>/usr/dt/config/dtspcdenv</Filename>
remote host: <Filename>/etc/dt/config/dtspcdenv</Filename>
remote host: <Filename>$HOME/.dt/dtspcdenv</Filename>
</ProgramListing>
<Para>The precedence occurs in the reverse order of
evaluation.
Thus, variables in the remote
host's
<Filename>$HOME/.dt/dtspcdenv</Filename> file have the highest
precedence and variables in the local host's
<Filename>/etc/dt/config/dtspcdenv</Filename> file have the lowest
precedence.
In this context, the local host is the
host where a CDE client is running and
the remote host is the host where a remote
process will be started (on behalf of
the local client).
</Para>
<Para>Lines beginning with a numer symbol (#) are considered
comments and are not processed.
</Para>
<Para>The syntax for a non-commented line is:
</Para>
<InformalExample Remap="indent">
<ProgramListing>VAR_NAME=some_value
</ProgramListing>
</InformalExample>
<Para>where
<Emphasis>VAR_NAME</Emphasis> is the name of an
environment variable and
<Emphasis>some_value</Emphasis> is the value assigned to the variable.
</Para>
<Para>If
<Emphasis>some_value</Emphasis> contains a variable reference,
the reference will be replaced by the variable's
value.
For example, if a CDE client has the
following definition in its environment:
</Para>
<InformalExample Remap="indent">
<ProgramListing>PATH=/bin:/sbin:/usr/local/bin
</ProgramListing>
</InformalExample>
<Para>and the following definition occurs in one of the
environment files:
</Para>
<InformalExample Remap="indent">
<ProgramListing>PATH=/opt/foo/bin:$PATH
</ProgramListing>
</InformalExample>
<Para>then before the remote process is executed,
<SystemItem Class="EnvironVar">PATH</SystemItem>
will be expanded to:
</Para>
<InformalExample Remap="indent">
<ProgramListing>PATH=/opt/foo/bin:/bin:/sbin:/usr/local/bin
</ProgramListing>
</InformalExample>
<Para>The environment variable names may consist of
letters, digits or underscores and may be
enclosed in curly braces.
The environment variable files may contain
"unset &lt;variable_name>" commands to prevent
an environment variable from being propagated
to the remote process.
For example, the following line would
prevent the variable
<Emphasis>LIB_PATH</Emphasis> from being
propagated to the remote process:
</Para>
<InformalExample Remap="indent">
<ProgramListing>unset LIB_PATH
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The
<Command>dtspcd</Command> daemon treats the following variables specially:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DISPLAY</SystemItem></Term>
<ListItem>
<Para>If
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> is set to "unix:&lt;n>", "local:&lt;n>" or ":&lt;n>"
(where &lt;n> is the screen number), then before the
remote process is executed,
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> is changed to the name of the local host and
the screen number is preserved.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">HOME</SystemItem></Term>
<ListItem>
<Para>Before the remote process is executed,
<SystemItem Class="EnvironVar">HOME</SystemItem> is set
to the value of the user's home directory in
the password file on the remote host.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">SHELL</SystemItem></Term>
<ListItem>
<Para>If
<SystemItem Class="EnvironVar">SHELL</SystemItem> is not in the parent processes environment,
<SystemItem Class="EnvironVar">SHELL</SystemItem> is set to the value of the user's shell in
the password file on the remote host.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">PWD</SystemItem></Term>
<ListItem>
<Para>The variable
<SystemItem Class="EnvironVar">PWD</SystemItem> is not propagated to
the remote host.
Note that the above variables will be
overridden by their corresponding definitions
in an environment file.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following definition sets the variable
<Emphasis>FOO_BIN_PATH</Emphasis> to the value
<Filename>/var/foo/bin</Filename>: <Literal>FOO_BIN_PATH=/var/foo/bin</Literal></Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><Filename>/usr/dt/config/dtspcdenv</Filename></Term>
<ListItem>
<Para>System-wide, installed environment variable definitions
used when a process is executed
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/config/dtspcdenv</Filename></Term>
<ListItem>
<Para>System-wide, locally defined environment variable definitions
used when a process is executed
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/dtspcdenv</Filename></Term>
<ListItem>
<Para>User-specific environment variable definitions used
when a process is executed
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtspcd;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

236
cde/doc/C/guides/man/man4/dtsrdbfl.sgm Normal file
View File

@@ -0,0 +1,236 @@
<!-- $XConsortium: dtsrdbfl.sgm /main/5 1996/08/30 15:13:01 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.dtsrdbfiles">]]>
<RefMeta>
<RefEntryTitle>dtsrdbfiles</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>dtsrdbfiles</RefName>
<RefPurpose>
Describes the complete set of DtSearch database files
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Each DtSearch database consists of a set of core files
that are created and maintained by the DtSearch offline build tools.
Each database may also include a set of one or more language files
that vary depending on the DtSearch language of the database.
Some language files are part of the DtSearch package but
may also be enhanced by the database developer.
</para>
<para>All database files for a single database must be located in the same
directory. The directory is specified in the offline build tools by the
optional path prefix in the <literal>&minus;d</literal><Symbol Role="Variable">dbname</Symbol> argument. The directory is specified for
the online API by a <systemitem class="environvar">PATH</systemitem>
configuration file (ocf file).
</para>
<refsect2>
<Title>Core Files</Title>
<Para>The base name of the core files is formed by appending a period and
3-character name extension to the 1- to 8-character database name
specified at creation time. Core files are binary and accessible only
via DtSearch programs.
</para>
<para>The DtSearch core files are as follows:
</para>
<variablelist>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.dbe</term>
<listitem>
<para>Database dictionary file. Binary schema created by
<command>dtsrcreate</command> from <filename>dtsearch.dbe</filename>.
Never modified thereafter.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.k00</term>
<listitem>
<para>Main key file for database documents. Created and initialized by
<command>dtsrcreate</command>, updated by <command>dtsrload</command>.
Contains the b-tree of unique keys for each document.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.k01</term>
<listitem>
<para>Optional key file for database documents. Created and initialized by
<command>dtsrcreate</command>. Contains the b-tree of optional keys for
each document. Not currently used.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.d00</term>
<listitem>
<para>Documents header file. Created by <command>dtsrcreate</command>, updated
by <command>dtsrload</command>. Contains the databases configuration
status record and, for each document in the database, a header record
and one or more abstract records.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.d01</term>
<listitem>
<para>Compressed text file. Created by <command>dtsrcreate</command>, but
updated by <command>dtsrload</command> only for AusText type dataases.
Repository of compressed text for each document.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.k21,
<Symbol Role="Variable">dbname</Symbol>.k22,
<Symbol Role="Variable">dbname</Symbol>.k23</term>
<listitem>
<para>Key files for words and stems. Created and initialized by
<command>dtsrcreate</command>, updated by <command>dtsrindex</command>.
Contains the b-tree of each word and stem indexed for the database. The
k21 file finds "short" words, 1 to 15 bytes, in the d21 file. The k22
file finds "long" words, 16 to 39 bytes, in the d22 file. The k23 file
finds "huge" words, 40 to 133 bytes, in the d23 file. Long and huge word
files may not be used depending on the database maximum word size
specified at creation time.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.d21,
<Symbol Role="Variable">dbname</Symbol>.d22,
<Symbol Role="Variable">dbname</Symbol>.d23</term>
<listitem>
<para>Data files for words and stems. Created and initialized by
<command>dtsrcreate</command>, updated by <command>dtsrindex</command>.
For each word contains document counts, offset to inverted index (d99
file), and storage recovery data. The d21 file contains short words, the
d22 file contains long words, and the d23 file contains huge words. Long
and huge word files may not be used depending on the database maximum
word size specified at creation time.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<Title>Language Files</Title>
<Para>Databases also need a set of files associated with the DtSearch language
of the database. When looking for these files DtSearch will first look
for a customized version applicable only to a database, and then look
for the generic language version. Like core files, the base file name of
a customized language file is formed by the database name and a 3
character extension. The alternative generic language files are named
with a language name and the same 3 character extension.
</para>
<para>Language files are mandatory or optional depending on the language.
See &cdeman.dtsrlangfiles; for formats of language files.
</para>
<para>The DtSearch language-related files are as follows:
</para>
<variablelist>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.stp</term>
<listitem>
<para>Stop file. The supported stop files are:
</para>
<simplelist>
<member>
<filename>eng.stp</filename> &minus; for
<systemitem class="constant">DtSrLaENG</systemitem> and
<systemitem class="constant">DtSrLaENG2</systemitem>
</member>
<member>
<filename>esp.stp</filename> &minus; for
<systemitem class="constant">DtSrLaESP</systemitem>
</member>
<member>
<filename>fra.stp</filename> &minus; for
<systemitem class="constant">DtSrLaFRA</systemitem>
</member>
<member>
<filename>deu.stp</filename> &minus; for
<systemitem class="constant">DtSrLaDEU</systemitem>
</member>
<member>
<filename>ita.stp</filename> &minus; for
<systemitem class="constant">DtSrLaITA</systemitem>
</member>
</simplelist>
<para>Stop lists are mandatory for European languages, and
optional for other supported languages.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.inc</term>
<listitem>
<para>An include list is always optional for all supported languages.
There are no generic versions of include lists.
</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>eng.sfx</filename></term>
<listitem>
<para>For<systemitem class="constant">DtSrLaENG</systemitem> and
<systemitem class="constant">DtSrLaENG2</systemitem>.
and is not currently required for other supported languages.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">dbname</Symbol>.knj</term>
<listitem>
<para><filename>jpn.knj</filename> for
<systemitem class="constant">DtSrLaJPN2</systemitem>.
A kanji compounds file is mandatory only for language number 7
<systemitem class="constant">DtSrLaJPN2</systemitem>,
a supported Japanese language.
</para>
</listitem>
</varlistentry>
</variablelist>
<RefSect3>
<Title>Examples</Title>
<para>Files associated with a minimum
<systemitem class="constant">DtSrLaENG</systemitem> database
(English, ASCII) that uses no customized or optional files:
</para>
<programlisting>
All core files plus <filename>eng.stp</filename>, <filename>eng.sfx</filename>.
</programlisting>
<para>Files for a <systemitem class="constant">DtSrLaITA</systemitem>
database (Italian, ISO Latin-1)
with enhanced stop list and an include list:
</para>
<programlisting>
All core files plus <Symbol Role="Variable">dbname</Symbol>.stp, <Symbol Role="Variable">dbname</Symbol>.inc.
</programlisting>
<para>Files associated with a minimum <systemitem class="constant">DtSrLaJPN</systemitem>
database
(Japanese with full, automatic kanji compounding)
that uses no customized or optional files:
</para>
<programlisting>
Only core files.
</programlisting>
<para>Files for a <systemitem class="constant">DtSrLaJPN2</systemitem>
database (Japanese with kanji compounds
from a word list), with optional stop list for ASCII substrings:
</para>
<programlisting>
All core files plus <Symbol Role="Variable">dbname</Symbol>.stp, <filename>jpn.knj</filename>.
</programlisting>
</refsect3>
</refsect2>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsrcreate;,
&cdeman.dtsrload;,
&cdeman.dtsrindex;,
&cdeman.DtSrAPI;,
&cdeman.dtsrlangfiles;,
&cdeman.dtsrocffile;,
&cdeman.DtSearch;
</Para>
</RefSect1>
</RefEntry>

173
cde/doc/C/guides/man/man4/dtsrfzkf.sgm Normal file
View File

@@ -0,0 +1,173 @@
<!-- $XConsortium: dtsrfzkf.sgm /main/6 1996/09/08 20:19:39 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.dtsrfzkfiles">]]>
<RefMeta>
<RefEntryTitle>dtsrfzkfiles</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>dtsrfzkfiles</RefName>
<RefPurpose>
Describes the formats of DtSearch fzk files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
<Symbol Role="Variable">filename</Symbol>.fzk
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>An fzk file contains one or more documents to be loaded into a database
in a simple canonical format. It is read by both
<command>dtsrload</command> and <command>dstrindex</command>. It is
typically a transient file created only for loading and indexing, and
then discarded.
</para>
<refsect2>
<Title>Header Portion</Title>
<para>The header portion of each document in an fzk file consists
of 4 lines of ASCII text, ie 4 ASCII strings, each ending in ASCII
line feed characters (<literal>\n</literal>, 0x0A).
</para>
<para>Line 1 of each document in a DtSearch fzk file must contain
the hard-coded string <literal>0,2\n</literal>.
</para>
<para>Line 2 must contain the string <literal>ABSTRACT:</literal> beginning
in column 1, followed by the text desired to be returned on the results
list when the document is the result of a successful search by the API.
The abstract can contain any desired text up to the maximum length in
bytes specified for the database at creation time. Abstracts are often
displayed to the user after a successful search as an aid in deciding
whether to retrieve the full document. Alternatively abstracts may be a
file name or URL used as a reference by the developer's application to
retrieve the document without further assistance from the search engine.
</para>
<para>Line 3 must contain the unique document key beginning in column 1. A
document key is a text string containing all text up to the linefeed at
the end of the line, up to the maximum database key size specified by
the <systemitem class="constant">DtSrMAX_DB_KEYSIZE</systemitem>
constant. Unique means that if the key already exists in the database,
the load program will replace the document in its entirety by the new
document (an update). If the key does not already exist, the document
will be newly created (an add).
</para>
<para>The first character of the unique document key is called the "keytype".
The search engine has the ability to limit searches to user specified
subsets of keytypes, so keytypes are a logical, second level of database
organization. Typically, keytypes are used by developers to distinguish
document "types" or "sources" in a manner that may be perceived as
meaningful to the application or users.
</para>
<para>Line 4 is the document date. It must begin
in column 1 and conform
to this exact pattern:
</para>
<programlisting>
<emphasis>yy</emphasis>/<emphasis>mm</emphasis>/<emphasis>dd</emphasis>~<emphasis>hh</emphasis>:<emphasis>mm</emphasis>
</programlisting>
<para>The slashes, tilde, and colon are mandatory.
The numeric values are integers based on the Gregorian calendar:
</para>
<variablelist>
<varlistentry><term><emphasis>yy</emphasis></term>
<listitem>
<para>The number of years since 1900.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>mm</emphasis></term>
<listitem>
<para>A month number from 1 to 12.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>dd</emphasis></term>
<listitem>
<para>A day number from 1 to 31, but valid for the indicated month.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>hh</emphasis></term>
<listitem>
<para>A 24-hour clock hour number (military designation),
where "0" is midnight, "13" is one o'clock pm, etc.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>mm</emphasis></term>
<listitem>
<para>The minutes number from "0" to "59".
</para>
</listitem>
</varlistentry>
</variablelist>
<para>The search engine has the ability to limit searches to ranges
of user specified document dates. If Line 4 contains an
invalid date format, the load program will provide
a default document date of the current run date.
Documents may be marked "undated" with the null date string "0/0/0~0:0".
Undated documents always qualify for results lists irrespective
of date range qualifiers in the API search function
<function>DtSearchQuery</function>.
</para>
</refsect2>
<refsect2>
<Title>Text Portion</Title>
<para>All subsequent text (that is, all characters in the fzk file stream after
Line 4 and up to the end-of-record delimiter string) is document text.
The text portion is not presumed to be ASCII nor presumed to
be periodically marked by ASCII linefeeds.
Although typical, it is not strictly necessary that the text
portion of a document in the fzk file be identical for both programs.
</para>
<para><command>dtsrload</command> reads only the text portion for AusText type
databases. It compresses and stores AusText type text in the database
document repository (see &cdeman.dtsrcreate;). In this case,
the text portion should be the exact desired image to be retrieved by
subsequent API retrieval functions. The text portion of a document in an
fzk file for a DtSearch type database is discarded by
<command>dtsrload</command>.
</para>
<para>On the other hand, <command>dtsrindex</command> reads the text portion
for all databases, but only to parse and index words for subsequent API
search functions. Word parsing is performed in the specified language
and linguistic codeset of the database.
</para>
<para>As an example of how the fzk file might be different for
document loading and word parsing, consider a tag-formatted document.
The document in its entirety might be in the text portion
of the fzk file for dtsrload, while the tags might be stripped
from the file for <command>dtsrindex</command>.
</para>
</refsect2>
<refsect2>
<Title>ETX String</Title>
<para>Documents are delimited in an fzk file by a special end-of-text (ETX)
string occurring at the end of the text portion. By convention the ETX
string is an ASCII formfeed character followed by an ASCII linefeed
character (<literal>\f\n</literal>, 0x0C0A). However,
<command>dtsrload</command> and <command>dtsrindex</command> can be
instructed to use a different string by optional command line arguments.
The ETX string is strictly a record separator; it is not considered part
of the text of the previous record and is always discarded.
</para>
</refsect2>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsrcreate;,
&cdeman.dtsrhan;,
&cdeman.dtsrload;,
&cdeman.dtsrindex;,
&cdeman.DtSrAPI;,
&cdeman.DtSearch;
</Para>
</RefSect1>
</RefEntry>

333
cde/doc/C/guides/man/man4/dtsrhanf.sgm Normal file
View File

@@ -0,0 +1,333 @@
<!-- $XConsortium: dtsrhanf.sgm /main/6 1996/09/08 20:19:48 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.dtsrhanfile">]]>
<RefMeta>
<RefEntryTitle>dtsrhanfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>dtsrhanfile</RefName>
<RefPurpose>
Describes the format and syntax of DtSearch han files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
<Symbol Role="Variable">filename</Symbol>.han
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Han files are the user generated profile files for <command>dtsrhan</command>.
They identify fields in incoming text from which output fzk
file fields can be constructed. The data from han files
are loaded into memory by dtsrhan at initialization time.
<command>dtsrhan</command> and han files have not been internationalized;
han files may only contain ASCII characters.
</para>
<refsect2>
<Title>General Format</Title>
<para>All identifiers must begin with a letter, and must be composed entirely
of alphanumerics and/or the underscore.
</para>
<para>Observe the following points when using using "strings":
</para>
<itemizedlist>
<listitem>
<para>If an identifying string contains quotes, use a backslash
to create the quote. Example:
</para>
<programlisting>
this string \"contains\" quotes
</programlisting>
<para>would find the string <literal>this string "contains" quotes</literal>.
</para>
</listitem>
<listitem>
<para>The above point makes it necessary to use double backslashes to create
a single backslash. Example:
</para>
<programlisting>
this string has a \\ backslash
</programlisting>
<para>would find the string <literal>this string has a \ backslash</literal>.
</para>
</listitem>
<listitem>
<para>Actually, using the backslash in any string will cause the next
character to be included without exception. Thus, a string
with <literal>this is \a test</literal> will end up being
<literal>this is a test</literal>.
The backslash is ignored, and the next character is imbedded
in the string. This is only needed in the two cases described
above, but can be used for any purpose.
</para>
</listitem>
</itemizedlist>
</refsect2>
<refsect2>
<Title>Individual Line Syntax</Title>
<variablelist>
<varlistentry><term># ... | blank line</term>
<listitem>
<para>Han file comment. Any line beginning with a pound sign
in the first column, or any blank line, is discarded.
</para>
</listitem>
</varlistentry>
<varlistentry><term>line <emphasis>identifier</emphasis> = <emphasis>physical_line_number</emphasis></term>
<listitem>
<para>Defines a <literal>line</literal> with a physical line number in the record.
<emphasis>physical_line_number</emphasis> must be a number.
</para>
</listitem>
</varlistentry>
<varlistentry><term>line <emphasis>identifier</emphasis> = column_number,"<emphasis>string</emphasis>" [<emphasis>column_number</emphasis>,"<emphasis>string</emphasis>"] ...</term>
<listitem>
<para>Defines a <literal>line</literal> using a column number and a
'signature' string that should appear at that column.
<emphasis>column_number</emphasis> can be a number, or
<literal>*</literal> for 'any column'. "<emphasis>string</emphasis>"
should be a string that occurs on the line in question. It is possible
to define complex signatures using multiple clauses.
</para>
</listitem>
</varlistentry>
<varlistentry><term>field <emphasis>identifier</emphasis> = <emphasis>line_identifier</emphasis>,"<emphasis>string</emphasis>", <emphasis>offset</emphasis>, <emphasis>length</emphasis></term>
<listitem>
<para>Defines a <literal>field</literal> based on a declared line, a string
found on that line, the offset from the first letter of the string, and
the length of field.
</para>
<para><emphasis>line_identifier</emphasis> is an identifier declared with the
<literal>line</literal> directive (see above).
</para>
<para>"<emphasis>string</emphasis>" is a string for relative positioning,
where a field will follow a string that may not always occur in the
same position on a line. If it is known that the field will always be
in the same position, an empty string("") may be used.
<emphasis>string</emphasis> must be enclosed in double quotes.
<emphasis>offset</emphasis> must be a number, identifying the offset
from the first character in the string. It starts at position 1, not 0,
and may be negative.
</para>
<para><emphasis>length</emphasis> represents the length of the field. It may
be a number, or it may be one of two special tokens:
</para>
<variablelist>
<varlistentry><term><literal>eow</literal></term>
<listitem>
<para>End of word. The field will begin at <emphasis>offset</emphasis> and
continue until the next white-space character.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>eoln</literal></term>
<listitem>
<para>End of line. The field will begin at <emphasis>offset</emphasis> and
continue to the end of the line.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>An identifier <emphasis>string</emphasis> beginning with 3 uppercase M's
("MMM...") will be considered an English month name string.
At run time, if the first 3 chars of the field's value
equal the first three chars of an English month name,
the value string will be translated to a two character
string of digits in the range "01" to "12".
For example, if field <emphasis>MMMmymonth</emphasis> had an original value of
"April ", it will be translated to "04" before use.
</para>
<para>In the case where a <literal>line</literal> identifier is associated with
multiple lines in a single document, the field value will
be determined from the last occurrence of the line within
the record.
</para>
</listitem>
</varlistentry>
<varlistentry><term>constant <emphasis>identifier</emphasis> = "<emphasis>string</emphasis>"</term>
<listitem>
<para>Defines a <literal>constant</literal> field that can be used in
abstracts and keys. The <emphasis>identifier</emphasis> is defined
exactly the same as a <literal>field</literal> identifier. The value
must be enclosed in double quotes.
</para>
</listitem>
</varlistentry>
<varlistentry><term>date = null | <emphasis>field_id</emphasis> [+ <emphasis>field_id</emphasis>] ...</term>
<listitem>
<para>Defines the document date for each document. It will
be converted into a correctly formated fzk file date line.
</para>
<para><literal>null</literal> specifies undated documents. Undated documents
always qualify for searches irrespective of date
qualifiers in <function>DtSearchQuery</function>.
</para>
<para><emphasis>field_id</emphasis> is an identifier declared using the <literal>field</literal>
or <literal>constant</literal> directives (see above).
"MMM" fields are often useful for date assemblies.
</para>
<para>Multiple fields may be concatenated into a date.
</para>
<para>After concatenation, the assembled date must be of the following format:
<emphasis>YYYYMMDDhhmm</emphasis> (exactly 12 digits). For example,
<literal>199404171701</literal> is April 17, 1994 at 5:01 pm.
<literal>200405031000</literal> is May 3, 2004, at 10:00 am (10
o'oclock).
</para>
<para>Dates before 1900 or after 5995 are invalid.
</para>
<para>If <literal>date</literal> is not specified or is invalid, a generated date
based on the current date and time will be used, but an
invalid <literal>date</literal> will also generate an error message.
</para>
</listitem>
</varlistentry>
<varlistentry><term>key = <emphasis>field_id</emphasis> [+ <emphasis>field_id</emphasis>] ... | time | count</term>
<listitem>
<para>Defines the unique database key for each record in a fzk file.
</para>
<para><emphasis>field_id</emphasis> is a field identifier declared using the
<literal>field</literal> or <literal>constant</literal> directives.
</para>
<para>Multiple fields may be concatenated into a key.
</para>
<para><literal>time</literal> is a special keyword used to generate keys based
on the current run date and time, plus a sequential count suffix.
</para>
<para><literal>count</literal> is a special keyword used to generate keys
based on a sequential count of records.
</para>
</listitem>
</varlistentry>
<varlistentry><term>upper</term>
<listitem>
<para>Specifies that keys written by handel are to be entirely converted
to upper case. Without using this directive, mixed-case keys
are allowed.
</para>
</listitem>
</varlistentry>
<varlistentry><term>keychar = A | B | ...Z</term>
<listitem>
<para>Defines the character used to categorize keys for DtSearch. It
must be an uppercase ASCII alphabetic character.
</para>
</listitem>
</varlistentry>
<varlistentry><term>delimiter = <emphasis>line_identifer</emphasis>, bottom</term>
<listitem>
<para>Defines the end of text (ETX) delimiter that will separate records.
</para>
<para><emphasis>line_identifier</emphasis> is an identifier declared with the
<literal>line</literal> directive.
</para>
<para><literal>bottom</literal> is required. It specifies that the ETX will
occur at the bottom of each record. Top of record delimiters are not
supported.
</para>
</listitem>
</varlistentry>
<varlistentry><term>image = all | none</term>
<listitem>
<para>Defines whether the document image retrieved by
<function>DtSearchRetrieve</function> is to contain all or none of the
record, prior to application of <literal>imageinclude</literal> or
<literal>imageexclude</literal> directives later in the han file. It
defaults to <literal>all</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term>imageinclude = <emphasis>line_identifier</emphasis> [- <emphasis>line_identifier</emphasis>]</term>
<listitem>
<para>Defines a line (or range of lines) to be included in the image.
<emphasis>line_identifier</emphasis> is an identifier declared with the
<literal>line</literal> directive.
</para>
</listitem>
</varlistentry>
<varlistentry><term>imageexclude = <emphasis>line_identifier</emphasis> [- <emphasis>line_identifier</emphasis>]</term>
<listitem>
<para>Defines a line (or range of lines) to be excluded from the image.
<emphasis>line_identifier</emphasis> is an identifier declared with the
<literal>line</literal> directive.
</para>
</listitem>
</varlistentry>
<varlistentry><term>abstract = field(s) <emphasis>field_identifier</emphasis> [+ <emphasis>field_identifier</emphasis>]...</term>
<listitem>
<para>Defines the abstract to be placed into the fzk file. It is created from
the concatenations of fields. <emphasis>field_identifier</emphasis> is
an identifier declared with the <literal>field</literal> directive.
</para>
</listitem>
</varlistentry>
<varlistentry><term>delblanklines = true | false</term>
<listitem>
<para>Determines if blank lines are to be removed from the record image or
not. It defaults to <literal>false</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<Title>Example</Title>
<para>The sample han file shown here describes a text file containing a
concatenated set of man pages documents.
</para>
<programlisting>
# All records in the incoming text file are delimited by the same
# end of text convention as the default for an fzk file, namely
# a linefeed (control-L) on a line by itself ("\f\n").
# Define a line named "etx" with that description,
# and declare it to be the &lt;delimiter>.
# Note that there must be a real ASCII control-L character between
# the quotes in the line below.
line etx = *,"^L"
delimiter = etx, bottom
# The command name that the man page is describing is on the first line.
# To access it we need to define a line directive for line number 1.
line line1 = 1
# The name of the man page command begins in column 3 of line 1,
# and the length is variable. So we define a field identifier
# named "command1" from column 3 to the end of the word.
field command1 = line1,"",3,eow
# We want each document abstract to have a constant prefix
# followed by the name of the command.
constant preabs = "Man Pages for "
abstract = fields preabs + command1
# We want all keys to be the name of the command, prefixed with
# the same identifying character, an uppercase M.
keychar = M
key = command1
# We want the each document date to be equivalent to the release
# date of the original man pages, which we choose here to hard code
# as November 1, 1994, at 1 o'clock in the afternoon.
constant datecons = "199411011300"
date = datecons
</programlisting>
</refsect2>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsrhan;,
&cdeman.dtsrindex;,
&cdeman.dtsrfzkfiles;,
&cdeman.dtsrlangfiles;,
&cdeman.DtSearch;
</Para>
</RefSect1>
</RefEntry>

139
cde/doc/C/guides/man/man4/dtsrlngf.sgm Normal file
View File

@@ -0,0 +1,139 @@
<!-- $XConsortium: dtsrlngf.sgm /main/6 1996/09/08 20:19:57 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.dtsrlangfiles">]]>
<RefMeta>
<RefEntryTitle>dtsrlangfiles</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>dtsrlangfiles</RefName>
<RefPurpose>
Describes the formats of DtSearch language files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
<Symbol Role="Variable">dbname</Symbol>.stp
<filename>deu.stp</filename>
<filename>eng.stp</filename>
<filename>esp.stp</filename>
<filename>fra.stp</filename>
<filename>ita.stp</filename>
<Symbol Role="Variable">dbname</Symbol>.inc
<Symbol Role="Variable">dbname</Symbol>.knj
<filename>jpn.knj</filename>
<filename>eng.sfx</filename>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The parsing of text into words in a particular language often
requires comparison with lists of specific words in that language.
These lists are maintained on external language files which are used by
both the offline database build programs and the online search API.
Language files mandatory for a particular database must be located
in the same directory as the other database files.
</Para>
<Para>The base file names of language files are used to identify
the language or database to which they apply.
The initialization functions look first for database specific
language files, using the 1- to 8- character database name
as the base file name. Secondly the functions look for
generic files by language base name. Required language files
are provided for supported languages with generic base names.
A developer may edit the generic language file and rename it
to apply to a particular database.
</Para>
<Para>Different types of language files are distinguished by different
file name extensions.
</para>
<refsect2>
<Title>Stop Lists (.stp)</Title>
<para>The file name extension <.stp> is used to identify stop lists.
Stop lists are used to prevent indexing frequently occurring
but semantically unimportant words in a language.
Examples include common prepositions, indefinite articles,
and nonlinguistic character strings.
Stop lists are mandatory for supported European languages.
If a database specific stop list file is not found,
the generic language file must be available in the same
directory as the other database files.
</Para>
<Para>Database specific stop lists are optional for Japanese.
</para>
</refsect2>
<refsect2>
<Title>Include Lists (.inc)</Title>
<para>The file name extension <.inc> is used to identify include lists.
Words found in an include list file are forcibly indexed
even if they would otherwise be discarded. Include lists
take precedence over stop lists. Include list files
are always optional; no generic language defaults are provided.
</para>
</refsect2>
<refsect2>
<Title>Kanji Compounds List (.knj)</Title>
<para>The file name extension <.knj> is used to identify indexable
lists of compound kanji words (that is, substrings of kanji characters
that are indexed both as individual words of one character,
and as a compound word). Currently they apply only to
databases for the specific Japanese Language
<systemitem class="constant">DtSrLaJPN2</systemitem>.
</Para>
<Para>The kanji compounds file is optional. If no database
specific knj file is found, the Japanese language initialization
function will try to open the generic <filename>jpn.knj</filename> file.
If the generic file is also not found,
kanji compounding will not be performed.
</para>
</refsect2>
<refsect2>
<Title>Language Files Format</Title>
<para>Each line of a language file represents one word. The word must begin in
column one and ends at the first ASCII whitespace character or the ASCII
linefeed character (<literal>\n</literal>, 0x0A) that terminates the
line. Any other text on the line after the first word token is discarded
as a comment. Lines that begin with '#', '$', '*', or '!' in column one
are discarded in their entirety as comments. Blank lines (that is, hose
that contain only the terminating linefeed), are also discarded.
</Para>
<Para>The word lists in language files are loaded into memory
at initialization and thereafter referenced internally.
The most efficient processing occurs when the files are
maintained in frequency order (that is, when the most frequently
occurring words in the language are the first words in the file).
Alternatively, if the frequency of occurrence of the words
is not known, it is recommended that the word order
in the file be randomized.
</para>
</refsect2>
<refsect2>
<Title>English Suffixes File</Title>
<para>Stemming of English words is accomplished with the Paice stemming
algorithm. This heuristic algorithm removes common suffixes
in a recurrent manner, and conflates words into a representation
of their etymological root. The suffixes are maintained in
<filename>eng.sfx</filename>
and loaded into memory at initialization. The suffixes file
is mandatory for English language databases and is not editable;
a copy of it must be found in the same directory as every
English language database.
</para>
</refsect2>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsrcreate;,
&cdeman.dtsrindex;,
&cdeman.DtSrAPI;,
&cdeman.dtsrdbfiles;,
&cdeman.DtSearch;
</Para>
</RefSect1>
</RefEntry>

315
cde/doc/C/guides/man/man4/dtsrocfl.sgm Normal file
View File

@@ -0,0 +1,315 @@
<!-- $XConsortium: dtsrocfl.sgm /main/9 1996/10/31 09:47:15 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="CDE.INFO.dtsrocffile">]]>
<RefMeta>
<RefEntryTitle>dtsrocffile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>dtsrocffile</RefName>
<RefPurpose>
Describes the format and syntax of DtSearch ocf files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
<systemitem class="environvar">DTSROCFPATH</systemitem>=<Symbol Role="Variable">directory</Symbol>
<systemitem class="environvar">HOME</systemitem>=<Symbol Role="Variable">directory</Symbol>
<filename>dtsearch.ocf</filename>
<filename>austext.ocf</filename>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>An ocf file is a user-generated file that identifies the databases to be
accessed and the execution options to be enabled by one instance of an
online DtSearch API search engine. Different ocf files typically apply
to different instances of the engine. The file is opened and read by
<function>DtSearchInit</function> and its valid contents apply
throughout an engine session. It may be reread during a session under
certain circumstances referred to as reinitialization, usually caused
either by recognizable changes in database files during the session or
by a change in the ocf file's modification time stamp.
</Para>
<Para>Errors in an ocf file are typically either syntax errors or errors in
databases referred to by the file. While the API expects the ocf file to
be correct, most errors are not fatal. They usually result in a warning
message and discard of the offending directive. But if no databases
survive the initialization process, <function>DtSearchInit</function>
will fail. For this reason, the only mandatory directive in an ocf file
is at least one valid <Symbol>KEYTYPE</Symbol> directive for at least
one valid and accessible database.
</Para>
<Para>The default base file name for an ocf file is
<filename>dtsearch.ocf</filename>, although the alternative name
<filename>austext.ocf</filename> is also a valid default. The file is
expected to be found in the directory specified by the<systemitem class="environvar">DTSROCFPATH</systemitem> environment variable, in the
current working directory, or in the <systemitem class="environvar">HOME</systemitem> directory, in that order. However
the complete path/file name may be fully respecified by an argument to
<function>DtSearchInit</function>.
</Para>
<refsect2>
<Title>General Format</Title>
<para>An ocf file can contain only ASCII characters.
</Para>
<Para>Each line (character string terminated by an ASCII linefeed)
contains 1 or more 'keywords', and optionally 1 or more 'values',
all separated by token delimiter characters.
</Para>
<Para>All token delimiters are equivalent and any combination of one or more
of them is acceptable for separating keywords and values.
Token delimiters are the ASCII space, tab, comma, or equal sign.
</Para>
<Para>Keywords must begin in column 1, and the first character
must be alphanumeric.
</Para>
<Para>Empty lines and lines that begin with <literal>#</literal>,
<Literal>$</Literal>, <literal>*</literal>, or <literal>!</literal> in
column one are discarded in their entirety as comments.
</Para>
<Para>Any additional text beyond the last required value on a line
is ignored as comments.
</Para>
<programlisting>
keyword [keyword] [...] [value] [...] [comments]
</programlisting>
<Para>Keywords and/or values might be case sensitive, but usually are not.
The principal exceptions are database names, which are always
case sensitive, and file names and path names in operating systems
like UNIX where such things are normally case sensitive.
</Para>
<Para>Where a boolean value is required, any of the following are
acceptable. Only enough of the first characters are parsed
to distinguish between alternatives (case-insensitive):
</para>
<informaltable>
<tgroup cols="2">
<colspec align="left" colwidth="1.12in">
<colspec align="left" colwidth="2.49in">
<tbody>
<row>
<entry><para>(On)</para></entry>
<entry><para>(Of)f</para></entry>
</row>
<row>
<entry><para>(T)rue</para></entry>
<entry><para>(F)alse</para></entry>
</row>
<row>
<entry><para>(Y)es</para></entry>
<entry><para>(N)o</para></entry>
</row>
<row>
<entry><para>(E)nabled</para></entry>
<entry><para>(D)isabled</para></entry>
</row>
<row>
<entry><para>(1)</para></entry>
<entry><para>(0)</para></entry>
</row>
</tbody></tgroup></informaltable>
<Para>A missing value is taken for the affirmative.
</Para>
<Para>The initialization function may provide defaults for missing values.
Despite the defaults, an ocf file must be provided with at least the
<literal>KEYTYPE(S)</literal> correctly completed for each database to be
accessed by the engine.
</Para>
<Para>If lines are duplicated or directives conflict, the last
specified value(s) will be used.
</Para>
</refsect2>
<refsect2>
<Title>Keywords and Options</Title>
<variablelist>
<varlistentry><term>KEYTYPES <emphasis>dddd</emphasis> = ['<emphasis>c</emphasis>'] <emphasis>label</emphasis>, ['<emphasis>c</emphasis>'] <emphasis>label</emphasis>, ...</term>
<term>KEYTYPE <emphasis>dddd</emphasis> = ['<emphasis>c</emphasis>'] <emphasis>label</emphasis> [<emphasis>comments</emphasis>]</term>
<listitem>
<para>These are the only required lines in an .ocf file. They identify the
databases to be opened, the keytypes available in each opened database,
and the character that distinguishes that keytype in the record key.
</para>
<para>Keytypes can be specified one at a time by several
<Symbol>KEYTYPE</Symbol> lines, which include a provision for
comments, or grouped together with one or more
<Symbol>KEYTYPES</Symbol> lines. Both <Symbol>KEYTYPE</Symbol> and
<Symbol>KEYTYPES</Symbol> specifications are additive; if some
keytypes have already been specified for a database, the new ones are
merely added to the previously defined ones.
</para>
<variablelist>
<varlistentry><term><emphasis>dddd</emphasis></term>
<listitem>
<para>1- to 8-character dictionary name; case sensitive.
</para>
</listitem>
</varlistentry>
<varlistentry><term>'<emphasis>c</emphasis>'</term>
<listitem>
<para>The keytype character or <emphasis>ktchar</emphasis> for a keytype; a
single, case sensitive, alphanumeric, ASCII character in single quotes.
It identifies the first character of the database record key
corresponding to the desired keytype.
</para>
<para>The <emphasis>ktchar</emphasis> value is optional; if a
<emphasis>ktchar</emphasis> is not specified, the default is the first
character of the label parameter that immediately follows it (described
below). If a user config file specifies a <emphasis>ktchar</emphasis>,
whether in the <emphasis>ktchar</emphasis> parameter or by default, that
cannot be matched to a site file specification, it is ignored. The
<emphasis>ktchar</emphasis> is paired with the subsequent label string.
For example, if "...'r' Old_Records,..." appears in the site ocf file, a
lowercase 'r' will be the <emphasis>ktchar</emphasis> for a record type
labeled in user interfaces as "Old Records".
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>label</emphasis></term>
<listitem>
<para>A 1- to 13-character symbolic string identifying the keytype. No spaces
are allowed in the label string, but underscores will be replaced by
spaces in the name field of the <Symbol>KEYTYPES</Symbol> structure.
The string is used for record type labels in the user interface
application. If there is no preceding <emphasis>ktchar</emphasis>
parameter, the first character of the label is the identifying prefix
character for the record type in record ids.
</para>
<para>Technically, the <emphasis>label</emphasis> parameter is optional
following a <emphasis>ktchar</emphasis> specification. If two adjacent
<emphasis>ktchar</emphasis> values in single quotes are detected, a
generic label for the first one will be created which is derived from
the <emphasis>ktchar</emphasis> value.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term>PATH <emphasis>dddd</emphasis> = <emphasis>path</emphasis></term>
<listitem>
<para>This directive is optional.
</para>
<variablelist>
<varlistentry><term><emphasis>dddd</emphasis></term>
<listitem>
<para>1- to 8-character dictionary name; case sensitive.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>path</emphasis></term>
<listitem>
<para>Where to find the associated database files.
If no path is provided for a database,
the engine assumes the current working directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term>LABEL <emphasis>dddd</emphasis> <emphasis>text</emphasis>...</term>
<listitem>
<para>This directive is optional. It assigns an arbitrary string to the
database name, which will be returned by DtSearchInit and DtSearchReinit
rather than the default 1 to 8 char database file name. It is typically
used to provide an appropriate symbolic label string for a database for
the user interface. Not otherwise used by the search engine.
</para>
<note><para>ALL text on the line immediately after the database name,
except the terminating linefeed, is included in the label.
</para></note>
<variablelist>
<varlistentry><term><emphasis>dddd</emphasis></term>
<listitem>
<para>1- to 8-character dictionary name; case sensitive.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>text</emphasis></term>
<listitem>
<para>The string value stored is all the text
on the rest of the line after the database name.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term>WHITLIM = <emphasis>n</emphasis></term>
<listitem>
<para>This directive is optional. It changes the default value of the words
<Symbol Role="Variable">hitlimit</Symbol> variable in the engine. This
variable will cause a word/stem search to abort if the results list
grows to some ridiculously large value. For extremely large repositories
the default may be too small, and for many smaller repositories it may
be too large. The value of <emphasis>n</emphasis> should be be a
positive integer in the range of a signed long integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<variablelist>
<varlistentry><term><systemitem class="environvar">DTSROCFPATH</systemitem></term>
<listitem>
<para>Optional. Specifies a directory where the ocf file may be located.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">HOME</systemitem></term>
<listitem>
<para>Specifies an alternative directory in which to look for the ocf file if
it is not found in <systemitem class="environvar">DTSROCFPATH</systemitem> or the current working
directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<RefSect1>
<Title>EXAMPLES</Title>
<programlisting>
KEYTYPES xxx = 'A' 'b' 'C' Documents
</programlisting>
<para>Specifies that there are only 4 keytypes in the xxx database, whose keys
each begin with A, b, C, and D, and creates generic user interface
labels for the first three, and the label <literal>Documents</literal>
for the last one.
</para>
<programlisting>
keytype xxx Records
keytypes xxx 'r' Old_Records XYZs
</programlisting>
<para>Specifies that there are 3 keytypes in the xxx database, whose keys each
begin with R, r, and X, and associates them with the labels
<literal>Records</literal>, <literal>Old Records</literal>, and
<literal>XYZs</literal> respectively.
</para>
<programlisting>
PATH xxx = /etc/dtsearch/databases/
</programlisting>
<programlisting>
LABEL helpdesk Level 2 Support Center Documents
</programlisting>
<programlisting>
whitlim = 300000
</programlisting>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtSearchInit;,
&cdeman.DtSrAPI;,
&cdeman.DtSearch;
</Para>
</RefSect1>
</RefEntry>

1071
cde/doc/C/guides/man/man4/dtwmrc.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

80
cde/doc/C/guides/man/man4/genloc.sgm Normal file
View File

@@ -0,0 +1,80 @@
<!-- $XConsortium: genloc.sgm /main/2 1996/09/20 11:11:57 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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDE.INFO.genlocformat">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.INFO.genlocformat">]]>
<RefMeta>
<RefEntryTitle>Generalized Locator Format</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>Generalized Locator Format</RefName>
<RefPurpose>address infolibs as document collections with external navigation references
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
&lt;GLF> ::= &lt;MMDB> | &lt;ULV> | &lt;URI>
&lt;MMDB> ::= mmdb: &lt;IBL> | &lt;IB> | &lt;IL> | &lt;INFOLIB> | &lt;BL> | &lt;BOOKCASE> |
&lt;LOCATOR>
&lt;IBL> ::= &lt;INFOLIB> & &lt;BOOKCASE> & &lt;LOCATOR>
&lt;IB> ::= &lt;INFOLIB> & &lt;BOOKCASE>
&lt;IL> ::= &lt;INFOLIB> & &lt;LOCATOR>
&lt;BL> ::= &lt;BOOKCASE> & &lt;LOCATOR>
&lt;INFOLIB> ::= INFOLIB= &lt;NAME>
&lt;BOOKCASE> ::= BOOKCASE= &lt;NAME>
&lt;LOCATOR> ::= LOCATOR= &lt;ULV> &lt;NAME>
&lt;ULV> ::= uuid_ | xsm_ | isbn_
&lt;NAME> ::= &lt;CHAR> { &lt;CHAR> )
&lt;CHAR> ::= a-z | A-Z | 0-9 | &lt;SPECIAL_CHAR>
&lt;SPECIAL_CHAR> ::= everything but ":" and "&"
&lt;URI> ::= Uniform Resource Identifier (as defined by the Web Consortium)
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>
For the purpose of addressing infolibs as document collections with external navigation references, a generalized
locator format is defined for use in applications and by the end-user. This mechanism is more precise than those that
operate on the DtInfoLib level. This mechanism can be used by applications that want to tightly integrate to their on-
line documentation, within the action system, or for printing specific sections from a command line.
The syntax of a generalized locator format string is defined above.
</Para>
<Para>
As shown above, there are several reserved terms that are used to identify locator format including
<literal>uuid</literal> (for DCE
style Unique ID), <literal>xsm</literal> (for XSession Manager style Unique ID), and
<literal>ISBN</literal> (for International Standard Book
Number). Of these only <literal>xsm</literal> is supported directly in the sample implementation.
</Para>
</RefSect1>
</RefEntry>

114
cde/doc/C/guides/man/man4/ifloadil.sgm Normal file
View File

@@ -0,0 +1,114 @@
<!-- $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>

83
cde/doc/C/guides/man/man4/ifprnial.sgm Normal file
View File

@@ -0,0 +1,83 @@
<!-- $XConsortium: ifprnial.sgm /main/7 1996/08/30 15:16:12 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.DtInfoPrintInfoAtLoc">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.INFO.DtInfoPrintInfoAtLoc">]]>
<RefMeta>
<RefEntryTitle>DtInfo_PrintInfoAtLoc</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">DtInfo_PrintInfoAtLoc</Symbol></RefName>
<RefPurpose>print a section or a list
of sections from an infolib
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>DtInfo_PrintInfoAtLoc
Class: TT_REQUEST
File: <Symbol Role="Variable">temp_file</Symbol>
Operation: DtInfo_PrintInfoAtLoc
Disposition: TT_START
Address: TT_PROCEDURE
Scope: TT_FILE_IN_SESSION
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">DtInfo_PrintInfoAtLoc</Symbol> request
routes print requests back
to the requesting <command>dtinfo</command> process
after the end-user drags one or more
sections from the book list and drops them on the printer icon in the
front panel.
</para>
<para>This message includes a file attribute that defines the
name of a temporary file that contains a list of the sections to be
printed. The syntax of the file list is show below:
</para>
<para><emphasis>section</emphasis>[- <emphasis>section</emphasis>] {, <emphasis>section</emphasis>[- <emphasis>section</emphasis>}
</para>
<para>Each section is represented by a generalized locator. See
&cdeman.DtInfo.ShowInfoAtLoc; for a description
of the generalized locator format.
Sections can be specified using the hyphen character to represent a
range of sections or by a comma-separated list of sections.
</para>
<para>The temporary file is included in the scope to guarantee that the
message is returned to this instance of the <command>dtinfo</command> process.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<para>None.</para>
</RefSect1>
<RefSect1>
<Title>ATTRIBUTES</Title>
<variablelist>
<varlistentry><term>File <symbol role="Variable">temp_file</symbol></term>
<listitem>
<para>Specifies a file path to a temporary file that contains a list
of the sections to be printed.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<para>None.</para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
<Function>DtInfo_ShowInfoAtLoc</Function> 4
</Para>
</RefSect1>
</RefEntry>

46
cde/doc/C/guides/man/man4/ifquit.sgm Normal file
View File

@@ -0,0 +1,46 @@
<!-- $XConsortium: ifquit.sgm /main/8 1996/08/30 15:16: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.DtInfoQuit">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.INFO.DtInfoQuit">]]>
<RefMeta>
<RefEntryTitle>DtInfo_Quit</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">DtInfo_Quit</Symbol></RefName>
<RefPurpose>notice sent by the browser when it exits normally
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>DtInfo_Quit
Class: TT_NOTICE
Operation: DtInfo_Quit
Address: TT_PROCEDURE
Disposition: TT_DISCARD
Scope: TT_SESSION
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">DtInfo_Quit</Symbol> request
is a process-oriented ToolTalk message for observers interested in
the status of <command>dtinfo</command> only. The browser posts
this message when it is exited normally. It is not sent for
desktop session-wide exit.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtInfo.LoadInfoLib;,
<Function>DtInfo_ShowInfoAtLoc</Function> 4
</Para>
</RefSect1>
</RefEntry>

108
cde/doc/C/guides/man/man4/ifshwial.sgm Normal file
View File

@@ -0,0 +1,108 @@
<!-- $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>

158
cde/doc/C/guides/man/man4/mt-libtt.sgm Normal file
View File

@@ -0,0 +1,158 @@
<!-- $XConsortium: mt-libtt.sgm /main/4 1996/08/30 15:17:54 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.TT.mt-libtt">]]>
<RefMeta>
<RefEntryTitle>mt-libtt-intro
</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>mt-libtt-intro</RefName>
<RefPurpose>introduction to multi-thread safe ToolTalk library.
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>To enable developers to write multithreaded applications, the <Filename Role="Header">Tt/tt_c.h</Filename> header defines the following features:
</para>
<programlisting>
typedef enum tt_feature {
_TT_FEATURE_MULTITHREADED = 1, // Thread-safety
_TT_FEATURE_LAST // Enum end marker
} Tt_feature;
</programlisting>
<para>Note that the <systemitem class="constant">TT_FEATURE_MULTITHREADED</systemitem>
value is part of the <literal>libtt</literal> binary interface.
</para>
<para>These features are accessed by calling code with corresponding
<literal>#define</literal> constants:
</para>
<programlisting>
#define TT_FEATURE_MULTITHREADED _TT_FEATURE_MULTITHREADED
</programlisting>
<para>Developers can write multi-threaded applications for ToolTalk without
managing locks around ToolTalk resources explicitly in application code.
Note that threading inside ToolTalk is not supported.
</para>
<para>An extended version of the <filename>Xthreads.h</filename> thread API
wrappers has been used so that multithreaded <filename>libtt</filename>
is easily portable to various thread implementations.
</para>
<para>A process-wide lock is used to protect internal
<filename>libtt</filename> resources. Because few applications spend a
significant amount of their time in <filename>libtt</filename>, a more
fine-grained locking approach is not required.
</para>
<para>A few ToolTalk global values, such as the default
<literal>procid</literal> and the storage stack manipulated by the
<function>tt_mark</function> and <function>tt_release</function> calls,
must have a consistent state as seen by one thread across ToolTalk API
calls. These global values have been made into thread-specific data. The calls
described below are used to initialize this behavior and manipulate the new
data. The other API calls have been modified to reference the
thread-specific value instead of the process-wide value when a
thread-specific value has been set for the current thread. If no
thread-specific value has been set for the current thread, the
process-wide value is used.
</para>
<para>The following ToolTalk API calls implement support for
multithreaded <filename>libtt</filename>:
</para>
<VariableList>
<VarListEntry>
<Term><Function>tt_feature_enabled</Function></Term>
<ListItem>
<Para>Queries the ToolTalk service to see if a specified feature has been
enabled. This allows <filename>libtt</filename> to determine if
multithreaded execution has been enabled by the main program, and to
modify its behavior accordingly.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_feature_required</Function></Term>
<ListItem>
<Para>Declares a feature to be required by the calling code. If the feature is
available, <Function>tt_feature_required</Function> enables it. If the
feature requires the ToolTalk service to perform some initialization
(for example, <systemitem class="constant">TT_FEATURE_MULTITHREADED</systemitem>), the
initialization is performed in this call. Some features (such as
<systemitem class="constant">TT_FEATURE_MULTITHREADED</systemitem>)
require this call to be made before calling
<function>tt_open</function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_procid_session</Function></Term>
<ListItem>
<Para>Returns the identifier of the session in which a
specified procid was opened.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_thread_procid</Function></Term>
<ListItem>
<Para>Returns the current default procid for the currently-active thread.
If there is no default procid set for the thread, then the process
default procid is returned.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_thread_procid_set</Function></Term>
<ListItem>
<Para>Sets the default procid for the currently active thread.
The default procid is an implicit argument to most ToolTalk API calls.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_thread_session</Function></Term>
<ListItem>
<Para>Retrieves the default session identifier for the currently active
thread. If there is no default session set for the currently-active
thread, then the process default session identifier is returned.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Function>tt_thread_session_set</Function></Term>
<ListItem>
<Para>Sets the default session identifier for the currently active thread. The
ToolTalk service uses the initial user session as the default session
and supports one session per procid. The application can make this call
before it calls <function>tt_open</function> to specify which session it
wants to connect to in the active thread.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<para>Note that since the multithreaded feature may not be available on all
platforms, the <Function>tt_feature_enabled</Function> function is
provided to query for the existence of the feature. The intent is that
even platforms that do not enable the multithreaded feature should
implement the thread-related calls, returning <systemitem class="constant">TT_ERR_UNIMP</systemitem>. This allows a run-time check
without unresolved symbol problems.
</para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.feature.enabled;,
&cdeman.tt.feature.required;,
&cdeman.tt.procid.session;,
&cdeman.tt.thread.procid;,
&cdeman.tt.thread.procid.set;,
&cdeman.tt.thread.session;,
&cdeman.tt.thread.session;
</para>
</RefSect1>
</RefEntry>

37
cde/doc/C/guides/man/man4/startlog.sgm Normal file
View File

@@ -0,0 +1,37 @@
<!-- $XConsortium: startlog.sgm /main/4 1996/08/30 15:18:26 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.SM.startlog">]]>
<RefMeta>
<RefEntryTitle>startlog
</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>startlog</Literal></RefName>
<RefPurpose>log processes started by the <literal>Xsession</literal> script
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis><filename>~/.dt/startlog</filename>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <literal>Xsession</literal> script creates the file
<filename>~/.dt/startlog</filename>. It is used to log processes started
by the <literal>Xsession</literal> script. <filename>startlog</filename>
is used only to help diagnose a session startup problem.
</para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsession;
</Para>
</RefSect1>
</RefEntry>

166
cde/doc/C/guides/man/man4/tttracef.sgm Normal file
View File

@@ -0,0 +1,166 @@
<!-- $XConsortium: tttracef.sgm /main/11 1996/09/08 20:20:25 rws $ -->
<!-- (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.MAN99.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>tttracefile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>tttracefile</Filename></RefName>
<RefPurpose>script of settings for ToolTalk tracing
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis><Literal>tttracefile</Literal></Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>A
<Command>tttrace</Command> script contains settings that control ToolTalk calls and messages.
A
<Command>tttrace</Command> script consists of commands separated by semicolons or newlines.
The first command must be the
<Literal>version</Literal> command.
</Para>
<RefSect2>
<Title>Commands</Title>
<Para>If conflicting values are given for a setting, the last value wins.
</Para>
<VariableList>
<VarListEntry>
<Term>version n</Term>
<ListItem>
<!-- ex-TP-->
<Para>The version of the
<Literal>tttracefile</Literal> command syntax used. The current version is 1.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>follow [off | on]</Term>
<ListItem>
<!-- ex-TP-->
<Para>Sets whether to follow all children forked by the traced client or
subsequently started in the traced session. Default is
<Literal>off</Literal>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>[> | >>] outfile</Term>
<ListItem>
<!-- ex-TP-->
<Para>File to be used for the trace output. By default, trace output
goes to standard error. Normal
<Filename MoreInfo="RefEntry">sh</Filename>(1) interpretation of
<Emphasis>></Emphasis> and
<Emphasis>>></Emphasis> applies.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>functions [all | none | func...]</Term>
<ListItem>
<!-- ex-TP-->
<Para>ToolTalk API functions to trace.
<Emphasis>func</Emphasis> may include
<Filename MoreInfo="RefEntry">sh</Filename>(1) wildcard characters. Default is
<Literal>all</Literal>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>attributes [all | none]</Term>
<ListItem>
<!-- ex-TP-->
<Para><Literal>none</Literal> means use only a single line when printing a message on the trace
output.
<Literal>all</Literal> means print all attributes, arguments, and context slots of traced
messages. Default is
<Literal>none</Literal>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>states [none | edge | deliver | dispatch | Tt_state]...</Term>
<ListItem>
<!-- ex-TP-->
<Para>State(s) through which to trace messages. In addition to
the <ComputerOutput>Tt_state</ComputerOutput>s defined in <ComputerOutput>tt_c.h</ComputerOutput>, valid <Symbol Role="Variable">state</Symbol>s
are:
</Para>
<ItemizedList>
<ListItem><Para><ComputerOutput>none</ComputerOutput> - disable all message tracing
</Para></ListItem>
<ListItem><Para><ComputerOutput>edge</ComputerOutput> - messages entering initial (<ComputerOutput>TT_SENT</ComputerOutput>) and final
(<ComputerOutput>TT_HANDLED</ComputerOutput>, <ComputerOutput>TT_FAILED</ComputerOutput>) states.
</Para></ListItem>
<ListItem><Para><ComputerOutput>deliver</ComputerOutput> - all state changes and all client deliveries.
</Para></ListItem>
<ListItem><Para><ComputerOutput>dispatch</ComputerOutput> - <ComputerOutput>deliver</ComputerOutput> + all patterns considered for
matching. (default)
</Para></ListItem>
</ItemizedList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>ops</Literal> <Emphasis>toTrace</Emphasis>...</Term>
<Term><Literal>sender_ptypes</Literal> <Emphasis>toTrace</Emphasis>...</Term>
<Term>handler_ptypes toTrace...</Term>
<ListItem>
<!-- ex-TP-->
<Para>Trace messages that have
<Emphasis>toTrace</Emphasis> as a value for the indicated message attribute.
<Emphasis>toTrace</Emphasis> may include
<Filename MoreInfo="RefEntry">sh</Filename>(1) wildcard characters.
If no
<Emphasis>toTrace</Emphasis> argument is included for a given message attribute, then
no value of that attribute excludes a message from tracing.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
<RefSect2>
<Title>Comments</Title>
<Para>A word beginning with
<Literal>#</Literal> causes that word and all the following characters up to a newline to
be ignored.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>To trace all attribute-getting and -setting messages sent by ptype starting
with "Dt",
</Para>
<VariableList>
<VarListEntry>
<Term></Term>
<ListItem>
<Para><Literal>version</Literal> <ComputerOutput>1</ComputerOutput> <Literal>ops</Literal> <ComputerOutput>Get* Set*</ComputerOutput> <Literal>sender_ptypes</Literal> <ComputerOutput>Dt*</ComputerOutput></Para>
<Para>To trace only ToolTalk function calls (but not messages) in a
process tree,
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term></Term>
<ListItem>
<Para><Literal>version 1; follow on; states none</Literal>
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttsession;, &cdeman.tttrace;, the
<Literal>Session_Trace</Literal>() ToolTalk request
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->