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

113
cde/doc/C/guides/man/man5/Dt.sgm Normal file
View File

@@ -0,0 +1,113 @@
<!-- $XConsortium: Dt.sgm /main/6 1996/09/08 19:58:20 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.MAN318.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN318.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Dt.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Dt.h</Filename></RefName>
<RefPurpose>miscellaneous desktop definitions
</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>#include &lt;Dt/Dt.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Dt.h</Filename> header contains miscellaneous public constant and function declaration
for the &str-XZ; library.
</Para>
<Para>The header defines several constants that can be used to determine
the version of the library used to compile an application
and the version of the library with which
an application is currently linked.
</Para>
<Para>The header defines the following constants
that represent the library compile-time version:
</Para>
<VariableList>
<VarListEntry>
<Term>DtVERSION</Term>
<ListItem>
<Para>An integer specifying the major version number
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtREVISION</Term>
<ListItem>
<Para>An integer specifying the minor version number
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtUPDATE_LEVEL</Term>
<ListItem>
<Para>An integer specifying the patch release level
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtVERSION_NUMBER</Term>
<ListItem>
<Para>An integer combining the major, minor and patch release numbers.
It is derived from the following formula:
</Para>
<InformalExample Remap="indent">
<ProgramListing>(10000&ensp;*&ensp;DtVERSION&ensp;+&ensp;100&ensp;*
DtRevision&ensp;+&ensp;DtUPDATE_LEVEL)
</ProgramListing>
</InformalExample>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtVERSION_STRING</Term>
<ListItem>
<Para>A string containing a description of the version
and the version number
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The header defines the following constants
that represent the library run-time version:
</Para>
<Synopsis>extern int DtVersion
extern char *DtVersionString
</Synopsis>
<Para><Symbol>DtVersion</Symbol> is an integer equivalent to
<SystemItem Class="Constant">DtVERSION_NUMBER</SystemItem> at the time the library was created.
<Symbol>DtVersionString</Symbol> is a string equivalent to
<SystemItem Class="Constant">DtVERSION_STRING</SystemItem> at the time the library was created.
</Para>
<Para>The header declares the following as functions:
</Para>
<Synopsis>Boolean DtInitialize(Display *<Symbol Role="Variable">display</Symbol>,
Widget <Symbol Role="Variable">widget</Symbol>,
char *<Symbol Role="Variable">name</Symbol>,
char *<Emphasis>tool_class</Emphasis>)
Boolean DtAppInitialize(XtAppContext <Emphasis>app_context</Emphasis>,
Display *<Symbol Role="Variable">display</Symbol>,
Widget <Symbol Role="Variable">widget</Symbol>,
char *<Symbol Role="Variable">name</Symbol>,
char *<Emphasis>tool_class</Emphasis>)
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

99
cde/doc/C/guides/man/man5/DtAction.sgm Normal file
View File

@@ -0,0 +1,99 @@
<!-- $XConsortium: DtAction.sgm /main/7 1996/09/08 19:58: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.MAN319.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN319.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Action.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Action.h</Filename></RefName>
<RefPurpose>action service definitions
</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>#include &lt;Dt/Action.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Action.h</Filename> header defines the following
<SystemItem Class="Constant">DtActionStatus</SystemItem> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtACTION_OK
DtACTION_INVALID_ID
DtACTION_INVOKED
DtACTION_DONE
DtACTION_CANCELED
DtACTION_FAILED
DtACTION_STATUS_UPDATE
</ProgramListing>
</InformalExample>
<Para>The header defines the following data type through
<Literal>typedef</Literal>:</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef unsigned long DtActionInvocationID;
</ProgramListing>
</InformalExample>
<Para>The header defines the following callback prototypes:
</Para>
<Synopsis>typedef void (*DtActionCallbackProc)(DtActionInvocationID <Emphasis>id</Emphasis>,
XtPointer <Symbol Role="Variable">client_data</Symbol>,
DtActionArg *<Symbol Role="Variable">args</Symbol>,
int <Emphasis>argCount</Emphasis>,
DtActionStatus <Symbol Role="Variable">status</Symbol>);
</Synopsis>
<Synopsis>typedef void (*DtDbReloadCallbackProc)(XtPointer <Symbol Role="Variable">clientData</Symbol>);
</Synopsis>
<Para>The header defines the following as functions:
</Para>
<Synopsis>void DtDbReloadNotify(DtDbReloadCallbackProc <Symbol Role="Variable">proc</Symbol>,
XtPointer <Symbol Role="Variable">clientData</Symbol>);
</Synopsis>
<Synopsis>void DtDbLoad(void);
</Synopsis>
<Synopsis>Boolean DtActionExists(char *<Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>char *DtActionLabel(char *<Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>char *DtActionDescription(char *<Emphasis>actionName</Emphasis>);
</Synopsis>
<Synopsis>char *DtActionIcon(char *<Emphasis>actionName</Emphasis>);
</Synopsis>
<Synopsis>DtActionInvocationID
DtActionInvoke(Widget <Symbol Role="Variable">w</Symbol>,
char *<Symbol Role="Variable">action</Symbol>,
DtActionFile *<Symbol Role="Variable">args</Symbol>,
int <Emphasis>argCount</Emphasis>,
char *<Emphasis>termOpts</Emphasis>,
char *<Emphasis>execHost</Emphasis>,
char *<Emphasis>contextDir</Emphasis>,
int <Emphasis>useIndicator</Emphasis>,
DtActionCallbackProc <Emphasis>statusUpdateCb</Emphasis>,
XtPointer <Symbol Role="Variable">client_data</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtActionDescription;, &cdeman.DtActionExists;, &cdeman.DtActionIcon;, &cdeman.DtActionInvoke;, &cdeman.DtActionLabel;, &cdeman.DtActionCallbackProc;, &cdeman.DtDbLoad;, &cdeman.DtDbReloadNotify;, &cdeman.dtaction;.</Para>
</RefSect1>
]]>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

73
cde/doc/C/guides/man/man5/DtComboB.sgm Normal file
View File

@@ -0,0 +1,73 @@
<!-- $XConsortium: DtComboB.sgm /main/6 1996/09/08 19:58: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.MAN320.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN320.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/ComboBox.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/ComboBox.h</Filename></RefName>
<RefPurpose>DtComboBox widget definitions
</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>#include &lt;Dt/ComboBox.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/ComboBox.h</Filename> header defines the following structure:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
XmString <Symbol Role="Variable">item_or_text</Symbol>;
int <Symbol Role="Variable">item_position</Symbol>;
} DtComboBoxCallbackStruct;
</ProgramListing>
</InformalExample>
<Para>The header declares the following constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtALIGNMENT_BEGINNING
DtALIGNMENT_CENTER
DtALIGNMENT_END
DtCR_SELECT
DtDROP_DOWN_COMBO_BOX
DtDROP_DOWN_LIST
</ProgramListing>
</InformalExample>
<Para>The header declares the following as functions:
</Para>
<Synopsis>void DtComboBoxAddItem(Widget <Symbol Role="Variable">w</Symbol>,
XmString <Symbol Role="Variable">item</Symbol>,
int <Emphasis>pos</Emphasis>,
Boolean <Emphasis>unique</Emphasis>);
</Synopsis>
<Synopsis>void DtComboBoxDeletePos(Widget <Symbol Role="Variable">w</Symbol>,
int <Emphasis>pos</Emphasis>);
</Synopsis>
<Synopsis>void DtComboBoxSelectItem(Widget <Symbol Role="Variable">w</Symbol>,
XmString <Symbol Role="Variable">item</Symbol>);
</Synopsis>
<Synopsis>void DtComboBoxSetItem(Widget <Symbol Role="Variable">w</Symbol>,
XmString <Symbol Role="Variable">item</Symbol>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

169
cde/doc/C/guides/man/man5/DtDnd.sgm Normal file
View File

@@ -0,0 +1,169 @@
<!-- $XConsortium: DtDnd.sgm /main/6 1996/09/08 19:58:46 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.MAN321.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN321.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Dnd.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Dnd.h</Filename></RefName>
<RefPurpose>Drag and drop definitions
</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>#include &lt;Dt/Dnd.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Dnd.h</Filename> header defines the following enumeration types:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtCR_DND_CONVERT_DATA
DtCR_DND_CONVERT_DELETE
DtCR_DND_DRAG_FINISH
DtCR_DND_TRANSFER_DATA
DtCR_DND_DROP_ANIMATE
</ProgramListing>
</InformalExample>
<Para>The header defines the following enumeration data types,
with at least the following members:
</Para>
<VariableList>
<VarListEntry>
<Term><StructName Role="typedef">DtDndStatus</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">DtDND_SUCCESS</SystemItem>, <SystemItem Class="Constant">DtDND_FAILURE</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">DtDndProtocol</StructName></Term>
<ListItem>
<InformalExample Remap="indent">
<ProgramListing>DtDND_TEXT_TRANSFER = (1L &lt;&lt; 0)
DtDND_FILENAME_TRANSFER = (1L &lt;&lt; 1)
DtDND_BUFFER_TRANSFER = (1L &lt;&lt; 2)
</ProgramListing>
</InformalExample>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The header declares the following structures:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndBuffer {
void *<Emphasis>bp</Emphasis>;
int <Symbol Role="Variable">size</Symbol>;
string <Symbol Role="Variable">name</Symbol>;
} DtDndBuffer;
</ProgramListing>
</InformalExample>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndContext {
DtDndProtocol <Symbol Role="Variable">protocol</Symbol>;
int <Emphasis>numItems</Emphasis>;
union {
XmString *<Symbol Role="Variable">strings</Symbol>;
String *<Emphasis>files</Emphasis>;
DtDndBuffer *<Emphasis>buffers</Emphasis>;
} <Symbol Role="Variable">data</Symbol>;
} DtDndContext;
</ProgramListing>
</InformalExample>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndConvertCallbackStruct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
DtDndContext *<Emphasis>dragData</Emphasis>;
DtDndStatus <Symbol Role="Variable">status</Symbol>;
} DtDndConvertCallbackStruct, *DtDndConvertCallback;
</ProgramListing>
</InformalExample>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndDragFinishCallbackStruct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
DtDndContext *<Emphasis>dragData</Emphasis>;
Widget <Emphasis>sourceIcon</Emphasis>;
} DtDndDragFinishCallbackStruct, *DtDndDragFinishCallback;
</ProgramListing>
</InformalExample>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndTransferCallbackStruct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
Position <Symbol Role="Variable">x</Symbol>, <Symbol Role="Variable">y</Symbol>;
unsigned char <Symbol Role="Variable">operation</Symbol>;
DtDndContext *<Emphasis>dropData</Emphasis>;
Boolean <Emphasis>completeMove</Emphasis>;
DtDndStatus <Symbol Role="Variable">status</Symbol>;
} DtDndTransferCallbackStruct, *DtDndTransferCallback;
</ProgramListing>
</InformalExample>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDndDropAnimateCallbackStruct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
Position <Symbol Role="Variable">x</Symbol>, <Symbol Role="Variable">y</Symbol>;
unsigned char <Symbol Role="Variable">operation</Symbol>;
DtDndContext *<Emphasis>dropData</Emphasis>;
} DtDndDropAnimateCallbackStruct, *DtDndDropAnimateCallback;
</ProgramListing>
</InformalExample>
<Para>The header declares the following as functions:
</Para>
<Synopsis>Widget DtDndCreateSourceIcon(Widget <Symbol Role="Variable">parent</Symbol>,
Pixmap <Symbol Role="Variable">pixmap</Symbol>,
Pixmap <Symbol Role="Variable">mask</Symbol>);
</Synopsis>
<Synopsis>Widget DtDndDragStart(Widget <Emphasis>dragSource</Emphasis>,
XEvent *<Symbol Role="Variable">event</Symbol>,
DtDndProtocol <Symbol Role="Variable">protocol</Symbol>,
Cardinal <Emphasis>numItems</Emphasis>,
unsigned char <Symbol Role="Variable">operations</Symbol>,
XtCallbackList <Emphasis>convertCallback</Emphasis>,
XtCallbackList <Emphasis>dragFinishCallback</Emphasis>,
ArgList <Emphasis>argList</Emphasis>,
Cardinal <Emphasis>argCount</Emphasis>);
</Synopsis>
<Synopsis>Widget DtDndVaDragStart(Widget <Emphasis>dragSource</Emphasis>,
XEvent *<Symbol Role="Variable">event</Symbol>,
DtDndProtocol <Symbol Role="Variable">protocol</Symbol>,
Cardinal <Emphasis>numItems</Emphasis>,
unsigned char <Symbol Role="Variable">operations</Symbol>,
XtCallbackList <Emphasis>convertCallback</Emphasis>,
XtCallbackList <Emphasis>dragFinishCallback</Emphasis>,
...);
</Synopsis>
<Synopsis>void DtDndDropRegister(Widget <Emphasis>dropSite</Emphasis>,
DtDndProtocol <Symbol Role="Variable">protocols</Symbol>,
unsigned char <Symbol Role="Variable">operations</Symbol>,
XtCallbackList <Emphasis>transferCallback</Emphasis>,
ArgList <Emphasis>argList</Emphasis>,
Cardinal <Emphasis>argCount</Emphasis>);
</Synopsis>
<Synopsis>void DtDndVaDropRegister(Widget <Emphasis>dropSite</Emphasis>,
DtDndProtocol <Symbol Role="Variable">protocols</Symbol>,
unsigned char <Symbol Role="Variable">operations</Symbol>,
XtCallbackList <Emphasis>transferCallback</Emphasis>,
...);
</Synopsis>
<Synopsis>void DtDndDropUnregister(Widget <Emphasis>dropSite</Emphasis>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

104
cde/doc/C/guides/man/man5/DtDts.sgm Normal file
View File

@@ -0,0 +1,104 @@
<!-- $XConsortium: DtDts.sgm /main/6 1996/09/08 19:58:55 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.MAN322.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN322.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Dts.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Dts.h</Filename></RefName>
<RefPurpose>data typing definitions
</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>#include &lt;Dt/Dts.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Dts.h</Filename> header declares the following structure:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct _DtDtsAttribute {
char *<Symbol Role="Variable">name</Symbol>;
char *<Symbol Role="Variable">value</Symbol>;
} DtDtsAttribute;
</ProgramListing>
</InformalExample>
<Para>The header declares the following as functions:
</Para>
<Synopsis>DtDtsAttribute **DtDtsBufferToAttributeList(const void *<Symbol Role="Variable">buffer</Symbol>,
const int <Symbol Role="Variable">size</Symbol>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsBufferToAttributeValue(const void *<Symbol Role="Variable">buffer</Symbol>,
const int <Symbol Role="Variable">size</Symbol>,
const char *<Emphasis>attr_name</Emphasis>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsBufferToDataType(const void *<Symbol Role="Variable">buffer</Symbol>,
const int <Symbol Role="Variable">size</Symbol>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsDataToDataType(const char *<Emphasis>filepath</Emphasis>,
const void *<Symbol Role="Variable">buffer</Symbol>,
const int <Symbol Role="Variable">size</Symbol>,
const struct stat *<Emphasis>stat_buff</Emphasis>,
const char *<Emphasis>link_path</Emphasis>,
const struct stat *<Emphasis>link_stat_buff</Emphasis>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>int DtDtsDataTypeIsAction(const char *<Emphasis>datatype</Emphasis>);
</Synopsis>
<Synopsis>char **DtDtsDataTypeNames(void);
</Synopsis>
<Synopsis>DtDtsAttribute **DtDtsDataTypeToAttributeList(const char *<Emphasis>datatype</Emphasis>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsDataTypeToAttributeValue(const char *<Emphasis>datatype</Emphasis>,
const char *<Emphasis>attr_name</Emphasis>,
const char *<Emphasis>opt_name</Emphasis>);
</Synopsis>
<Synopsis>DtDtsAttribute **DtDtsFileToAttributeList(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsFileToAttributeValue(const char *<Emphasis>filepath</Emphasis>,
const char *<Emphasis>attr_name</Emphasis>);
</Synopsis>
<Synopsis>char *DtDtsFileToDataType(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>char **DtDtsFindAttribute(const char *<Emphasis>attr_name</Emphasis>,
const char *<Emphasis>attr_value</Emphasis>);
</Synopsis>
<Synopsis>void DtDtsFreeAttributeList(DtDtsAttribute **<Emphasis>attr_list</Emphasis>);
</Synopsis>
<Synopsis>void DtDtsFreeAttributeValue(char *<Emphasis>attr_value</Emphasis>);
</Synopsis>
<Synopsis>void DtDtsFreeDataType(char *<Emphasis>datatype</Emphasis>);
</Synopsis>
<Synopsis>void DtDtsFreeDataTypeNames(char **<Emphasis>namelist</Emphasis>);
</Synopsis>
<Synopsis>void DtDtsLoadDataTypes(void);
</Synopsis>
<Synopsis>void DtDtsRelease(void);
</Synopsis>
<Synopsis>char *DtDtsSetDataType(const char *<Emphasis>dirpath</Emphasis>,
const char *<Emphasis>datatype</Emphasis>,
const int <Emphasis>override</Emphasis>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

724
cde/doc/C/guides/man/man5/DtEditor.sgm Normal file
View File

@@ -0,0 +1,724 @@
<!-- $XConsortium: DtEditor.sgm /main/8 1996/09/08 19:59:04 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.XCSA.MAN73.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN73.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Editor.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Editor.h</Filename></RefName>
<RefPurpose>editor widget definitions
</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>#include &lt;Dt/Editor.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Editor.h</Filename> header defines structures, enumerations and function prototypes for
the Editor widget class.
</Para>
<Para>The header defines the
<StructName Role="typedef">DtEditorDataFormat</StructName> enumeration data type,
with at least the following members:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_TEXT</Term>
<ListItem>
<Para>The data being transferred is a pointer
to a
<SystemItem Class="Constant">NULL</SystemItem>&minus;terminated string of characters (a <StructName Role="typedef">char *</StructName>).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_WCHAR</Term>
<ListItem>
<Para>The data being transferred is a
wide character string (a <StructName Role="typedef">wchar_t *</StructName>).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_DATA</Term>
<ListItem>
<Para>The data being transferred is a
sized buffer (a
<StructName Role="typedef">DtEditor_DataObj</StructName>).</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The header defines the following structure:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
unsigned int <Symbol Role="Variable">length</Symbol>;
void *<Emphasis>buf</Emphasis>;
} DtEditor_DataObj;
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Variable">length</Symbol> argument is the
size in bytes of the data buffer.
The
<Emphasis>buf</Emphasis> argument is a
pointer to the data buffer.
</Para>
<Para>The
<StructName Role="typedef">DtEditorContentRec</StructName> structure is used to transfer data between
an application and Editor widget.
It indicates the type of data being
transferred along with the actual data.
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
DtEditorDataFormat <Symbol Role="Variable">type</Symbol>;
union {
char <Emphasis>*string</Emphasis>;
wchar_t <Emphasis>*wchar</Emphasis>;
DtEditor_DataObj <Symbol Role="Variable">data</Symbol>;
} <Symbol Role="Variable">value</Symbol>;
} DtEditorContentRec;
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Variable">type</Symbol> argument
indicates the type of data contained in the structure.
The
<Symbol Role="Variable">string</Symbol> argument
points to a
<SystemItem Class="Constant">NULL</SystemItem>&minus;terminated string of characters.
It is valid when
<Symbol Role="Variable">type</Symbol> is
<SystemItem Class="Constant">DtEDITOR_TEXT</SystemItem>. The
<Emphasis>wchar</Emphasis> argument
points to a wide character string.
It is valid when
<Symbol Role="Variable">type</Symbol> is
<SystemItem Class="Constant">DtEDITOR_WCHAR</SystemItem>. The
<Symbol Role="Variable">data</Symbol> argument
is a
<StructName Role="typedef">DtEditor_DataObj</StructName> that contains the size of the
data and a pointer to it.
It is valid when
<Symbol Role="Variable">type</Symbol> is
<SystemItem Class="Constant">DtEDITOR_DATA</SystemItem>.</Para>
<Para>The
<StructName Role="typedef">DtEditorChangeValues</StructName> structure is used optionally to specify
the string to search for and its replacement value for
&cdeman.DtEditorChange;.</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
char *<Emphasis>find</Emphasis>,
char *<Emphasis>changeTo</Emphasis>,
} DtEditorChangeValues;
</ProgramListing>
</InformalExample>
<Para>The
<Emphasis>find</Emphasis> argument
is a text string to locate in an DtEditor widget.
The
<Emphasis>changeTo</Emphasis> argument
is the replacement string for the one or more occurrences of the string
specified in
<Emphasis>find</Emphasis>. It can be
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
<Para>The
<StructName Role="typedef">DtEditorFormatSettings</StructName> structure is used to optionally specify
the left margin setting, right margin setting, and alignment style for
&cdeman.DtEditorFormat;.</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
int <Emphasis>leftMargin</Emphasis>,
int <Emphasis>rightMargin</Emphasis>,
unsigned int <Symbol Role="Variable">alignment</Symbol>,
} DtEditorFormatSettings;
</ProgramListing>
</InformalExample>
<Para>The
<Emphasis>leftMargin</Emphasis> argument
is the column number of the left boundary when formatting text.
Text is not extended to the left of this column.
It must be non-negative.
The
<Emphasis>rightMargin</Emphasis> argument
is the column number of the right boundary when formatting text.
Text is not extended to the right of this column.
It must be larger than
<Emphasis>leftMargin</Emphasis>. The
<Symbol Role="Variable">alignment</Symbol> argument
specifies the style of alignment when formatting text (see the
constants listed in this header).
</Para>
<Para>The
header declares the following variable:
</Para>
<InformalExample Remap="indent">
<ProgramListing>WidgetClass dtEditorWidgetClass;
</ProgramListing>
</InformalExample>
<Para>The
header defines the following constants for use with the
&cdeman.DtEditorChange; function:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_ALL_OCCURRENCES</Term>
<ListItem>
<Para>Change all instances of the find string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_CURRENT_SELECTION</Term>
<ListItem>
<Para>Replace the currently selected text with the replacement string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NEXT_OCCURRENCE</Term>
<ListItem>
<Para>Change the next occurrence of the find string after the insertion
cursor.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following constants for use with the
&cdeman.DtEditorFormat; function:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_FORMAT_ALL</Term>
<ListItem>
<Para>Reformats all the text in a DtEditor.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_FORMAT_PARAGRAPH</Term>
<ListItem>
<Para>Reformats only the paragraph containing the insertion cursor.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_ALIGN_CENTER</Term>
<ListItem>
<Para>Centers each line of text between the left and right margins.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_ALIGN_JUSTIFY</Term>
<ListItem>
<Para>Aligns the text flush with both the left and right margins.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_ALIGN_LEFT</Term>
<ListItem>
<Para>Aligns the text flush with the left margin.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_ALIGN_RIGHT</Term>
<ListItem>
<Para>Aligns the text flush with the right margin.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following constant for use with the
&cdeman.DtEditorGoToLine; function:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_LAST_LINE</Term>
<ListItem>
<Para>Moves the cursor to the beginning of the last line in the widget.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following
<StructName Role="typedef">DtEditorErrorCode</StructName> constants:
</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_NO_ERRORS</Term>
<ListItem>
<Para>The function completed its task without errors.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
<ListItem>
<Para>Not enough system memory is available to complete the task.
]]></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_INVALID_TYPE</Term>
<ListItem>
<Para>The specified type is not a recognized
<StructName Role="typedef">DtEditorDataFormat</StructName> when setting or retrieving contents or the specified
Alignment type is not recognized when formatting text.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_INVALID_RANGE</Term>
<ListItem>
<Para>The starting character position in a text replacement is greater than
the ending character position or the specified Amount To Format
when formatting text is not recognized.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NULL_ITEM</Term>
<ListItem>
<Para>The data buffer is
<SystemItem Class="Constant">NULL</SystemItem> when passing data in a buffer.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
<ListItem>
<Para>The specified size of a data buffer is negative when passing data in a
buffer, or the left and right margin values are illegal when formatting text.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_SPELL_FILTER_FAILED</Term>
<ListItem>
<Para>The
<Function>DtEditor</Function> function cannot successfully execute the filter specified by the
<SystemItem Class="Resource">DtNspellFilter</SystemItem> resource.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NO_TMP_FILE</Term>
<ListItem>
<Para>The
<Function>DtEditor</Function> function cannot create a temporary file in the directory returned by
<Function>tmpnam</Function>3S. ]]></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_INVALID_FILENAME</Term>
<ListItem>
<Para>No file was specified.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NONEXISTENT_FILE</Term>
<ListItem>
<Para>The file specified for reading does not exist.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_UNREADABLE_FILE</Term>
<ListItem>
<Para>The file specified is unreadable for an unspecified reason.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_READ_ONLY_FILE</Term>
<ListItem>
<Para>The file is read only.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NULLS_REMOVED</Term>
<ListItem>
<Para>The file contained embedded
<SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
]]></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
<ListItem>
<Para>The file cannot be accessed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_DIRECTORY</Term>
<ListItem>
<Para>The file specified is a directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
<ListItem>
<Para>The file specified is a character-special device.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
<ListItem>
<Para>The file specified is a block-mode device.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_UNWRITABLE_FILE</Term>
<ListItem>
<Para>The application does not have write permission for the file or directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_WRITABLE_FILE</Term>
<ListItem>
<Para>The specified file exists and the
<Emphasis>overwriteIfExists</Emphasis> flag is set to
False.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_SAVE_FAILED</Term>
<ListItem>
<Para>The contents of the widget could not be saved for an unspecified reason.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following
enumeration values as reasons for the
<SystemItem Class="Resource">DtNtextSelectCallback</SystemItem>:</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_TEXT_SELECT</Term>
<ListItem>
<Para>Some text has been selected within the edit window (that is, the selection
has become non-
<SystemItem Class="Constant">NULL</SystemItem>).</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_TEXT_DESELECT</Term>
<ListItem>
<Para>No text is selected within the edit window (that is, the selection
has become
<SystemItem Class="Constant">NULL</SystemItem>).</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following constants as reasons for the
<SystemItem Class="Resource">XmNhelpCallback</SystemItem>:</Para>
<VariableList>
<VarListEntry>
<Term>DtEDITOR_HELP_EDIT_WINDOW</Term>
<ListItem>
<Para>The help request originated in the edit window.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_STATUS_LINE</Term>
<ListItem>
<Para>The help request originated in the status line.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_STATUS_CURRENT_LINE</Term>
<ListItem>
<Para>The help request originated from the Current Line Number
display in the status line.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_STATUS_TOTAL_LINES</Term>
<ListItem>
<Para>The help request originated from the Total Lines display in
the status line.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_STATUS_MESSAGE</Term>
<ListItem>
<Para>The help request originated from the Message field in the
status line.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_STATUS_OVERSTRIKE</Term>
<ListItem>
<Para>The help request originated from the Overstrike indicator
in the status line.
]]></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_FORMAT_DIALOG</Term>
<ListItem>
<Para>The help request originated from the Help button in the
Format Settings dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_FORMAT_LEFT_MARGIN</Term>
<ListItem>
<Para>The help request originated from the Left Margin field in
the Format Settings dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_FORMAT_RIGHT_MARGIN</Term>
<ListItem>
<Para>The help request originated from the Right Margin Field in
the Format Settings dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_FORMAT_ALIGNMENT</Term>
<ListItem>
<Para>The help request originated from the Alignment buttons in the Format Settings
dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_CHANGE_DIALOG</Term>
<ListItem>
<Para>The help request originated from the Help button in the Find/Change dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_CHANGE_FIND</Term>
<ListItem>
<Para>The help request originated from the Find field in the Find/Change dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_CHANGE_CHANGE</Term>
<ListItem>
<Para>The help request originated from the Change To field in the Find/Change dialog.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_SPELL_DIALOG</Term>
<ListItem>
<Para>The help request originated from the Help button in the Spell dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_SPELL_MISSPELLED_WORDS</Term>
<ListItem>
<Para>The help request originated from the list of misspelled words in the Spell dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>DtEDITOR_HELP_SPELL_CHANGE</Term>
<ListItem>
<Para>The help request originated from the Change To field in the Spell dialog.
]]></Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
header defines the following as functions:
</Para>
<Synopsis>Widget DtCreateEditor(Widget <Symbol Role="Variable">parent</Symbol>,
char *<Symbol Role="Variable">name</Symbol>,
ArgList <Symbol Role="Variable">arglist</Symbol>,
Cardinal <Symbol Role="Variable">argcount</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorAppend(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorAppendFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
char *<Emphasis>fileName</Emphasis>);
</Synopsis>
<Synopsis>Boolean DtEditorChange(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorChangeValues *<Emphasis>findChangeStrings</Emphasis>,
unsigned int <Emphasis>instanceToChange</Emphasis>);
</Synopsis>
<Synopsis>Boolean DtEditorCheckForUnsavedChanges(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorClearSelection(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorCopyToClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorCutToClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorDeleteSelection(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorDeselect(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<![ %CDE.C.CDE; [
<Synopsis>void DtEditorDisableRedisplay(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>void DtEditorEnableRedisplay(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
]]>
<Synopsis>Boolean DtEditorFind(Widget <Symbol Role="Variable">widget</Symbol>,
char * <Emphasis>find</Emphasis>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorFormat(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorFormatSettings *<Emphasis>formatSettings</Emphasis>,
unsigned int <Emphasis>amountToFormat</Emphasis>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorGetContents(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorContentRec *<Symbol Role="Variable">data</Symbol>,
Boolean <Emphasis>hardCarriageReturns</Emphasis>,
Boolean <Emphasis>markContentsAsSaved</Emphasis>);
</Synopsis>
<Synopsis>XmTextPosition DtEditorGetInsertionPosition(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>XmTextPosition DtEditorGetLastPosition(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Para><![ %CDE.C.CDE; [</Para>
<Synopsis>Widget DtEditorGetMessageTextFieldID(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Para>]]></Para>
<Synopsis>void DtEditorGetSizeHints(Widget <Symbol Role="Variable">widget</Symbol>,
XSizeHints *<Emphasis>pHints</Emphasis>);
</Synopsis>
<Synopsis>void DtEditorGoToLine(Widget <Symbol Role="Variable">widget</Symbol>,
int <Emphasis>lineNumber</Emphasis>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorInsert(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorInsertFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
char *<Emphasis>fileName</Emphasis>);
</Synopsis>
<Synopsis>void DtEditorInvokeFindChangeDialog(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>void DtEditorInvokeFormatDialog(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Para><![ %CDE.C.CDE; [</Para>
<Synopsis>DtEditorErrorCode DtEditorInvokeSpellDialog(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Para>]]></Para>
<Synopsis>Boolean DtEditorPasteFromClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorReplace(Widget <Symbol Role="Variable">widget</Symbol>,
XmTextPosition <Symbol Role="Variable">startPos</Symbol>,
XmTextPosition <Symbol Role="Variable">endPos</Symbol>,
DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorReplaceFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
XmTextPosition <Symbol Role="Variable">startPos</Symbol>,
XmTextPosition <Symbol Role="Variable">endPos</Symbol>,
char *<Emphasis>fileName</Emphasis>);
</Synopsis>
<Para><![ %CDE.C.CDE; [</Para>
<Synopsis>void DtEditorReset(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Para>]]></Para>
<Synopsis>DtEditorErrorCode DtEditorSaveContentsToFile(Widget <Symbol Role="Variable">widget</Symbol>,
char *<Emphasis>fileName</Emphasis>,
Boolean <Emphasis>overwriteIfExists</Emphasis>,
Boolean <Emphasis>hardCarriageReturns</Emphasis>,
Boolean <Emphasis>markContentsAsSaved</Emphasis>);
</Synopsis>
<Synopsis>Boolean DtEditorSelectAll(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorSetContents(Widget <Symbol Role="Variable">widget</Symbol>,
DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
</Synopsis>
<Synopsis>DtEditorErrorCode DtEditorSetContentsFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
char *<Emphasis>fileName</Emphasis>);
</Synopsis>
<Synopsis>void DtEditorSetInsertionPosition(Widget <Symbol Role="Variable">widget</Symbol>,
XmTextPosition <Symbol Role="Variable">position</Symbol>);
</Synopsis>
<Synopsis>void DtEditorTraverseToEditor(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
<Synopsis>Boolean DtEditorUndoEdit(Widget <Symbol Role="Variable">widget</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtCreateEditor;, &cdeman.DtEditor;,
&cdeman.DtEditorAppend;,
&cdeman.DtEditorAppendFromFile;,
&cdeman.DtEditorChange;,
&cdeman.DtEditorCheckForUnsavedChanges;,
&cdeman.DtEditorClearSelection;,
&cdeman.DtEditorCopyToClipboard;,
&cdeman.DtEditorCutToClipboard;,
&cdeman.DtEditorDeleteSelection;,
&cdeman.DtEditorDeselect;, &cdeman.DtEditorFind;,
&cdeman.DtEditorFormat;,
&cdeman.DtEditorGetContents;,
&cdeman.DtEditorGetInsertionPosition;,
&cdeman.DtEditorGetLastPosition;,
&cdeman.DtEditorGetMessageTextFieldID;,
&cdeman.DtEditorGetSizeHints;,
&cdeman.DtEditorGoToLine;, &cdeman.DtEditorInsert;,
&cdeman.DtEditorInsertFromFile;,
&cdeman.DtEditorInvokeFindChangeDialog;,
&cdeman.DtEditorInvokeFormatDialog;,
&cdeman.DtEditorInvokeSpellDialog;,
&cdeman.DtEditorPasteFromClipboard;,
&cdeman.DtEditorReplace;,
&cdeman.DtEditorReplaceFromFile;,
&cdeman.DtEditorReset;,
&cdeman.DtEditorSaveContentsToFile;,
&cdeman.DtEditorSelectAll;,
&cdeman.DtEditorSetContents;,
&cdeman.DtEditorSetContentsFromFile;,
&cdeman.DtEditorSetInsertionPosition;,
&cdeman.DtEditorTraverseToEditor;,
&cdeman.DtEditorUndoEdit;.</Para>
</RefSect1>
]]>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

144
cde/doc/C/guides/man/man5/DtHelp.sgm Normal file
View File

@@ -0,0 +1,144 @@
<!-- $XConsortium: DtHelp.sgm /main/7 1996/09/08 19:59: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.XCSA.MAN74.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN74.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Help.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Help.h</Filename></RefName>
<RefPurpose>help services definitions
</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>#include &lt;Dt/Help.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Help.h</Filename> header defines the variables and function prototypes for help services.
</Para>
<Para>The
header defines the following
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>windowHint</Emphasis> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_POPUP_WINDOW
DtHELP_CURRENT_WINDOW
DtHELP_NEW_WINDOW
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Emphasis>hyperType</Emphasis> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_LINK_JUMP_NEW
DtHELP_LINK_TOPIC
DtHELP_LINK_MAN_PAGE
DtHELP_LINK_APP_DEFINE
DtHELP_LINK_TEXT_FILE
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<StructName Role="typedef">DtHelpDialogCallbackStruct</StructName> <Symbol Role="Variable">reason</Symbol> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtCR_HELP_LINK_ACTIVATE
DtCR_HELP_CLOSE
DtCR_HELP_HELP
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<Symbol>DtNScrollBarPolicy</Symbol> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_NO_SCROLLBARS
DtHELP_STATIC_SCROLLBARS
DtHELP_AS_NEEDED_SCROLLBARS
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<SystemItem Class="Resource">DtNhelpType</SystemItem> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_TYPE_TOPIC
DtHELP_TYPE_STRING
DtHELP_TYPE_MAN_PAGE
DtHELP_TYPE_FILE
DtHELP_TYPE_DYNAMIC_STRING
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<SystemItem Class="Resource">DtNpaperSize</SystemItem> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_PAPERSIZE_LETTER
DtHELP_PAPERSIZE_LEGAL
DtHELP_PAPERSIZE_EXECUTIVE
DtHELP_PAPERSIZE_A4
DtHELP_PAPERSIZE_B5
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<Function>DtHelpQuickDialogGetChild</Function> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_QUICK_CLOSE_BUTTON
DtHELP_QUICK_PRINT_BUTTON
DtHELP_QUICK_HELP_BUTTON
DtHELP_QUICK_SEPARATOR
DtHELP_QUICK_MORE_BUTTON
DtHELP_QUICK_BACK_BUTTON
</ProgramListing>
</InformalExample>
<Para>The
header defines the following
<Function>DtHelpReturnSelectedWidgetId</Function> constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtHELP_SELECT_ERROR
DtHELP_SELECT_VALID
DtHELP_SELECT_ABORT
DtHELP_SELECT_INVALID
</ProgramListing>
</InformalExample>
<Para>The
header declares the following as functions:
</Para>
<Synopsis>void DtHelpSetCatalogName(char *<Emphasis>catFile</Emphasis>);
</Synopsis>
<Synopsis>int DtHelpReturnSelectedWidgetId(Widget <Symbol Role="Variable">parent</Symbol>,
Cursor <Symbol Role="Variable">cursor</Symbol>,
Widget *<Symbol Role="Variable">widget</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.HelpDialog.h;, &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 23:40:24-->

61
cde/doc/C/guides/man/man5/DtHelpDi.sgm Normal file
View File

@@ -0,0 +1,61 @@
<!-- $XConsortium: DtHelpDi.sgm /main/7 1996/09/08 19:59: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.XCSA.MAN75.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN75.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/HelpDialog.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/HelpDialog.h</Filename></RefName>
<RefPurpose>DtHelpDialog definitions
</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>#include &lt;Dt/HelpDialog.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/HelpDialog.h</Filename> header defines the variables and function prototypes for
help dialog services.
</Para>
<Para>The
<Filename Role="Header">Dt/HelpDialog.h</Filename> header declares the following variable:
</Para>
<InformalExample Remap="indent">
<ProgramListing>WidgetClass dtHelpDialogWidgetClass;
</ProgramListing>
</InformalExample>
<Para>The
header declares the following as a function:
</Para>
<Synopsis>Widget DtCreateHelpDialog(Widget <Symbol Role="Variable">parent</Symbol>,
char *<Symbol Role="Variable">name</Symbol>,
ArgList *<Symbol Role="Variable">arglist</Symbol>,
Cardinal <Symbol Role="Variable">argcount</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Help.h;, &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 23:40:24-->

61
cde/doc/C/guides/man/man5/DtHelpQD.sgm Normal file
View File

@@ -0,0 +1,61 @@
<!-- $XConsortium: DtHelpQD.sgm /main/7 1996/09/08 19:59: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.XCSA.MAN76.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN76.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/HelpQuickD.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/HelpQuickD.h</Filename></RefName>
<RefPurpose>DtHelpQuickDialog definitions
</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>#include &lt;Dt/HelpQuickD.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/HelpQuickD.h</Filename> header defines the variables and function prototypes for
help quick dialog services.
</Para>
<Para>The
<Filename Role="Header">Dt/HelpQuickD.h</Filename> header declares the following variable:
</Para>
<InformalExample Remap="indent">
<ProgramListing>WidgetClass dtHelpQuickDialogWidgetClass;
</ProgramListing>
</InformalExample>
<Para>The
header declares the following as a function:
</Para>
<Synopsis>Widget DtCreateHelpQuickDialog(Widget <Symbol Role="Variable">parent</Symbol>,
char *<Symbol Role="Variable">name</Symbol>,
Arg *<Symbol Role="Variable">arglist</Symbol>,
Cardinal <Symbol Role="Variable">argcount</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Help.h;, &cdeman.Dt.HelpDialog.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 23:40:24-->

86
cde/doc/C/guides/man/man5/DtInfoLib.sgm Normal file
View File

@@ -0,0 +1,86 @@
<!-- $XConsortium: infolib.sgm /main/7 1996/09/08 19:54:11 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.dtinfolib">]]>
<RefMeta>
<refentrytitle>DtInfoLib</refentrytitle>
<manvolnum>file format</manvolnum></refmeta>
<refnamediv>
<refname><command>DtInfoLib</command></refname>
<refpurpose>collection of book cases for browsing with <command>dtinfo</command>
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
<command>DtInfo_LoadInfoLib</command>
Criteria:
DATA_ATTRIBUTES_NAME: DtInfoLib
NAME_PATTERN: ?*.dti*
CONTENT: 0 filename .oli
MODE: d|l
LINK_NAME: ?*.dti*
Attributes:
TYPE_LABEL: DtInfoLib
DESCRIPTION: On-line documentation for the Information Manager.
ICON: Dtinlib
PROPERTIES: NULL
ACTIONS: Open
IS_TEXT: false (could be true for criteria 2 match)
INSTANCE_ICON Field: [available for publisher-supplied or user's infolib icon]
</Synopsis>
</RefSynopsisDiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>DtInfoLib</command> is a desktop object representing a
collection of book cases of documents that can be accessed through the
CDE Information Manager. <command>DtInfoLib</command> data criteria and
data attributes are identified for use by desktop facilities. These are
part of the CDE built-in data types.
</para>
<para><command>DtInfoLib</command> is a directory that contains the collection
of book cases available for a given information library. The contents of
the <command>DtInfoLib</command> directory are not visible to the
end-user through the desktop. The <command>DtInfoLib</command> object
can be launched directly by double-clicking on the associated icon or by
dragging the icon on to the Information Manager icon in the File Manager
or on the Front Panel.
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>If defined, the environment variable <systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem> may be used to find
the default infolib (or infolibs) for the system. If provided, the
<command>dtinfo</command> command line argument given with the
<literal>-l</literal> option overrides the environment. If none of the
other path mechanisms are used, the browser uses the standard CDE path.
</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>Double-clicking on the <command>DtInfoLib</command> object, or selecting
<literal>Open</literal> from the objects select menu invokes the
<literal>Open</literal> action on the object.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>The default location for the desktop on line documentation library is
<filename>/usr/dt/infolib/%L</filename>.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtinfo;,
&cdeman.dtinfogen;,
&cdeman.dtinfoBook.dtd;,
&cdeman.DtMmdbBookCaseGetInfo;,
&cdeman.DtMmdbInfoLibInfo;
</Para>
</refsect1></refentry>

48
cde/doc/C/guides/man/man5/DtMenuBu.sgm Normal file
View File

@@ -0,0 +1,48 @@
<!-- $XConsortium: DtMenuBu.sgm /main/6 1996/09/08 19:59:40 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.MAN323.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN323.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/MenuButton.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/MenuButton.h</Filename></RefName>
<RefPurpose>DtMenuButton widget definitions
</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>#include &lt;Dt/MenuButton.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/MenuButton.h</Filename> header defines the following constant:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtCR_CASCADING
</ProgramListing>
</InformalExample>
<Para>The header declares the following as a function:
</Para>
<Synopsis>Widget DtCreateMenuButton(Widget <Symbol Role="Variable">parent</Symbol>,
String <Symbol Role="Variable">name</Symbol>,
ArgList <Symbol Role="Variable">arglist</Symbol>,
Cardinal <Symbol Role="Variable">argcount</Symbol>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

59
cde/doc/C/guides/man/man5/DtMrm.sgm Normal file
View File

@@ -0,0 +1,59 @@
<!-- $XConsortium: DtMrm.sgm /main/2 1996/10/28 15:49:01 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="CDEMX.XCSA.dtmrm">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.dtmrm">]]>
<RefMeta>
<RefEntryTitle>Dt/Mrm.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Mrm.h</Filename></RefName>
<RefPurpose>initializing widgets for URM facilities
</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>#include &lt;Dt/Mrm.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>
The top-level routine <function>DtMrmIntialize</function> is normally accessible to
and used by an application at runtime to access URM facilities.</para>
<para>
<function>DtMrmIntialize</function> must be called in order to prepare an application to
use URM widget fetching facilities for CDE Dt widgets. It is analogous to the
<function>MrmInitialize</function> routine for Motif widgets.</para>
<para>
<function>DtMrmIntialize</function> initializes the internal data
structures (creating the mapping from class codes to the creation
routine for each builtin widget class) which URM needs in order to
successfully perform type conversion on arguments, and successfully
access widget creation facilities. <function>DtMrmIntialize</function> must be called before
any widgets are created, whether by URM's fetch mechanisms or directly
by the application. It may be called before or after <function>XtInitialize</function>, and
multiple calls after the first one are benign (no-ops).</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>
&cdeman.DtMrmInitialize;.
</Para>
</RefSect1>
</RefEntry>

97
cde/doc/C/guides/man/man5/DtMsgLog.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: DtMsgLog.sgm /main/4 1996/10/28 14:50:45 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="CDEMX.XCSA.dtmsglog">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.dtmsglog">]]>
<RefMeta>
<RefEntryTitle>Dt/MsgLog.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/MsgLog.h</Filename></RefName>
<RefPurpose>message logging definitions
</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>#include &lt;Dt/MsgLog.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/MsgLog.h</Filename> header defines data types and function prototypes for
the Message Logging Service.
</Para>
<para>
The <Filename Role="Header">Dt/MsgLog.h</Filename> header provides
the following data type declarations:
</para>
<Synopsis>
typedef enum {
DtMsgLogInformation,
DtMsgLogStderr,
DtMsgLogDebug,
DtMsgLogWarning,
DtMsgLogError
} DtMsgLogType;
</Synopsis>
<Synopsis>
typedef void (*DtMsgLogHandler) (
const char *<Symbol Role="Variable">program_name</Symbol>,
DtMsgLogType <Symbol Role="Variable">msg_type</Symbol>,
const char *<Symbol Role="Variable">format</Symbol>,
va_list <Symbol Role="Variable">args</Symbol> );
</Synopsis>
<Para>The <Filename Role="Header">Dt/MsgLog.h</Filename> header defines the following functions:
</Para>
<Synopsis>
void DtMsgLogMesssage(
const char *<Symbol Role="Variable">program_name</Symbol>,
DtMsgLogType <Symbol Role="Variable">msg_type</Symbol>,
const char *<Symbol Role="Variable">format</Symbol>,
&hellip;);
</Synopsis>
<Synopsis>
DtMsgLogHandler DtMsgLogSetHandler(
DtMsgLogHandler <Symbol Role="Variable">handler</Symbol>;
</Synopsis>
<Synopsis>
FILE *DtMsgLogOpenFile(
const char *<Symbol Role="Variable">type</Symbol>,
char **<Symbol Role="Variable">filename_return</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>
&cdeman.DtMsgLogMessage;,
&cdeman.DtMsgLogSetHandler;, and
&cdeman.DtMsgLogOpenFile;.
</Para>
</RefSect1>
]]>
</RefEntry>

421
cde/doc/C/guides/man/man5/DtPrint.sgm Normal file
View File

@@ -0,0 +1,421 @@
<!-- $XConsortium: DtPrint.sgm /main/2 1996/10/28 13:39:32 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="CDEMX.XCSA.dtprint">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.dtprint">]]>
<RefMeta>
<RefEntryTitle>Dt/Print.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Print.h</Filename></RefName>
<RefPurpose>print definitions
</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>#include &lt;Dt/Print.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Print.h</Filename> header defines resource names, resource values,
callback reasons, callback structures, and function prototypes for
the Print widget class.
</Para>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header defines
the following resource names:
</para>
<variablelist>
<varlistentry>
<term>DtNcancelCallback</term>
<listitem><para>cancelCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNclosePrintDisplayCallback</term>
<listitem><para>closePrintDisplayCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNcopies</term>
<listitem><para>copies</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNdescription</term>
<listitem><para>description</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNdestroyContextCallback</term>
<listitem><para>destroyContextCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNfileName</term>
<listitem><para>fileName</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNminimizeButtons</term>
<listitem><para>minimizeButtons (if not otherwise named)</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNoptionCount</term>
<listitem><para>optionCount</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNoptions</term>
<listitem><para>options</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNprintCallback</term>
<listitem><para>printCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNprintDestination</term>
<listitem><para>printDestination</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNprinterInfoProc</term>
<listitem><para>printerInfoProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNprinterName</term>
<listitem><para>printerName</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNprintSetupMode</term>
<listitem><para>printSetupMode</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNselectFileProc</term>
<listitem><para>selectFileProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNselectPrinterProc</term>
<listitem><para>selectPrinterProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNsetupCallback</term>
<listitem><para>setupCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNverifyPrinterProc</term>
<listitem><para>verifyPrinterProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtNworkAreaLocation</term>
<listitem><para>workAreaLocation</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCCancelCallback</term>
<listitem><para>CancelCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCClosePrintDisplayCallback</term>
<listitem><para>ClosePrintDisplayCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCCopies</term>
<listitem><para>Copies</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCDescription</term>
<listitem><para>Description</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCDestroyContextCallback</term>
<listitem><para>DestroyContextCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCFileName</term>
<listitem><para>FileName</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCMinimizeButtons</term>
<listitem><para>MinimizeButtons (if not otherwise named)</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCOptionCount</term>
<listitem><para>OptionCount</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCOptions</term>
<listitem><para>Options</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCPrintCallback</term>
<listitem><para>PrintCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCPrintDestination</term>
<listitem><para>PrintDestination</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCPrinterInfoProc</term>
<listitem><para>PrinterInfoProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCPrinterName</term>
<listitem><para>PrinterName</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCPrintSetupMode</term>
<listitem><para>PrintSetupMode</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCSelectFileProc</term>
<listitem><para>SelectFileProc</para></listitem>
</varlistentry>
<varlistentry>
<term></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term>DtCSelectPrinterProc</term>
<listitem><para>SelectPrinterProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCSetupCallback</term>
<listitem><para>SetupCallback</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCVerifyPrinterProc</term>
<listitem><para>VerifyPrinterProc</para></listitem>
</varlistentry>
<varlistentry>
<term>DtCWorkAreaLocation</term>
<listitem><para>WorkAreaLocation</para></listitem>
</varlistentry>
<varlistentry>
<term>DtRPrintSetupProc</term>
<listitem><para>PrintSetupProc</para></listitem>
</varlistentry>
</variablelist>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
<systemitem class="resource">DtNsetupMode</systemitem> resource:
</para>
<programlisting>
<systemitem class="constant">DtPRINT_SETUP_PLAIN</systemitem>
<systemitem class="constant">DtPRINT_SETUP_XP</systemitem>
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
<systemitem class="resource">DtNworkAreaLocation</systemitem> resource:
</para>
<programlisting>
<systemitem class="constant">DtWORK_AREA_NONE</systemitem>
<systemitem class="constant">DtWORK_AREA_TOP</systemitem>
<systemitem class="constant">DtWORK_AREA_TOP_AND_BOTTOM</systemitem>
<systemitem class="constant">DtWORK_AREA_BOTTOM</systemitem>
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
<systemitem class="resource">DtNprintDestination</systemitem> resource:
</para>
<programlisting>
<systemitem class="constant">DtPRINT_NO_DESTINATION</systemitem>
<systemitem class="constant">DtPRINT_TO_PRINTER</systemitem>
<systemitem class="constant">DtPRINT_TO_FILE</systemitem>
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
<systemitem class="resource">DtNprinterNameMode</systemitem> resource:
</para>
<programlisting>
<systemitem class="constant">DtSHORT_NAME</systemitem>
<systemitem class="constant">DtMEDIUM_NAME</systemitem>
<systemitem class="constant">DtLONG_NAME</systemitem>
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following mode values for
<function>DtPrintSetupBoxResetConnection()</function>:
</para>
<programlisting>
typedef enum {
DtPRINT_CLOSE_CONNECTION,
DtPRINT_RELEASE_CONNECTION
} DtPrintResetConnectionMode;
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following
callback reasons:
</para>
<programlisting>
DtPRINT_CR_NONE
DtPRINT_CR_CANCEL
DtPRINT_CR_CLOSE_PRINT_DISPLAY
DtPRINT_CR_PRINT
DtPRINT_CR_SETUP
</programlisting>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following
return values for the <command>DtPrint</command> procedure:
</para>
<programlisting>
DtPRINT_SUCCESS,
DtPRINT_BAD_PARM,
DtPRINT_FAILURE,
DtPRINT_INVALID_DISPLAY,
DtPRINT_NOT_XP_DISPLAY,
DtPRINT_NO_CONNECTION,
DtPRINT_NO_DEFAULT,
DtPRINT_NO_DEFAULT_DISPLAY,
DtPRINT_NO_PRINTER,
DtPRINT_PRINTER_MISSING
</programlisting>
<variablelist>
<varlistentry><term><systemitem class="constant">DtPRINT_SUCCESS</systemitem></term>
<listitem>
<para>The X printer connection was successfully obtained.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_BAD_PARM</systemitem></term>
<listitem>
<para>The value passed for <symbol role="Variable">print_data</symbol>
is <symbol role="define">NULL</symbol>, or the value of the
<systemitem class="resource">DtNprintSetupMode</systemitem>
resource for <symbol role="Variable">wid</symbol> is not
<systemitem class="constant">DtPRINT_SETUP_XP</systemitem>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_FAILURE</systemitem></term>
<listitem>
<para>The X printer connection failed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_INVALID_DISPLAY</systemitem></term>
<listitem>
<para>The indicated X print server could not be found.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_NOT_XP_DISPLAY</systemitem></term>
<listitem>
<para>The indicated X server does not support the X Printing Extension.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_NO_CONNECTION</systemitem></term>
<listitem>
<para>An open X print server connection is not currently being
managed by the <function>DtPrintSetupBox</function>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_NO_PRINTER</systemitem></term>
<listitem>
<para>The indicated printer could not be found on the X print server, or a
default printer could not be determined.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following class record
constants:
</para>
<programlisting>
WidgetClass dtPrintSetupBoxWidgetClass;
_DtPrintSetupBoxClassRec * DtPrintSetupBoxWidgetClass;
_DtPrintSetupBoxRec * DtPrintSetupBoxWidget;
</programlisting>
<Para>The header defines the following callback prototypes:
</Para>
<Synopsis>
typedef struct _DtPrintSetupData
{
String <Symbol Role="Variable">printer_name</Symbol>;
Display *<Symbol Role="Variable">print_display</Symbol>;
XPContext <Symbol Role="Variable">print_context</Symbol>;
XtEnum <Symbol Role="Variable">destination</Symbol>;
String <Symbol Role="Variable">dest_info</Symbol>;
} DtPrintSetupData;
</Synopsis>
<Synopsis>
typedef struct _DtPrintSetupCallbackStruct
{
int <Symbol Role="Variable">reason</Symbol>;
XEvent <Symbol Role="Variable">*event</Symbol>;
DtPrintSetupData <Symbol Role="Variable">*print_data</Symbol>;
} DtPrintSetupCallbackStruct;
</Synopsis>
<Para>The header defines the following functions:</Para>
<Synopsis>
Widget DtCreatePrintSetupBox(
Widget <Symbol Role="Variable">p</Symbol>,
String <Symbol Role="Variable">name</Symbol>,
ArgList <Symbol Role="Variable">args</Symbol>,
Cardinal <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>
Widget DtCreatePrintSetupDialog(
Widget <Symbol Role="Variable">ds_p</Symbol>,
String <Symbol Role="Variable">name</Symbol>,
ArgList <Symbol Role="Variable">sb_args</Symbol>,
Cardinal <Symbol Role="Variable">sb_n)</Symbol>;
</Synopsis>
<Synopsis>
DtPrintSetupData* DtPrintCopySetupData(
DtPrintSetupData* <Symbol Role="Variable">target</Symbol>,
const DtPrintSetupData* <Symbol Role="Variable">source</Symbol>);
</Synopsis>
<Synopsis>
XtEnum DtPrintFillSetupData(
Widget <Symbol Role="Variable">psub</Symbol>,
DtPrintSetupData* <Symbol Role="Variable">print_data</Symbol>);
</Synopsis>
<Synopsis>
void DtPrintFreeSetupData(
DtPrintSetupData* <Symbol Role="Variable">target</Symbol>);
</Synopsis>
<Synopsis>
XtEnum DtPrintResetConnection(
Widget <Symbol Role="Variable">psub</Symbol>,
DtPrintResetConnectionMode <Symbol Role="Variable">m</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>
&cdeman.DtCreatePrintSetupBox;,
&cdeman.DtCreatePrintSetupDialog;,
&cdeman.DtPrintCopySetupData;,
&cdeman.DtPrintFillSetupData;,
&cdeman.DtPrintFreeSetupData;,
&cdeman.DtPrintResetConnection;,
&cdeman.DtPrintSetupBox;,
&cdeman.Print;, and
&cdeman.dtprintinfo;.
</Para>
</RefSect1>
]]>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

47
cde/doc/C/guides/man/man5/DtSaver.sgm Normal file
View File

@@ -0,0 +1,47 @@
<!-- $XConsortium: DtSaver.sgm /main/7 1996/08/31 14:46: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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN77.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN77.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Saver.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Saver.h</Filename></RefName>
<RefPurpose>screen saver definitions
</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>#include &lt;Dt/Saver.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Saver.h</Filename> header defines the following as a function:
</Para>
<Synopsis>Boolean DtSaverGetWindows(Display *<Symbol Role="Variable">display</Symbol>,
Window **<Symbol Role="Variable">window</Symbol>,
int *<Symbol Role="Variable">count</Symbol>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtSaverGetWindows;</Para>
</RefSect1>
]]>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

51
cde/doc/C/guides/man/man5/DtSessio.sgm Normal file
View File

@@ -0,0 +1,51 @@
<!-- $XConsortium: DtSessio.sgm /main/6 1996/08/31 14:46:20 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.XCSA.MAN78.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN78.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Session.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Session.h</Filename></RefName>
<RefPurpose>session management services definitions
</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>#include &lt;Dt/Session.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Session.h</Filename> header defines the following as functions:
</Para>
<Synopsis>Boolean DtSessionSavePath(Widget <Symbol Role="Variable">widget</Symbol>,
char **<Emphasis>save_path</Emphasis>,
char **<Emphasis>save_file</Emphasis>);
</Synopsis>
<Synopsis>Boolean DtSessionRestorePath(Widget <Symbol Role="Variable">widget</Symbol>,
char **<Emphasis>restore_path</Emphasis>,
char *<Emphasis>restore_file</Emphasis>);
</Synopsis>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtSessionSavePath;, &cdeman.DtSessionRestorePath;.</Para>
</RefSect1>
]]>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

81
cde/doc/C/guides/man/man5/DtSpinBo.sgm Normal file
View File

@@ -0,0 +1,81 @@
<!-- $XConsortium: DtSpinBo.sgm /main/6 1996/09/08 19:59: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.MAN324.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN324.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/SpinBox.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/SpinBox.h</Filename></RefName>
<RefPurpose>DtSpinBox widget definitions
</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>#include &lt;Dt/SpinBox.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/SpinBox.h</Filename> header defines the following structure:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct {
int <Symbol Role="Variable">reason</Symbol>;
XEvent *<Symbol Role="Variable">event</Symbol>;
Widget <Symbol Role="Variable">widget</Symbol>;
Boolean <Symbol Role="Variable">doit</Symbol>;
int <Symbol Role="Variable">position</Symbol>;
XmString <Symbol Role="Variable">value</Symbol>;
Boolean <Symbol Role="Variable">crossed_boundary</Symbol>;
} DtSpinBoxCallbackStruct;
</ProgramListing>
</InformalExample>
<Para>The header declares the following constants:
</Para>
<InformalExample Remap="indent">
<ProgramListing>DtARROWS_FLAT_BEGINNING
DtARROWS_FLAT_END
DtARROWS_SPLIT
DtARROWS_BEGINNING
DtARROWS_END
DtARROWS_SENSITIVE
DtARROWS_DECREMENT_SENSITIVE
DtARROWS_INCREMENT_SENSITIVE
DtARROWS_INSENSITIVE
DtNUMERIC
DtALIGNMENT_BEGINNING
DtALIGNMENT_CENTER
DtALIGNMENT_END
DtCR_SPIN_NEXT
DtCR_SPIN_PRIOR
</ProgramListing>
</InformalExample>
<Para>The header declares the following as functions:
</Para>
<Synopsis>void DtSpinBoxAddItem(Widget <Symbol Role="Variable">w</Symbol>,
XmString <Symbol Role="Variable">item</Symbol>,
int <Emphasis>pos</Emphasis>);
</Synopsis>
<Synopsis>void DtSpinBoxDeletePos(Widget <Symbol Role="Variable">w</Symbol>,
int <Emphasis>pos</Emphasis>);
</Synopsis>
<Synopsis>void DtSpinBoxSetItem(Widget <Symbol Role="Variable">w</Symbol>,
XmString <Symbol Role="Variable">item</Symbol>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

658
cde/doc/C/guides/man/man5/DtStdApp.sgm Normal file
View File

@@ -0,0 +1,658 @@
<!-- $XConsortium: DtStdApp.sgm /main/11 1996/09/08 19:59: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. -->
<RefEntry Id="CDEMX.MAN103.rsml.1">
<RefMeta>
<RefEntryTitle>DtStdAppFontNames</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol>DtStdAppFontNames</Symbol></RefName>
<RefPurpose>&str-XZ; Standard Application Font Names
</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><Anchor XRefLabel="DtStdAppFontNames" Role="3" Id="CDEMX.MAN103.anch.1">
<!--WARNING: USED TO BE A PARAGRAPH:-->
The &str-XZ; Standard Application Font Names are a set of generic X Window
System font names, usable by applications as their default
fonts, for the most common categories of type designs and styles.
These names, for at least six sizes of 13 typefaces,
must be provided on all &str-XZ;
systems, and they should be provided in any
X&ensp;server product on which &str-XZ; applications are expected to run.
They are typically mapped to existing fonts on the system
using the font alias mechanism, although this method is not required.
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>&str-XZ; 1.0 does not come with a common set of fonts on all vendors'
systems, and both &str-XZ; itself and &str-XZ; applications must be able to run
on X&ensp;servers and X terminals from non-&str-XZ; vendors if those vendors so
desire.
Therefore, there are a standard set of ``generic'' font names
and sizes that each &str-XZ; vendor makes available on their &str-XZ; systems and
that X&ensp;server vendors may make available on their X&ensp;servers and
terminals.
The names map to existing fonts on each vendor's system,
which may vary from vendor to vendor.
</Para>
<Para>The &str-XZ; Standard Application Font Names described here allow
applications to use a single set of default font specifications in their
<Emphasis>app-defaults</Emphasis> files, without concern for the system
or X&ensp;server
on which &str-XZ; is running.
These
<Emphasis>app-defaults</Emphasis> application defaults are given as XLFD font name patterns that will
match the standard &str-XZ; font names on all &str-XZ; systems.
This allows
application developers both to reduce their concern with selecting
their default fonts from a varying set of fonts on different &str-XZ;
systems and to make use of the system default fonts.
</Para>
<RefSect2>
<Title>Background</Title>
<Para>Application fonts are the fonts used within an application, where a
wide variety of text designs, styles, weights and point sizes are useful.
These variations are used for emphasis, cross-references,
section headers, and so forth.
There are thousands of fonts available in the
market for use in applications, and different &str-XZ; systems will have
different fonts.
The standard names attempt to provide the minimum
variety in generic designs, styles and sizes that an application might
want to use as defaults.
(The &str-XZ; Standard Interface Font Names, described in
&cdeman.DtStdInterfaceFontNames;, provide a similar mechanism for the elements of the &str-XZ; desktop itself.)
</Para>
<Para>Common application font names prevent applications
from needing different
<Emphasis>app-defaults</Emphasis> files on each &str-XZ; system.
The Standard Application Font Names
allow applications to use a single
<Emphasis>app-defaults</Emphasis> file across all &str-XZ; systems.
In addition, any X&ensp;server or X
terminal vendor may ensure that &str-XZ; applications can run on their
X&ensp;server by mapping these standard application names to fonts of the
corresponding style on their individual X systems.
</Para>
</RefSect2>
<RefSect2>
<Title>Rationale</Title>
<Para>Two of the most common design variations in fonts used to display text
are the presence or absence of serifs and the choice between
proportional or regularly spaced (mono-spaced) characters.
Combining these two design variations yields four ``generic'' font
designs, or families:
</Para>
<ItemizedList>
<ListItem>
<Para>serif proportionally-spaced
</Para>
</ListItem>
<ListItem>
<Para>sans serif proportionally-spaced
</Para>
</ListItem>
<ListItem>
<Para>serif mono-spaced
</Para>
</ListItem>
<ListItem>
<Para>sans serif mono-spaced
</Para>
</ListItem>
</ItemizedList>
<Para>Common examples of these four designs are:
</Para>
<ItemizedList>
<ListItem>
<Para>Times Roman
</Para>
</ListItem>
<ListItem>
<Para>Helvetica
</Para>
</ListItem>
<ListItem>
<Para>Courier
</Para>
</ListItem>
<ListItem>
<Para>Lucida Sans Typewriter
</Para>
</ListItem>
</ItemizedList>
<Para>Each of these designs typically come, for text fonts,
in four styles (combinations of weight and slant):
</Para>
<ItemizedList>
<ListItem>
<Para>plain
</Para>
</ListItem>
<ListItem>
<Para>bold
</Para>
</ListItem>
<ListItem>
<Para>italic
</Para>
</ListItem>
<ListItem>
<Para>bold-italic
</Para>
</ListItem>
</ItemizedList>
<Para>The four styles of each of the four design variations yield 16 generic
font variations.
These 16 generic fonts are among the most commonly
used in general desktop computing.
For example, taking the first three
real examples above (Times Roman, Helvetica, Courier), these 12 fonts,
along with the Symbol font, constitute the so-called ``Adobe 13'' that
is a de facto minimum set of fonts in the PostScript community in the
desktop computer marketplace.
</Para>
<Para>In some cases, applications do not care about the exact font family or
name to be used, but do need to use a mono-spaced font, a sans serif
font or a serif font.
This &str-XZ; mechanism allows such applications to
be freed from the need to be concerned about the exact font names that
may or may not be present on a particular &str-XZ; system.
</Para>
</RefSect2>
<RefSect2>
<Title>The Standard Names for the Latin-1 Character Set</Title>
<Para>The 13 standard application font names are provided on all &str-XZ; systems
only for the
ISO 8859
(Latin-1) character set.
These represent 12
generic design and style variations (serif and sans serif
proportionally-spaced, and a mono-spaced font that is either serif or
sans serif), as well as a symbol font.
These standard names are
provided in addition to the ``real'' names of the fonts that the
standard names are mapped to for a particular &str-XZ; system.
An additional four standard font names, to allow both serif and sans serif
designs in a mono-spaced font, may also be provided by a &str-XZ; system.
</Para>
</RefSect2>
<RefSect2>
<Title>XLFD Field Values for the Standard Application Font Names</Title>
<Para>The standard names are available using the X Window System XLFD font
naming scheme.
There are three aspects to the standard names:
</Para>
<ItemizedList>
<!-- merged from xo+cde-->
<ListItem>
<Para>The
<Emphasis>underlying font</Emphasis> on each system,
or X&ensp;server platform,
to which a standard name is mapped,
typically will be different on each system.
</Para>
</ListItem>
<ListItem>
<Para>The
<Emphasis>standard name</Emphasis> itself, a full XLFD name mapped to the underlying font,
may be different on each system in some of the XLFD fields.
However, most of the fields are the same from system to system,
allowing the
<Emphasis>patterns</Emphasis> (described next) to be the same.
</Para>
</ListItem>
<ListItem>
<Para>The font resource
<Symbol Role="Variable">pattern</Symbol> containing the * wildcards, used in
<Emphasis>app-defaults</Emphasis> files,
which will match the full XLFD name of the standard name,
is the same across all systems, for a given use in an
<Emphasis>app-defaults</Emphasis> file.
</Para>
</ListItem>
</ItemizedList>
<Para>Each &str-XZ; or X&ensp;server vendor implementing this specification
must provide full XLFD names for the standard names, mapped to
system-dependent underlying fonts,
so that the XLFD patterns used in &str-XZ; application
<Emphasis>app-defaults</Emphasis> files will always match one of the full XLFD names provided.
</Para>
<Para>The Standard Application Font Names are identified by the presence of
the following XLFD field name values:
</Para>
<ItemizedList>
<!-- merged from xo+cde-->
<ListItem>
<Para><SystemItem Class="Constant">FOUNDRY</SystemItem> is
<Literal>dt</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">FAMILY_NAME</SystemItem> is
<Literal>application</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">WEIGHT_NAME</SystemItem> is
<Literal>medium</Literal> or
<Literal>bold</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">SLANT</SystemItem> is
<Literal>r</Literal> or
<Literal>i</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">SETWIDTH</SystemItem> is
<Literal>normal</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">ADD_STYLE</SystemItem> is
<Literal>sans</Literal> for sans serif,
<Literal>serif</Literal> for serif
</Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">SPACING</SystemItem> is
<Literal>p</Literal> or
<Literal>m</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">CHARSET_REGISTRY</SystemItem> is
<Literal>iso8859</Literal></Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Constant">CHARSET_ENCODING</SystemItem> is
<Literal>1</Literal></Para>
</ListItem>
</ItemizedList>
<Para>Although
<Literal>sans</Literal> and
<Literal>serif</Literal> are not required by the XLFD font
convention, they are always part of the standard &str-XZ; font names.
</Para>
</RefSect2>
<RefSect2>
<Title>Point Sizes</Title>
<Para>The complete set of point sizes available for each of the standard
application font names is determined by the set of fonts included in a
system, whether bitmapped only or both bitmapped and scalable outline.
The minimum set of sizes required and available on
all &str-XZ; systems corresponds to the standard sizes of bitmapped fonts
that make up the default mapping for X11R5:
8, 10, 12, 14, 18 and 24.
</Para>
<Para>For example, the entire set of six sizes of the plain monospaced font, on
any &str-XZ; system, is represented by:
</Para>
<InformalExample Remap="indent">
<ProgramListing>-dt-application-medium-r-normal-*-*-80-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-100-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-120-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-140-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-180-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-240-*-*-m-*-iso8859-1
</ProgramListing>
</InformalExample>
<Para>These patterns will match the corresponding standard font name on any
&str-XZ; system, even though the
<SystemItem Class="Constant">PIXEL_SIZE</SystemItem> and
<SystemItem Class="Constant">AVERAGE_WIDTH</SystemItem> numeric
fields may be different on various systems, and the matched fonts may
be either serif or sans serif, depending on the implementation
of the set of standard names.
The
<SystemItem Class="Constant">RESOLUTION</SystemItem> fields in the XLFD names of the underlying fonts, when
those fonts are bitmapped fonts, must match the resolution
of the monitor on which the fonts are displayed for the
point sizes to be accurate.
To provide expected point size
behavior for applications, systems should ensure that the
<SystemItem Class="Constant">RESOLUTION_X</SystemItem> and
<SystemItem Class="Constant">RESOLUTION_Y</SystemItem> fields of the underlying
fonts vary no more than 20% from the real monitor
resolution of the displays on which the fonts will be used.
</Para>
<Para>Applications requesting point sizes different from the six in the minimum
set may obtain either ``scaled bitmapped'' fonts of the requested
design, or scaled outline versions of the requested design.
This behavior requires that the X server in question
support the scaling of fonts and that the standard names
are mapped to underlying fonts that can be scaled using
this support.
</Para>
</RefSect2>
<RefSect2>
<Title>Example XLFD Patterns for the Standard Names</Title>
<Para>Using the specified field values for these standard names,
subsets of the standard names can be represented with various XLFD patterns.
The XLFD pattern
</Para>
<InformalExample Remap="indent">
<ProgramListing>-dt-application-*
</ProgramListing>
</InformalExample>
<Para>logically matches the full set of &str-Zx; Standard Application Font Names.
(Note that no specific X server behavior is implied).
The pattern
</Para>
<InformalExample Remap="indent">
<ProgramListing>-dt-application-bold-*-*-*-*-*-*-*-p-*-*-*-
</ProgramListing>
</InformalExample>
<Para>matches the bold, proportionally-spaced &str-XZ; fonts, both serif and sans
serif.
And the pattern
</Para>
<InformalExample Remap="indent">
<ProgramListing>-dt-application-*-*-*-*-*-*-*-*-m-*-*-*-
</ProgramListing>
</InformalExample>
<Para>matches the monospaced fonts (including both serif and sans serif).
</Para>
<Para>The full set of &str-XZ; Standard Application Font Names can be represented
with the following patterns:
</Para>
<InformalExample Remap="indent">
<ProgramListing>-dt-application-bold-i-normal-serif-*-*-*-*-p-*-iso8859-1
-dt-application-bold-r-normal-serif-*-*-*-*-p-*-iso8859-1
-dt-application-medium-i-normal-serif-*-*-*-*-p-*-iso8859-1
-dt-application-medium-r-normal-serif-*-*-*-*-p-*-iso8859-1
-dt-application-bold-i-normal-sans-*-*-*-*-p-*-iso8859-1
-dt-application-bold-r-normal-sans-*-*-*-*-p-*-iso8859-1
-dt-application-medium-i-normal-sans-*-*-*-*-p-*-iso8859-1
-dt-application-medium-r-normal-sans-*-*-*-*-p-*-iso8859-1
-dt-application-bold-i-normal-*-*-*-*-*-m-*-iso8859-1
-dt-application-bold-r-normal-*-*-*-*-*-m-*-iso8859-1
-dt-application-medium-i-normal-*-*-*-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-*-*-*-m-*-iso8859-1
-dt-application-medium-r-normal-*-*-*-*-*-p-*-dtsymbol-1
</ProgramListing>
</InformalExample>
<Para>Each of these 13 standard names comes in at least six point sizes.
</Para>
</RefSect2>
<RefSect2>
<Title>Implementation of Font Names</Title>
<Para>Each &str-XZ; system vendor and X&ensp;server vendor
provides mappings of
their own fonts to XLFD names meeting this standard, so that &str-XZ;
applications will work on their system.
The actual XLFD names will
vary from system to system, just as the fonts they are mapped to,
since they contain some of the same values as the XLFD name of the
underlying font.
What does not vary is the behavior:
the common
patterns in which only specified fields are used will match each
system's standard names.
This is guaranteed by the field specifications given earlier.
</Para>
<Para>The following requirements are placed on
each &str-XZ; or X&ensp;server vendor's
implementation of the Standard Application Font Names:
</Para>
<ItemizedList>
<!-- merged from xo+cde-->
<ListItem>
<Para>The names must be fully specified XLFD names, without wild cards.
</Para>
</ListItem>
<ListItem>
<Para>The
<SystemItem Class="Constant">WEIGHT_NAME</SystemItem>, <SystemItem Class="Constant">SLANT</SystemItem>, <SystemItem Class="Constant">SETWIDTH_NAME</SystemItem>, <SystemItem Class="Constant">SPACING</SystemItem>, <SystemItem Class="Constant">CHARSET_REGISTRY</SystemItem> and
<SystemItem Class="Constant">CHARSET_ENCODING</SystemItem> fields must contain valid values as defined previously
and must match those in the underlying font.
</Para>
</ListItem>
<ListItem>
<Para>The
<SystemItem Class="Constant">ADD_STYLE_NAME</SystemItem> field must contain either the
<Literal>serif</Literal> or
<Literal>sans</Literal> designation, whichever matches the underlying font.
</Para>
</ListItem>
</ItemizedList>
</RefSect2>
<RefSect2>
<Title>Default &str-XZ; Mappings for Latin-1 Locales</Title>
<Para>The default mapping of these standard application font names for the
ISO 8859
locales is to the following standard X11R5 bitmapped fonts
(the six minimum sizes are not shown explicitly in these patterns):
</Para>
<InformalExample Remap="indent">
<ProgramListing>-adobe-times-bold-i-normal--*-*-*-*-p-*-iso8859-1
-adobe-times-bold-r-normal--*-*-*-*-p-*-iso8859-1
-adobe-times-medium-i-normal--*-*-*-*-p-*-iso8859-1
-adobe-times-medium-r-normal--*-*-*-*-p-*-iso8859-1
-adobe-helvetica-bold-o-normal--*-*-*-*-p-*-iso8859-1
-adobe-helvetica-bold-r-normal--*-*-*-*-p-*-iso8859-1
-adobe-helvetica-medium-o-normal--*-*-*-*-p-*-iso8859-1
-adobe-helvetica-medium-r-normal--*-*-*-*-p-*-iso8859-1
-adobe-courier-bold-o-normal--*-*-*-*-m-*-iso8859-1
-adobe-courier-bold-r-normal--*-*-*-*-m-*-iso8859-1
-adobe-courier-medium-o-normal--*-*-*-*-m-*-iso8859-1
-adobe-courier-medium-r-normal--*-*-*-*-m-*-iso8859-1
-adobe-symbol-medium-r-normal--*-*-*-*-p-*-adobe-fontspecific
</ProgramListing>
</InformalExample>
<Para>A system may provide a different
mapping of these standard names as long as all 13 names map to fonts of
the appropriate design and style and the required six point sizes are
available.
The system documentation must document the
system-specific default mapping for the standard names.
</Para>
</RefSect2>
<RefSect2>
<Title>Font Names in app-defaults Files</Title>
<Para>An application can use a single
<Emphasis>app-defaults</Emphasis> file to specify font resources and use it across all &str-XZ; systems.
Since most of the fields (
<SystemItem Class="Constant">FOUNDRY</SystemItem>, <SystemItem Class="Constant">FAMILY_NAME</SystemItem>, <SystemItem Class="Constant">WEIGHT_NAME</SystemItem>, <SystemItem Class="Constant">SLANT</SystemItem>, <SystemItem Class="Constant">SETWIDTH_NAME</SystemItem>, <SystemItem Class="Constant">ADD_STYLE_NAME</SystemItem>, <SystemItem Class="Constant">POINT_SIZE</SystemItem>, <SystemItem Class="Constant">SPACING</SystemItem>, <SystemItem Class="Constant">CHARSET_REGISTRY</SystemItem> and
<SystemItem Class="Constant">CHARSET_ENCODING</SystemItem>) of the standard names are the same across different systems,
these values can be used in the resource specification in the
<Emphasis>app-defaults</Emphasis> file.
However, other fields (
<SystemItem Class="Constant">PIXEL_SIZE</SystemItem>, <SystemItem Class="Constant">RESOLUTION_X</SystemItem>, <SystemItem Class="Constant">RESOLUTION_Y</SystemItem> and
<SystemItem Class="Constant">AVERAGE_WIDTH</SystemItem>) may vary across
systems, and so must be wild-carded in the resource specification.
For example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>appOne*headFont: -dt-application-bold-r-normal-sans-*-140-*-*-p-*-iso8859-1
appOne*linkFont: -dt-application-bold-i-normal-sans-*-100-*-*-p-*-iso8859-1
</ProgramListing>
</InformalExample>
<Para>might be used to specify some of AppOne's default font resource needs.
</Para>
</RefSect2>
<refsect2>
<title>Other Character Sets in the Common Locales</title>
<para>The standard application font names defined above can be used for locales other than the
ISO 8859 character set with the following exceptions and differences. For the
following locales, CDE guarantees that systems provide fonts with the following
XLFD attribute values, and that they be accessible using these names.
For full information on how vendors ship the fonts, and make such names
usable with the appropriate font base name lists required for correct CDE
support for internationalization, see the guidelines in the CDE
Internationalization Programming Guide document.
</para>
<itemizedlist>
<listitem>
<para>Locales using ISO 8859-2, -3, -4, -5 (Cyrillic), -6 (Arabic), -7 (Greek), -8 (Hebrew):</para>
<para>The same values for
<systemitem class="Constant">FOUNDRY</systemitem>,
<systemitem class="Constant">FAMILY_NAME</systemitem>,
<systemitem class="Constant">WEIGHT_NAME</systemitem>,
<systemitem class="Constant">SLANT</systemitem>,
<systemitem class="Constant">SET_WIDTH</systemitem>,
<systemitem class="Constant">ADD_STYLE</systemitem> and
<systemitem class="Constant">SPACING</systemitem> as are used in this definition for the ISO 8859 locale.</para>
</listitem>
<listitem>
<para>Japanese locales:</para>
<para>Two values for the
<systemitem class="Constant">FAMILY_NAME</systemitem>
attribute (<literal>Gothic</literal> and <literal>Mincho</literal>) and two values for the
<systemitem class="Constant">WEIGHT_NAME</systemitem>
attribute (<literal>medium</literal> and <literal>bold</literal>) as well as
<systemitem class="Constant">SLANT</systemitem> (<literal>r</literal>),
<systemitem class="Constant">ADD_STYLE</systemitem> (<literal>*</literal>) and
<systemitem class="Constant">SPACING</systemitem> (<literal>m</literal>).</para>
</listitem>
<listitem>
<para>Chinese (Taiwan) locales:</para>
<para>Two values for the
<systemitem class="Constant">FAMILY_NAME</systemitem>
attribute (<literal>Sung</literal> and <literal>Kai</literal>) and two values for the
<systemitem class="Constant">WEIGHT_NAME</systemitem>
attribute (<literal>medium</literal> and <literal>bold</literal>) as well as
<systemitem class="Constant">SLANT</systemitem> (<literal>r</literal>),
<systemitem class="Constant">ADD_STYLE</systemitem> (<literal>*</literal>) and
<systemitem class="Constant">SPACING</systemitem> (<literal>m</literal>).</para>
</listitem>
<listitem>
<para>Chinese (PRC) locales:</para>
<para>Two values for the
<systemitem class="Constant">FAMILY_NAME</systemitem> attribute (<literal>Song</literal> and
<literal>Kai</literal>) and two values for the
<systemitem class="Constant">WEIGHT_NAME</systemitem> attribute (<literal>medium</literal> and
<literal>bold</literal>) as well as
<systemitem class="Constant">SLANT</systemitem> (<literal>r</literal>),
<systemitem class="Constant">ADD_STYLE</systemitem> (<literal>*</literal>) and
<systemitem class="Constant">SPACING</systemitem> (<literal>m</literal>).</para>
</listitem>
<listitem>
<para>Korean locales:</para>
<para>Two values for the
<systemitem class="Constant">FAMILY_NAME</systemitem>
attribute (<literal>Totum</literal> and <literal>Pathang</literal>) and two values for the
<systemitem class="Constant">WEIGHT_NAME</systemitem>
attribute (<literal>medium</literal> and <literal>bold</literal>) as well as
<systemitem class="Constant">SLANT</systemitem> (<literal>r</literal>),
<systemitem class="Constant">ADD_STYLE</systemitem> (<literal>*</literal>) and
<systemitem class="Constant">SPACING</systemitem> (<literal>m</literal>). Note that these names
are unofficial, tentative romanizations of the
two common font families in use in Korea; <literal>Totum</literal> corresponds to fonts typically
shipped as Gothic, Kodig or Dotum and <literal>Pathang</literal> corresponds to fonts typically
shipped as Myungjo or Myeongjo. The official roman names for these fonts
are under review and may be changed in the future by the Korean
government, and thus may change for CDE.</para>
</listitem>
</itemizedlist>
<para>In addition, to facilitate <emphasis>app-defaults</emphasis> files that work under a variety of locales,
CDE systems must provide an additional set of Standard Application Font Names where the
<systemitem class="Constant">FAMILY_NAME</systemitem> is <literal>application</literal>.
These font names are identified by the
presence of the following XLFD field values:</para>
<itemizedlist>
<listitem>
<para><systemitem class="Constant">FOUNDRY</systemitem> is <literal>dt</literal>
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">FAMILY_NAME</systemitem> is <literal>application</literal>
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">WEIGHT_NAME</systemitem> is <literal>medium</literal> or <literal>bold</literal>
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">SLANT</systemitem> is as appropriate (see above)
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">SET_WIDTH</systemitem> is <literal>normal</literal>
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">ADD_STYLE</systemitem> is <literal>*</literal>
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">SPACING</systemitem> is as appropriate (see above)
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">CHARSET_REGISTRY</systemitem> is as appropriate
</para>
</listitem>
<listitem>
<para><systemitem class="Constant">CHARSET_ENCODING</systemitem> is as appropriate
</para>
</listitem>
</itemizedlist>
<para>This set of names is mapped to an underlying font representing one of the
<systemitem class="Constant">FAMILY_NAMES</systemitem> as listed above.
</para>
<para>For example, the XLFD names</para>
<programlisting>
-dt-mincho-medium-r-normal--*-*-*-*-m-*-jisx0208.1983-0
-dt-application-medium-r-normal--*-*-*-*-m-*-jisx0208.1983-0
</programlisting>
<para>may both be mapped to
</para>
<programlisting>
-ibm_aix-mincho-medium-r-normal--*-*-*-*-m-*-jisx0208.1983-0
</programlisting>
<para>This scheme allows application writers to create a XmFontList in a resource file as follows,
without regard for a particular locale:
</para>
<programlisting>
*FontList:-dt-application-medium-r-normal-*-0-14-75-75-m-0-*-*:
</programlisting>
<para>and be assured that the font will be reasonable. Notice that specifying
fonts this way not only disregards the selection of the Asian
<systemitem class="Constant">FAMILY_NAME</systemitem>,
but also the Latin <literal>serif</literal> or <literal>sans</literal> <systemitem class="Constant">ADD_STYLE</systemitem>
field. The font selected
will be the default.
</para>
</refsect2>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtstyle;, &cdeman.dtterm;, &cdeman.DtStdInterfaceFontNames;</Para>
</RefSect1>
<RefSect1>
<Title>NOTES</Title>
<Para>There is no requirement on a &str-XZ; system to implement these
standard names in a particular way.
Several mechanisms are possible:
duplicate font files with altered naming attributes, X11R5 font
aliases, or vendor-specific mechanisms.
The only requirement is that
an XLFD pattern, written with attributes taken from the set that define
the standard names, can be successfully used to open a font with the
Xlib function
<Function>XLoadFont</Function>; and, specifically, the Xlib function
<Function>XListFonts</Function> need NOT return the same XLFD names for the pattern on
different &str-XZ; systems.
</Para>
<Para>&str-XZ; applications should, of course, be written to behave in a
reasonable manner if these standard font names are not available on a
particular X server.
This is typically done in an X application by
defaulting to the
<Literal>fixed</Literal> and
<Literal>variable</Literal> fonts.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

447
cde/doc/C/guides/man/man5/DtStdInt.sgm Normal file
View File

@@ -0,0 +1,447 @@
<!-- $XConsortium: DtStdInt.sgm /main/12 1996/09/30 11:28: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. -->
<refentry id="CDEMX.MAN104.rsml.1">
<refmeta><refentrytitle>DtStdInterfaceFontNames</refentrytitle><manvolnum>
file formats</manvolnum></refmeta>
<refnamediv><refname><Symbol>DtStdInterfaceFontNames</Symbol></refname>
<refpurpose>&str-XZ; Standard Interface Font Names</refpurpose></refnamediv>
<refsect1>
<title>DESCRIPTION</title>
<para>The &str-XZ; Standard
Interface Font Names are a set of generic X Window
System font names, needed by the &str-XZ; GUI itself, that are used for user
interface elements such as button labels, window titles and text fields.
These names, for seven sizes of two typefaces, must exist on all &str-XZ;
systems, and they should be provided in any
X&ensp;server product on which &str-XZ; applications are expected to run.
Seven sizes of a third typeface are recommended.
They are typically mapped to existing fonts on the system
using the font alias mechanism, although this method is not
required.</para>
<para>&str-XZ; 1.0 does not come with a common set of fonts on all systems,
and it must be able to run on X&ensp;servers and X terminals from non-&str-XZ;
vendors if those vendors so desire. Therefore, there are a standard set of
``generic'' font names and sizes that each &str-XZ; vendor makes available
on their &str-XZ; systems and that X&ensp;server vendors may make available
on their X&ensp;servers and terminals. The names map to existing fonts on
each vendor's system and may vary from vendor to vendor.</para>
<para>The &str-XZ; Standard Interface Font Names described here allow clients
making up the &str-XZ; desktop, such as &cdeman.dtterm; and a single
set of default fonts in their <emphasis>app-defaults</emphasis> files, without
concern for the system or X&ensp;server on which &str-XZ; is running. (The &str-XZ;
Standard Application Font Names, described in &cdeman.DtStdAppFontNames;,
provide a similar mechanism for applications running on the &str-XZ; desktop.)
</para>
<refsect2>
<title>Background</title>
<para>Interface fonts are designed by user interface experts for the narrow
purpose of making the menus, labels and fields of a graphical user interface
highly readable. They are usually finely hand-tuned bitmapped fonts, intended
for use on visual displays only and not on printers, and many of the glyphs
have been specially modified for this purpose. Interface fonts can be contrasted
with application fonts, which are the fonts used within an application running
on the &str-XZ; desktop. Interface fonts come in a restricted set of styles
and are used for short strings of text, whereas application fonts usually
come in a variety of designs, styles and weights and are used for emphasis,
cross-references, section headers, and so forth.</para>
</refsect2>
<refsect2>
<title>Rationale</title>
<para>Common font names are required to prevent &str-XZ; clients such as &cdeman.dtterm; from needing different <emphasis>app-defaults</emphasis>
files on each system. In addition, any X&ensp;server or X terminal vendor
may ensure that the &str-XZ; desktop can run on their X&ensp;server by mapping
these standard names to fonts of the corresponding style on their individual
X systems.</para>
<para>Interface fonts are needed because of user interface and cognitive research
that has examined the readability of various fonts on the display screens
in use today and found that many fine adjustments (for example, for centering,
baseline, height and alignment) must be made to characters in a font to make
them clear, distinguishable and consistent when used for the interface objects
of a GUI. And by using hand-tuned interface fonts for the GUI objects, the
desktop can achieve a very clean, crisp visual appearance.</para>
<para>Interface fonts are broken into 2 categories: system and user. Cognitive
research has shown that this distinction is important for the usability and
readability of GUIs. System fonts are those used when the system is presenting
information to the user (for example, in buttons). User fonts are those used
for text that a user enters into the system (for example, for a text field
or terminal emulator).</para>
</refsect2>
<refsect2>
<title>XLFD Field Values for the Standard Interface Font Names</title>
<para>These standard names are available using the X Window System XLFD font
naming scheme. There are three aspects to the standard names:</para>
<itemizedlist>
<listitem><para>The <emphasis>underlying font</emphasis> on each system, or
X&ensp;server platform, to which a standard name is mapped, typically will
be different on each system.</para>
</listitem><listitem><para>The <emphasis>standard name</emphasis> itself,
a full XLFD name mapped to the underlying font, may be different on each system
in some of the XLFD fields. However, most of the fields are the same from
system to system, allowing the <emphasis>patterns</emphasis> (described next)
to be the same.</para>
</listitem><listitem><para>The font resource <symbol role="Variable">pattern</symbol>
containing the * wildcards, used in <emphasis>app-defaults</emphasis>
files, which will match the full XLFD name of the standard name, is the same
across all systems, for a given use in an <emphasis>app-defaults</emphasis>
file.</para>
</listitem></itemizedlist>
<para>Each &str-XZ; or X&ensp;server vendor implementing this specification
must provide full XLFD names for the standard names, mapped to system-dependent
underlying fonts, so that the XLFD patterns used in &str-XZ; application <emphasis>app-defaults</emphasis> files will always match one of the full XLFD names
provided.</para>
<para>The Standard Interface Font Names are identified by the presence of
the following XLFD field name values:</para>
<itemizedlist>
<listitem><para><systemitem class="Constant">FOUNDRY</systemitem> is <literal>dt</literal></para>
</listitem><listitem><para><systemitem class="Constant">FAMILY_NAME</systemitem>
is either <literal>interface system</literal> or <literal>interface user</literal>
(there is a single space between the two words in each family name)</para>
</listitem></itemizedlist>
<para>In addition, the other fields of the XLFD names defining the standard
names are constrained as follows:</para>
<itemizedlist>
<listitem><para><systemitem class="Constant">WEIGHT_NAME</systemitem> is either <literal>medium</literal> or <literal>bold</literal></para>
</listitem><listitem><para><systemitem class="Constant">SLANT</systemitem>
is always <literal>r</literal></para>
</listitem><listitem><para><systemitem class="Constant">SETWIDTH_NAME</systemitem>
is always <literal>normal</literal></para>
</listitem><listitem><para><systemitem class="Constant">SPACING</systemitem>
is <literal>p</literal> or <literal>m</literal> (it must be <literal>m</literal>
for <literal>interface user</literal> fonts, and should be <literal>p</literal>
for <literal>interface system</literal> fonts, although <literal>m</literal>
is acceptable)</para>
</listitem><listitem><para><systemitem class="Constant">ADD_STYLE_NAME</systemitem>
contains both a nominal size value in the range <literal>xxs</literal> to <literal>xxl</literal> (see below), as well as either <literal>sans</literal> for sans
serif fonts or <literal>serif</literal> for serif, if appropriate for the
underlying font</para>
</listitem><listitem><para>The numeric fields ( <systemitem class="Constant">PIXEL_SIZE</systemitem>, <systemitem class="Constant">POINT_SIZE</systemitem>, <systemitem class="Constant">RESOLUTION_X</systemitem>, <systemitem class="Constant">RESOLUTION_Y</systemitem>, and <systemitem class="Constant">AVERAGE_WIDTH</systemitem>) must contain the same values as the underlying font.</para>
</listitem><listitem><para><systemitem class="Constant">CHARSET_REGISTRY</systemitem>
and <systemitem class="Constant">CHARSET_ENCODING</systemitem> are not specified;
the standard names may be implemented for any &str-XZ; locale.</para>
</listitem></itemizedlist>
<para>Although the <literal>sans</literal> and <literal>serif</literal> values
in the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field are
not required by the XLFD font convention, they are always part of the &str-XZ;
Standard Font Names when the underlying fonts are characterized as serif or
sans serif. However, this document imposes no restriction on whether the interface
fonts are serif or sans serif. The relevant attribute must be coded in the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field. Thus, for example, the
standard names for Japanese fonts, which are not characterized as being serif
or sans serif, would not include this designation in the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field.</para>
</refsect2>
<refsect2>
<title>Restricted Set of Styles Available</title>
<para>Unlike the Standard Application Font Names, only a limited set of styles
is available in the Standard Interface Font Names. The styles available represent
the minimum set currently considered necessary for the desktop GUI needs:
</para>
<itemizedlist>
<listitem><para>a medium weight of an interface system font, preferably proportionally
spaced (but mono-spaced is acceptable if appropriate for the locale)</para>
</listitem><listitem><para>a medium weight of an interface user font, always
mono-spaced</para>
</listitem><listitem><para>a bold weight of an interface user font, always
mono-spaced (the standard font names for this generic typeface are recommended
if available for the targeted fonts and locale, but are not required)</para>
</listitem></itemizedlist>
</refsect2>
<refsect2>
<title>Named Set of Point Sizes Available</title>
<para>In addition, the set of seven point sizes for each of the three styles
that are part of this document are ``named'' point sizes, using string values
in the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field. Thus,
XLFD patterns matching these names match a size based on the named size, not
on a numeric size, even though the latter does exist in the XLFD name. These
named sizes are used because the exact size of an interface font is less important
than its nominal size, and implementation differences for the hand-tuned interface
fonts do not allow common numeric point sizes to be assured across systems.
The seven nominal sizes are as follows:</para>
<variablelist>
<varlistentry><term><literal>xxs</literal></term>
<listitem>
<para>extra extra small</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>xs</literal></term>
<listitem>
<para>extra small</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>s</literal></term>
<listitem>
<para>small</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>m</literal></term>
<listitem>
<para>medium</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>l</literal></term>
<listitem>
<para>large</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>xl</literal></term>
<listitem>
<para>extra large</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>xxl</literal></term>
<listitem>
<para>extra extra large</para>
</listitem>
</varlistentry>
</variablelist>
<para>The goal of these named sizes is to provide enough fonts so that both
the variety of display monitor sizes and resolutions that &str-XZ; will run
on, and the range of user preferences for comfortably reading button labels,
window titles and so forth, can be accommodated in the GUI. Thus, both the
smallest size, <literal>xxs</literal>, and the largest size, <literal>xxl</literal>, are meant to be reasonable sizes for displaying and viewing the &str-XZ;
desktop on common displays and X terminals; they are not meant to imply either
hard-to-read fine print or headline-sized display type.</para>
<para>These named size values must occur first in the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field, before any use of the values <literal>serif</literal> or <literal>sans</literal> (one of which is always required
when the underlying font can be so characterized) and before any other additional
stylistic attribute that might be appropriate. This is important when specifying
wild-carded patterns in a resource specification for these fonts, since whether
the underlying font these names are mapped to is serif or sans serif is not
specified by &str-XZ;, and the match must work for all XLFD names provided
by &str-XZ; system vendors or other X&ensp;server vendors.</para>
</refsect2>
<refsect2>
<title>Example XLFD Patterns for the Standard Names</title>
<para>Using these values, the XLFD pattern</para>
<informalexample remap="indent">
<programlisting>-dt-interface*-*</programlisting>
</informalexample>
<para>logically matches the full set of &str-Zx; Standard Interface Font Names.
(Note that no specific X server behavior is implied).</para>
<para>The full set of 21 &str-XZ; Standard Interface Font Names can also be
represented, in a more meaningful way, as follows:</para>
<informalexample remap="indent">
<programlisting>-dt-interface system-medium-r-normal-*-*-*-*-*-*-*-iso8859-1
-dt-interface user-medium-r-normal-*-*-*-*-*-m-*-iso8859-1
-dt-interface user-bold-r-normal-*-*-*-*-*-m-*-iso8859-1</programlisting>
</informalexample>
<para>The full set of patterns, usable in <emphasis>app-defaults</emphasis>
files, for all seven sizes for the system font, for example, is:</para>
<informalexample remap="indent">
<programlisting>-dt-interface system-medium-r-normal-xxs*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-xs*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-s*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-m*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-l*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-xl*-*-*-*-*-*-*-iso8859-1
-dt-interface system-medium-r-normal-xxl*-*-*-*-*-*-*-iso8859-1</programlisting>
</informalexample>
<para>These patterns could be used in a resource file and will match the full &str-XZ;
Standard Interface Names for Latin-1 locales on all &str-XZ;, or complying
X server, systems.</para>
<para>Note in these wild-carded XLFD names that the <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field has a pattern, such as <literal>xxs*</literal>,
and that the pattern is partly a string ( <literal>xxs</literal>) and partly
the pattern-matching character <literal>*</literal>. The full XLFD name this
pattern matches&mdash;the XLFD name implementing the Standard Interface name&mdash;will
often contain <literal>sans</literal> or <literal>serif</literal> in the field,
after the <literal>xxs</literal> and a space, and so the <literal>*</literal>
is essential to match that <literal>sans</literal> or <literal>serif</literal>
string (and any additional style attribute string that might be in the underlying
name). Note also that the <systemitem class="Constant">SPACING</systemitem>
field is wild-carded in the pattern for the system font, since either <literal>p</literal> or <literal>m</literal> may appear in the standard name being
matched.</para>
</refsect2>
<refsect2>
<title>Implementation of Font Names</title>
<para>Each &str-XZ; system vendor and X&ensp;server vendor provides mappings
of its own fonts to XLFD names as described by this document. The actual XLFD
names will vary from system to system, just as the fonts they are mapped to,
since they contain some of the same values as the XLFD name of the underlying
font. What does not vary is the behavior: the common patterns in which only
specified fields are used will match each system's standard names. This is
guaranteed by the field specifications given earlier.</para>
<para>There is no precise specification of how the named sizes <literal>xxs</literal> to <literal>xxl</literal> are mapped to sizes of underlying fonts
in each system or X&ensp;server product, although each size must be equal
to or larger than the previous size. Nonetheless, some guidelines are appropriate.
</para>
<para>Interface fonts have been developed because of human factors research
on visual clarity of text on displays, and this has been done in the context
of the display technology typically available today, mostly in the 100 dots
per inch (DPI) range. That, and the use of standard point sizes (10, 12, 14,
18) in the graphics arts, have resulted in the development in the industry
of hand-tuned bitmapped fonts for a set of ``pixel heights'' that are likely
to be used for these standard names. However, making the &str-XZ; desktop
usable with a range of point sizes effectively means, in addition to legibility
for the user, that the various &str-XZ; applications fit ``appropriately''
on the screen using those point sizes. This means, for example, that two application
windows can appear side by side on a typical display or that a certain number
of buttons can appear across the screen.</para>
<para>Thus, these guidelines are expressed not only in pixel sizes, to reflect
current usage, but also in percentage of monitor height. This allows them
to remain appropriate as technological evolution improves display resolution
and monitor size (for example, wall-mounted monitors). The ideal set of sizes
would form a linear progression from the smallest ( <literal>xxs</literal>)
to the largest ( <literal>xxl</literal>), although this is not achievable.
The basic guideline is that the <literal>xxs</literal> font should be, in
pixels, no less than 0.9% of the height of the display resolution, in pixels;
the <literal>xxl</literal> font should be no more than 2.6% of the height.
</para>
<para>As an approximate example that does not represent any existing mapping
of fonts to a display, this table shows how the named sizes might map to real
bitmapped fonts of a given pixel size, and how large those sizes are in percentage
and point size terms:</para>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="5.15in">
<colspec align="left" colname="col1" colwidth="84*">
<colspec align="left" colwidth="85*">
<colspec align="left" colwidth="136*">
<colspec align="left" colname="col4" colwidth="119*">
<spanspec nameend="col4" namest="col1" spanname="1to4">
<tbody>
<row>
<entry align="left" spanname="1to4" valign="top"><literal>Sample Range of
Named Sizes on a 1280&times;1024 Display</literal></entry></row>
<row>
<entry align="left" valign="top"><emphasis>named size</emphasis></entry>
<entry align="left" valign="top"><emphasis>number</emphasis> <emphasis>of
pixels</emphasis></entry>
<entry align="left" valign="top"><emphasis>size as %</emphasis> <emphasis>of 1024 height</emphasis></entry>
<entry align="left" valign="top"><emphasis>point size on 100 DPI screen</emphasis></entry>
</row>
<row>
<entry align="left" valign="top"><literal>xxs</literal></entry>
<entry align="left" valign="top">10</entry>
<entry align="left" valign="top">0.98%</entry>
<entry align="left" valign="top">7.2</entry></row>
<row>
<entry align="left" valign="top"><literal>xs</literal></entry>
<entry align="left" valign="top">12</entry>
<entry align="left" valign="top">1.12%</entry>
<entry align="left" valign="top">8.7</entry></row>
<row>
<entry align="left" valign="top"><literal>s</literal></entry>
<entry align="left" valign="top">14</entry>
<entry align="left" valign="top">1.37%</entry>
<entry align="left" valign="top">10.1</entry></row>
<row>
<entry align="left" valign="top"><literal>m</literal></entry>
<entry align="left" valign="top">17</entry>
<entry align="left" valign="top">1.66%</entry>
<entry align="left" valign="top">12.3</entry></row>
<row>
<entry align="left" valign="top"><literal>l</literal></entry>
<entry align="left" valign="top">20</entry>
<entry align="left" valign="top">1.95%</entry>
<entry align="left" valign="top">14.6</entry></row>
<row>
<entry align="left" valign="top"><literal>xl</literal></entry>
<entry align="left" valign="top">23</entry>
<entry align="left" valign="top">2.25%</entry>
<entry align="left" valign="top">16.6</entry></row>
<row>
<entry align="left" valign="top"><literal>xxl</literal></entry>
<entry align="left" valign="top">26</entry>
<entry align="left" valign="top">2.54%</entry>
<entry align="left" valign="top">18.8</entry></row></tbody></tgroup></informaltable>
<para>Thus, the following requirements are placed on each implementation of
the Standard Interface Font Names:</para>
<itemizedlist>
<listitem><para>The names must be fully specified XLFD names, without wild
cards.</para>
</listitem><listitem><para>The <systemitem class="Constant">WEIGHT_NAME</systemitem>, <systemitem class="Constant">SLANT</systemitem>, <systemitem class="Constant">SETWIDTH_NAME</systemitem>, <systemitem class="Constant">SPACING</systemitem>, <systemitem class="Constant">CHARSET_REGISTRY</systemitem> and <systemitem class="Constant">CHARSET_ENCODING</systemitem> fields must contain valid values as defined
previously and must match those in the underlying font.</para>
</listitem><listitem><para>The <systemitem class="Constant">ADD_STYLE_NAME</systemitem> field must contain both a named size (for example, <literal>xxs</literal>) and, if appropriate, either the <literal>serif</literal> or <literal>sans</literal> designation, whichever matches the underlying font; any additional
words about the style of the underlying font, if defined for the underlying
font, must also be used. The named size must be first in the field, and must
be separated from any following word in the field with a blank.</para>
</listitem><listitem><para>The named sizes <literal>xxs</literal> through <literal>xxl</literal> must be mapped to fonts that are progressively larger than or
equal to the previous one in the list. Thus, several standard names with adjacent
sizes (for example, <literal>xxs</literal> and <literal>xs</literal>) may
be mapped to the same font (for example, if there is not enough variety in
sizes in the underlying fonts).</para>
</listitem><listitem><para>The implemented names should attempt to meet the
guidelines discussed in the previous paragraph and table.</para>
</listitem></itemizedlist>
<para>For example, system A is assumed to be using the following sans serif
font for the extra small system font:</para>
<informalexample remap="indent">
<programlisting>-bitstream-swiss-medium-r-normal--11-90-85-85-p-81-iso8859-1
</programlisting>
</informalexample>
<para>System B is using the following serif font for the extra small system
font:</para>
<informalexample remap="indent">
<programlisting>-vendorb-ersatz-medium-r-normal-Expert-8-80-75-75-m-72-iso8859-1
</programlisting>
</informalexample>
<para>Their respective standard names would be implemented on their systems
as:</para>
<informalexample>
<programlisting>
-dt-interface&ensp;system-medium-r-normal-xs&thinsp;sans-11-90-85-85-p-81-iso8859-1
-dt-interface&ensp;system-medium-r-normal-xs&thinsp;serif&ensp;Expert-8-80-75-75-m-72-iso8859-1
</programlisting>
</informalexample>
<para>Defined this way, both names will match the single XLFD pattern used
in a common <emphasis>app-defaults</emphasis> file:</para>
<informalexample remap="indent">
<programlisting>-dt-interface system-medium-r-normal-xs*-*-*-*-*-*-*-iso8859-1
</programlisting>
</informalexample>
</refsect2>
<refsect2>
<title>Default &str-XZ; Mapping of the Standard Interface Font Names</title>
<para>There is no default mapping of these interface names to X11R5 fonts;
the mapping is implementation-specific.</para>
</refsect2>
</refsect1>
<refsect1>
<title>USAGE</title>
<para>A &str-XZ; desktop client developer will code a single <emphasis>app-defaults</emphasis> file to specify font resources for their client and use it across
all &str-XZ; systems. Since the <systemitem class="Constant">FOUNDRY</systemitem>, <systemitem class="Constant">FAMILY_NAME</systemitem>, <systemitem class="Constant">WEIGHT_NAME</systemitem>, <systemitem class="Constant">SLANT</systemitem> and <systemitem class="Constant">SETWIDTH_NAME</systemitem> fields of the standard names are
the same across different systems, these values can be used in the resource
specification in the <emphasis>app-defaults</emphasis> file. However, other
fields ( <systemitem class="Constant">ADD_STYLE_NAME</systemitem>, <systemitem class="Constant">PIXEL_SIZE</systemitem>, <systemitem class="Constant">POINT_SIZE</systemitem>, <systemitem class="Constant">RESOLUTION_X</systemitem>, <systemitem class="Constant">RESOLUTION_Y</systemitem>, <systemitem class="Constant">SPACING</systemitem> and <systemitem class="Constant">AVERAGE_WIDTH</systemitem>)
will vary across systems, and so must be wild-carded in the resource specification
( <systemitem class="Constant">ADD_STYLE_NAME</systemitem> is partially wild-carded).
As was shown in the previous example:</para>
<informalexample remap="indent">
<programlisting>-dt-interface system-medium-r-normal-xs*-*-*-*-*-*-*-iso8859-1
</programlisting>
</informalexample>
<para>is an XLFD pattern, used in a single resource specification, that matches
a single standard name on different &str-XZ; or X&ensp;server platforms. (And
if the last 2 fields, <systemitem class="Constant">CHARSET_REGISTRY</systemitem>
and <systemitem class="Constant">CHARSET_ENCODING</systemitem>, were wild-carded,
then the pattern could work across locales as well.) Note that the named size
( <literal>xs</literal> in this example) is part of the pattern, but the <literal>serif</literal>/ <literal>sans serif</literal> designation is not; this is
required to obtain the desired nominal size (whatever it may be in the mapped
font), while still matching either <literal>serif</literal> or <literal>sans serif</literal> in the standard name.</para>
<para>Note that if a &str-XZ; desktop application tries to open a font using
one of these standard names, and the X&ensp;server does not know about these
names, the application will usually fall back on using the <literal>fixed</literal> and <literal>variable</literal> font aliases that are typically
provided in all X&ensp;servers. When this happens, the &str-XZ; desktop will
be more difficult to use, visually, than if its expected font names were available.
</para>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>There is no requirement on a &str-XZ; system or X&ensp;server vendor
to implement these standard names in a particular way. Several mechanisms
are possible: duplicate font files with altered naming attributes, X11R5 font
aliases, or vendor-specific mechanisms. The only requirement is that an XLFD
pattern, written with attributes taken from the set that define the standard
names, can be successfully used to open a font with the Xlib function <function>XLoadFont</function>; and, specifically, the Xlib function <function>XListFonts</function> need NOT return the same XLFD name for the pattern on different &str-XZ;
or X&ensp;server systems.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtstyle;, &cdeman.dtterm;, &cdeman.DtStdAppFontNames;</para>
</refsect1>
</refentry>
<?Pub *0000056959>

72
cde/doc/C/guides/man/man5/DtTerm.sgm Normal file
View File

@@ -0,0 +1,72 @@
<!-- $XConsortium: DtTerm.sgm /main/9 1996/10/08 20:06: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.XCSA.MAN79.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN79.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Dt/Term.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Dt/Term.h</Filename></RefName>
<RefPurpose>terminal emulator definitions
</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>#include &lt;Dt/Term.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Dt/Term.h</Filename> header defines structures, values and function prototypes for
terminal emulator services.
</Para>
<Para>The
header declares the following variable:
</Para>
<InformalExample Remap="indent">
<ProgramListing>WidgetClass dtTermWidgetClass;
</ProgramListing>
</InformalExample>
<Para>The following are declared as functions:
</Para>
<Synopsis>Widget DtCreateTerm(Widget <Symbol Role="Variable">parent</Symbol>,
char <Emphasis>*name</Emphasis>,
Arg <Emphasis>*arglist</Emphasis>,
Cardinal <Symbol Role="Variable">argcount</Symbol>);
</Synopsis>
<Synopsis>void DtTermInitialize(void);
</Synopsis>
<Synopsis>void DtTermDisplaySend(Widget <Symbol Role="Variable">w</Symbol>,
unsigned char <Emphasis>*buffer</Emphasis>,
int length);
</Synopsis>
<Synopsis>void DtTermSubprocSend(Widget <Symbol Role="Variable">w</Symbol>,
unsigned char <Emphasis>*buffer</Emphasis>,
int length);
</Synopsis>
<Synopsis>void DtTermSubprocReap(pid_t <Emphasis>pid</Emphasis>,
int *<Emphasis>stat_loc</Emphasis>);
</Synopsis>
<Para><![ %CDE.C.CDE; [</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtCreateTerm;, &cdeman.DtTermDisplaySend;, &cdeman.DtTermInitialize;, &cdeman.DtTermSubprocReap;, &cdeman.DtTermSubprocSend;, &cdeman.dtterm;, &cdeman.dttermesc;. ]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

116
cde/doc/C/guides/man/man5/DtWsm.sgm Normal file
View File

@@ -0,0 +1,116 @@
<!-- $XConsortium: DtWsm.sgm /main/10 1996/09/08 20:00: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. -->
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCSA.MAN80.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN80.rsml.1">]]><refmeta>
<refentrytitle>Dt/Wsm.h</refentrytitle><manvolnum>file formats</manvolnum>
</refmeta><refnamediv><refname><Filename>Dt/Wsm.h</Filename></refname><refpurpose>
workspace manager definitions</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>#include &lt;Dt/Wsm.h></synopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <filename role="Header">Dt/Wsm.h</filename> header defines structures
and function prototypes for workspace management services.</para>
<para>The <structname role="typedef">DtWsmWorkspaceInfo</structname> structure
contains at least the following members:</para>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.10in">
<colspec align="left" colwidth="143*">
<colspec align="left" colwidth="150*">
<colspec align="left" colwidth="210*">
<tbody>
<row>
<entry align="left" valign="top"><computeroutput>Atom</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>workspace</computeroutput></entry>
<entry align="left" valign="top">X atom name for the workspace</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>unsigned long</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>bg</computeroutput></entry>
<entry align="left" valign="top">Backdrop background pixel</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>unsigned long</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>fg</computeroutput></entry>
<entry align="left" valign="top">Backdrop foreground pixel</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>Atom</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>backdropName</computeroutput></entry>
<entry align="left" valign="top">X atom name for backdrop</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>int</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>colorSetId</computeroutput></entry>
<entry align="left" valign="top">Number of color set used</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>char</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>*pchTitle</computeroutput></entry>
<entry align="left" valign="top">Title of workspace</entry></row>
<row>
<entry align="left" valign="top"><computeroutput>Window</computeroutput></entry>
<entry align="left" valign="top"><computeroutput>backdropWindow</computeroutput></entry>
<entry align="left" valign="top">The backdrop window for the current workspace</entry></row></tbody></tgroup></informaltable>
<para>The <structname role="typedef">DtWsmCBContext</structname> structure
is opaque. Workspace management functions that add callbacks to uniquely identify
callback functions for later removal, return the <structname role="typedef">DtWsmCBContext</structname> structure.</para>
<para>The header defines the following <structname role="typedef">DtWsmWsReason</structname> constants:</para>
<informalexample remap="indent">
<programlisting>DtWSM_REASON_ADD
DtWSM_REASON_DELETE
DtWSM_REASON_BACKDROP
DtWSM_REASON_TITLE
DtWSM_REASON_CURRENT</programlisting>
</informalexample>
<para>The header defines the following functions:</para>
<synopsis>DtWsmCBContext
DtWsmAddCurrentWorkspaceCallback(Widget <symbol role="Variable">widget</symbol>,
DtWsmWsChangeProc <emphasis>ws_change</emphasis>,
Pointer <symbol role="Variable">client_data</symbol>);</synopsis>
<synopsis>void DtWsmAddWorkspaceFunctions(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">window</symbol>);</synopsis>
<synopsis>void DtWsmRemoveWorkspaceFunctions(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">window</symbol>);</synopsis>
<synopsis>DtWsmCBContext
DtWsmAddWorkspaceModifiedCallback(Widget <symbol role="Variable">widget</symbol>,
DtWsmWsModifiedProc <emphasis>ws_change</emphasis>,
Pointer <symbol role="Variable">client_data</symbol>);</synopsis>
<synopsis>void DtWsmRemoveWorkspaceCallback(DtWsmCBContext <symbol role="Variable">context</symbol>);</synopsis>
<synopsis>void DtWsmFreeWorkspaceInfo(DtWsmWorkspaceInfo *<emphasis>pWsInfo</emphasis>);</synopsis>
<synopsis>Status DtWsmGetCurrentBackdropWindows(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">root</symbol>);</synopsis>
<synopsis>Status DtWsmGetCurrentWorkspace(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">root</symbol>,
Atom *<emphasis>paWorkspace</emphasis>);</synopsis>
<synopsis>Status DtWsmSetCurrentWorkspace(Widget <symbol role="Variable">widget</symbol>,
Atom <emphasis>aWorkspace</emphasis>);</synopsis>
<synopsis>Status DtWsmGetWorkspaceInfo(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">root</symbol>,
Atom <emphasis>aWorkspace</emphasis>,
DtWsmWorkspaceInfo **<emphasis>ppWsInfo</emphasis>);</synopsis>
<synopsis>Status DtWsmGetWorkspaceList(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">root</symbol>,
Atom **<emphasis>ppaWorkspaces</emphasis>,
int *<emphasis>pNumWs</emphasis>);</synopsis>
<synopsis>Status DtWsmGetWorkspacesOccupied(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">window</symbol>,
Atom **<emphasis>ppaWorkspace</emphasis>,
int *<emphasis>pNumWs</emphasis>);</synopsis>
<synopsis>void DtWsmSetWorkspacesOccupied(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">window</symbol>,
Atom *<emphasis>paWorkspaces</emphasis>,
int <emphasis>numWs</emphasis>);</synopsis>
<synopsis>void DtWsmOccupyAllWorkspaces(Display *<symbol role="Variable">display</symbol>,
Window <symbol role="Variable">window</symbol>);</synopsis>
</refsect1><![ %CDE.C.CDE; [<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtWsmAddCurrentWorkspaceCallback;, &cdeman.DtWsmAddWorkspaceFunctions;, &cdeman.DtWsmAddWorkspaceModifiedCallback;, &cdeman.DtWsmFreeWorkspaceInfo;, &cdeman.DtWsmGetCurrentBackdropWindow;, &cdeman.DtWsmGetCurrentWorkspace;, &cdeman.DtWsmGetWorkspaceInfo;, &cdeman.DtWsmGetWorkspaceList;, &cdeman.DtWsmGetWorkspacesOccupied;, &cdeman.DtWsmOccupyAllWorkspaces;, &cdeman.DtWsmRemoveWorkspaceCallback;, &cdeman.DtWsmRemoveWorkspaceFunctions;, &cdeman.DtWsmSetCurrentWorkspace;, &cdeman.DtWsmSetWorkspacesOccupied;.</para>
</refsect1>]]></refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
<?Pub *0000036327>

826
cde/doc/C/guides/man/man5/Tttt_c.sgm Normal file
View File

@@ -0,0 +1,826 @@
<!-- $XConsortium: Tttt_c.sgm /main/12 1996/09/08 20:00:33 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.MAN80a.rsml.1">]]>
<![%CDE.C.XO;[<RefEntry Id="XCSA.MAN80a.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Tt/tt_c.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Tt/tt_c.h</Filename></RefName>
<RefPurpose>ToolTalk definitions
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>#include &lt;Tt/tt_c.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Tt/tt_c.h</Filename> header includes
<Literal>typedef</Literal>s for the following callback functions:
</Para>
<Synopsis>typedef Tt_filter_action (*Tt_filter_function)(const char *<Emphasis>nodeid</Emphasis>,
void *<Symbol Role="Variable">context</Symbol>,
void *<Emphasis>accumulator</Emphasis>);
</Synopsis>
<Synopsis>typedef Tt_callback_action (*Tt_message_callback)(Tt_message <Emphasis>m</Emphasis>,
Tt_pattern <Emphasis>p</Emphasis>);
</Synopsis>
<para>To enable developers to write multithreaded applications, the header defines
</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 will be part of the <literal>libtt</literal> binary interface.
</para>
<para>These would be accessed by calling code with corresponding <literal>#define</literal> constants:
</para>
<programlisting>
#define TT_FEATURE_MULTITHREADED _TT_FEATURE_MULTITHREADED
</programlisting>
<para>in order that that calling code can then use <literal>cpp</literal>
directives to control their use of features:
</para>
<programlisting>
#if defined(TT_FEATURE_MULTITHREADED)
....
#endif
</programlisting>
<Para>The header defines the
<SystemItem Class="Constant">TT_VERSION</SystemItem> constant with the value 10200,
indicating the version of the ToolTalk API.
</Para>
<Para>The header defines the
<StructName Role="typedef">Tt_status</StructName> enumeration data type,
with the following members and specific values:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef enum tt_status {
TT_OK = 0,
TT_WRN_NOTFOUND = 1,
TT_WRN_STALE_OBJID = 2,
TT_WRN_STOPPED = 3,
TT_WRN_SAME_OBJID = 4,
TT_WRN_START_MESSAGE = 5,
TT_WRN_APPFIRST = 512,
TT_WRN_LAST = 1024,
TT_ERR_CLASS = 1025,
TT_ERR_DBAVAIL = 1026,
TT_ERR_DBEXIST = 1027,
TT_ERR_FILE = 1028,
TT_ERR_INVALID = 1029,
TT_ERR_MODE = 1031,
TT_ERR_ACCESS = 1032,
TT_ERR_NOMP = 1033,
TT_ERR_NOTHANDLER = 1034,
TT_ERR_NUM = 1035,
TT_ERR_OBJID = 1036,
TT_ERR_OP = 1037,
TT_ERR_OTYPE = 1038,
TT_ERR_ADDRESS = 1039,
TT_ERR_PATH = 1040,
TT_ERR_POINTER = 1041,
TT_ERR_PROCID = 1042,//The specified process identifier is out of date or invalid
TT_ERR_PROPLEN = 1043,
TT_ERR_PROPNAME = 1044,
TT_ERR_PTYPE = 1045,
TT_ERR_DISPOSITION = 1046,
TT_ERR_SCOPE = 1047,
TT_ERR_SESSION = 1048,
TT_ERR_VTYPE = 1049,
TT_ERR_NO_VALUE = 1050,
TT_ERR_INTERNAL = 1051,
TT_ERR_READONLY = 1052,
TT_ERR_NO_MATCH = 1053,
TT_ERR_UNIMP = 1054,
TT_ERR_OVERFLOW = 1055,
TT_ERR_PTYPE_START = 1056,
TT_ERR_CATEGORY = 1057,
TT_ERR_DBUPDATE = 1058,
TT_ERR_DBFULL = 1059,
TT_ERR_DBCONSIST = 1060,
TT_ERR_STATE = 1061,
TT_ERR_NOMEM = 1062,
TT_ERR_SLOTNAME = 1063,
TT_ERR_XDR = 1064,
TT_ERR_NETFILE = 1065,
TT_DESKTOP_ = 1100,
TT_DESKTOP_EPERM = 1101,
TT_DESKTOP_ENOENT = 1102,
TT_DESKTOP_EINTR = 1104,
TT_DESKTOP_EIO = 1105,
TT_DESKTOP_EAGAIN = 1111,
TT_DESKTOP_ENOMEM = 1112,
TT_DESKTOP_EACCES = 1113,
TT_DESKTOP_EFAULT = 1114,
TT_DESKTOP_EEXIST = 1117,
TT_DESKTOP_ENODEV = 1119,
TT_DESKTOP_ENOTDIR = 1120,
TT_DESKTOP_EISDIR = 1121,
TT_DESKTOP_EINVAL = 1122,
TT_DESKTOP_ENFILE = 1123,
TT_DESKTOP_EMFILE = 1124,
TT_DESKTOP_ETXTBSY = 1126,
TT_DESKTOP_EFBIG = 1127,
TT_DESKTOP_ENOSPC = 1128,
TT_DESKTOP_EROFS = 1130,
TT_DESKTOP_EMLINK = 1131,
TT_DESKTOP_EPIPE = 1132,
TT_DESKTOP_ENOMSG = 1135,
TT_DESKTOP_EDEADLK = 1145,
TT_DESKTOP_ECANCELED = 1147,
TT_DESKTOP_ENOTSUP = 1148,
TT_DESKTOP_ENODATA = 1161,
TT_DESKTOP_EPROTO = 1171,
TT_DESKTOP_ENOTEMPTY = 1193,
TT_DESKTOP_ETIMEDOUT = 1245,
TT_DESKTOP_EALREADY = 1249,
TT_DESKTOP_UNMODIFIED = 1299,
TT_MEDIA_ERR_SIZE = 1300,
TT_MEDIA_ERR_FORMAT = 1301,
TT_ERR_APPFIRST = 1536,
TT_ERR_LAST = 2047,
TT_STATUS_LAST = 2048
} Tt_status;
</ProgramListing>
</InformalExample>
<Para>Specific values are required because they can be communicated between ToolTalk
clients on different platforms, usually via
&cdeman.tt.message.status.set; and
&cdeman.tt.message.status;.</Para>
<Para>The header defines the following enumeration data types,
with at least the following members:
</Para>
<VariableList>
<VarListEntry>
<Term><StructName Role="typedef">Tt_filter_action</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_FILTER_CONTINUE</SystemItem>, <SystemItem Class="Constant">TT_FILTER_LAST</SystemItem>, <SystemItem Class="Constant">TT_FILTER_STOP</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_callback_action</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_CALLBACK_CONTINUE</SystemItem>, <SystemItem Class="Constant">TT_CALLBACK_LAST</SystemItem>, <SystemItem Class="Constant">TT_CALLBACK_PROCESSED</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_mode</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_IN</SystemItem>, <SystemItem Class="Constant">TT_INOUT</SystemItem>, <SystemItem Class="Constant">TT_MODE_LAST</SystemItem>, <SystemItem Class="Constant">TT_MODE_UNDEFINED</SystemItem>, <SystemItem Class="Constant">TT_OUT</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_scope</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_BOTH</SystemItem>, <SystemItem Class="Constant">TT_FILE</SystemItem>, <SystemItem Class="Constant">TT_FILE_IN_SESSION</SystemItem>, <SystemItem Class="Constant">TT_SCOPE_NONE</SystemItem>, <SystemItem Class="Constant">TT_SESSION</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_class</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_CLASS_LAST</SystemItem>, <SystemItem Class="Constant">TT_CLASS_UNDEFINED</SystemItem>, <SystemItem Class="Constant">TT_NOTICE</SystemItem>, <SystemItem Class="Constant">TT_REQUEST</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_category</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_CATEGORY_LAST</SystemItem>, <SystemItem Class="Constant">TT_CATEGORY_UNDEFINED</SystemItem>, <SystemItem Class="Constant">TT_HANDLE</SystemItem>, <SystemItem Class="Constant">TT_OBSERVE</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_address</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_ADDRESS_LAST</SystemItem>, <SystemItem Class="Constant">TT_HANDLER</SystemItem>, <SystemItem Class="Constant">TT_OBJECT</SystemItem>, <SystemItem Class="Constant">TT_OTYPE</SystemItem>, <SystemItem Class="Constant">TT_PROCEDURE</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_disposition</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_DISCARD</SystemItem>, <SystemItem Class="Constant">TT_QUEUE</SystemItem>, <SystemItem Class="Constant">TT_START</SystemItem></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">Tt_state</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TT_CREATED</SystemItem>, <SystemItem Class="Constant">TT_FAILED</SystemItem>, <SystemItem Class="Constant">TT_HANDLED</SystemItem>, <SystemItem Class="Constant">TT_QUEUED</SystemItem>, <SystemItem Class="Constant">TT_REJECTED</SystemItem>, <SystemItem Class="Constant">TT_SENT</SystemItem>, <SystemItem Class="Constant">TT_STARTED</SystemItem>, <SystemItem Class="Constant">TT_STATE_LAST</SystemItem></Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The header defines the following as opaque data types:
<StructName Role="typedef">Tt_message</StructName>, <StructName Role="typedef">Tt_pattern</StructName>.</Para>
<Para>The header declares the following as functions:
</Para>
<Synopsis>char *tt_X_session(const char *<Emphasis>xdisplaystring</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_bcontext_join(const char *<Emphasis>slotname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_bcontext_quit(const char *<Emphasis>slotname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_close(void);
</Synopsis>
<Synopsis>Tt_status tt_context_join(const char *<Emphasis>slotname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_context_quit(const char *<Emphasis>slotname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_default_file(void);
</Synopsis>
<Synopsis>Tt_status tt_default_file_set(const char *<Emphasis>docid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_default_procid(void);
</Synopsis>
<Synopsis>Tt_status tt_default_procid_set(const char *<Emphasis>procid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_default_ptype(void);
</Synopsis>
<Synopsis>Tt_status tt_default_ptype_set(const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_default_session(void);
</Synopsis>
<Synopsis>Tt_status tt_default_session_set(const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>int tt_error_int(Tt_status <Emphasis>ttrc</Emphasis>);
</Synopsis>
<Synopsis>void *tt_error_pointer(Tt_status <Emphasis>ttrc</Emphasis>);
</Synopsis>
<Synopsis>int tt_fd(void);
</Synopsis>
<Synopsis>Tt_status tt_file_copy(const char *<Emphasis>oldfilepath</Emphasis>,
const char *<Emphasis>newfilepath</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_file_destroy(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_file_join(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_file_move(const char *<Emphasis>oldfilepath</Emphasis>,
const char *<Emphasis>newfilepath</Emphasis>);
</Synopsis>
<Synopsis>char *tt_file_netfile(const char *<Symbol Role="Variable">filename</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_file_objects_query(const char *<Emphasis>filepath</Emphasis>,
Tt_filter_function <Emphasis>filter</Emphasis>,
void *<Symbol Role="Variable">context</Symbol>,
void *<Emphasis>accumulator</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_file_quit(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>void tt_free(caddr_t <Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>char *tt_host_file_netfile(const char *<Symbol Role="Variable">host</Symbol>,
const char *<Symbol Role="Variable">filename</Symbol>);
</Synopsis>
<Synopsis>char *tt_host_netfile_file(const char *<Symbol Role="Variable">host</Symbol>,
const char *<Emphasis>netfilename</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_icontext_join(const char *<Emphasis>slotname</Emphasis>, int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_icontext_quit(const char *<Emphasis>slotname</Emphasis>, int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_initial_session(void);
</Synopsis>
<Synopsis>Tt_status tt_int_error(int <Emphasis>return_val</Emphasis>);
</Synopsis>
<Synopsis>int tt_is_err(Tt_status <Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>caddr_t tt_malloc(size_t <Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>int tt_mark(void);
</Synopsis>
<Synopsis>Tt_status tt_message_accept(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_address tt_message_address(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_address_set(Tt_message <Emphasis>m</Emphasis>, Tt_address <Symbol Role="Variable">a</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_add(Tt_message <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_bval(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
unsigned char **<Symbol Role="Variable">value</Symbol>,
int *<Emphasis>len</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_bval_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Emphasis>len</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_ival(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
int *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_ival_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_mode tt_message_arg_mode(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_arg_type(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_arg_val(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_val_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_xval(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void **<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_arg_xval_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>int tt_message_args_count(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_barg_add(Tt_message <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Emphasis>len</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_bcontext_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_callback_add(Tt_message <Emphasis>m</Emphasis>,
Tt_message_callback <Emphasis>f</Emphasis>);
</Synopsis>
<Synopsis>Tt_class tt_message_class(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_class_set(Tt_message <Emphasis>m</Emphasis>,
Tt_class <Emphasis>c</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_context_bval(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
unsigned char **<Symbol Role="Variable">value</Symbol>,
int *<Emphasis>len</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_context_ival(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
int *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_context_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_context_slotname(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_context_val(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_context_xval(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void **<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>int tt_message_contexts_count(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_message tt_message_create(void);
</Synopsis>
<Synopsis>Tt_message tt_message_create_super(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_destroy(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_disposition tt_message_disposition(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_disposition_set(Tt_message <Emphasis>m</Emphasis>,
Tt_disposition <Emphasis>r</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_fail(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_file(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_file_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Symbol Role="Variable">file</Symbol>);
</Synopsis>
<Synopsis>gid_t tt_message_gid(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_handler(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_handler_ptype(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_handler_ptype_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_handler_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>procid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_iarg_add(Tt_message <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_icontext_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_id(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_object(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_object_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_op(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_op_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>opname</Emphasis>);
</Synopsis>
<Synopsis>int tt_message_opnum(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_otype(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_otype_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>Tt_pattern tt_message_pattern(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_print(Tt_message *<Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_message tt_message_receive(void);
</Synopsis>
<Synopsis>Tt_status tt_message_reject(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_reply(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_scope tt_message_scope(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_scope_set(Tt_message <Emphasis>m</Emphasis>,
Tt_scope <Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_send(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_send_on_exit(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_sender(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_sender_ptype(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_sender_ptype_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_message_session(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_session_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>Tt_state tt_message_state(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>int tt_message_status(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_status_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">status</Symbol>);
</Synopsis>
<Synopsis>char *tt_message_status_string(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_status_string_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>status_str</Emphasis>);
</Synopsis>
<Synopsis>uid_t tt_message_uid(Tt_message <Emphasis>m</Emphasis>);
</Synopsis>
<Synopsis>void *tt_message_user(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">key</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_user_set(Tt_message <Emphasis>m</Emphasis>,
int <Symbol Role="Variable">key</Symbol>,
void *<Emphasis>v</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_message_xarg_add(Tt_message <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_xcontext_join(const char *<Emphasis>slotname</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_message_xcontext_set(Tt_message <Emphasis>m</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_netfile_file(const char *<Emphasis>netfilename</Emphasis>);
</Synopsis>
<Synopsis>int tt_objid_equal(const char *<Emphasis>objid1</Emphasis>,
const char *<Emphasis>objid2</Emphasis>);
</Synopsis>
<Synopsis>char *tt_objid_objkey(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>Tt_message tt_onotice_create(const char *<Emphasis>objid</Emphasis>,
const char *<Symbol Role="Variable">op</Symbol>);
</Synopsis>
<Synopsis>char *tt_open(void);
</Synopsis>
<Synopsis>Tt_message tt_orequest_create(const char *<Emphasis>objid</Emphasis>,
const char *<Symbol Role="Variable">op</Symbol>);
</Synopsis>
<Synopsis>char *tt_otype_base(const char *<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>char *tt_otype_derived(const char *<Emphasis>otype</Emphasis>,
int <Symbol Role="Variable">i</Symbol>);
</Synopsis>
<Synopsis>int tt_otype_deriveds_count(const char *<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>Tt_mode tt_otype_hsig_arg_mode(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>,
int <Emphasis>arg</Emphasis>);
</Synopsis>
<Synopsis>char *tt_otype_hsig_arg_type(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>,
int <Emphasis>arg</Emphasis>);
</Synopsis>
<Synopsis>int tt_otype_hsig_args_count(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>);
</Synopsis>
<Synopsis>int tt_otype_hsig_count(const char *<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>char *tt_otype_hsig_op(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>);
</Synopsis>
<Synopsis>int tt_otype_is_derived(const char *<Emphasis>derivedotype</Emphasis>,
const char *<Emphasis>baseotype</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_otype_opnum_callback_add(const char *<Emphasis>otid</Emphasis>,
int <Emphasis>opnum</Emphasis>,
Tt_message_callback <Emphasis>f</Emphasis>);
</Synopsis>
<Synopsis>Tt_mode tt_otype_osig_arg_mode(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>,
int <Emphasis>arg</Emphasis>);
</Synopsis>
<Synopsis>char *tt_otype_osig_arg_type(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>,
int <Emphasis>arg</Emphasis>);
</Synopsis>
<Synopsis>int tt_otype_osig_args_count(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>);
</Synopsis>
<Synopsis>int tt_otype_osig_count(const char*<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>char *tt_otype_osig_op(const char *<Emphasis>otype</Emphasis>,
int <Emphasis>sig</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_address_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_address <Symbol Role="Variable">d</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_arg_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_barg_add(Tt_pattern <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Emphasis>len</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_bcontext_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_callback_add(Tt_pattern <Emphasis>m</Emphasis>,
Tt_message_callback <Emphasis>f</Emphasis>);
</Synopsis>
<Synopsis>Tt_category tt_pattern_category(Tt_pattern <Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_category_set(Tt_pattern <Emphasis>p</Emphasis>,
Tt_category <Emphasis>c</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_class_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_class <Emphasis>c</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_context_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_pattern tt_pattern_create(void);
</Synopsis>
<Synopsis>Tt_status tt_pattern_destroy(Tt_pattern <Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_disposition_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_disposition <Emphasis>r</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_file_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Symbol Role="Variable">file</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_iarg_add(Tt_pattern <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_icontext_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
int <Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_object_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_op_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>opname</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_opnum_add(Tt_pattern <Emphasis>p</Emphasis>,
int <Emphasis>opnum</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_otype_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>otype</Emphasis>);
</Synopsis>
<Synopsis>char *tt_pattern_print(Tt_pattern *<Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_register(Tt_pattern <Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_scope_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_scope <Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_sender_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>procid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_sender_ptype_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_session_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_state_add(Tt_pattern <Emphasis>p</Emphasis>,
Tt_state <Symbol Role="Variable">s</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_unregister(Tt_pattern <Emphasis>p</Emphasis>);
</Synopsis>
<Synopsis>void *tt_pattern_user(Tt_pattern <Emphasis>p</Emphasis>,
int <Symbol Role="Variable">key</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_user_set(Tt_pattern <Emphasis>p</Emphasis>,
int <Symbol Role="Variable">key</Symbol>,
void *<Emphasis>v</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_xarg_add(Tt_pattern <Emphasis>m</Emphasis>,
Tt_mode <Symbol Role="Variable">n</Symbol>,
const char *<Emphasis>vtype</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pattern_xcontext_add(Tt_pattern <Emphasis>p</Emphasis>,
const char *<Emphasis>slotname</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>Tt_message tt_pnotice_create(Tt_scope <Emphasis>scope</Emphasis>,
const char *<Symbol Role="Variable">op</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_pointer_error(void *<Symbol Role="Variable">pointer</Symbol>);
</Synopsis>
<Synopsis>Tt_message tt_prequest_create(Tt_scope <Emphasis>scope</Emphasis>,
const char *<Symbol Role="Variable">op</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_ptr_error(<Symbol Role="Variable">pointer</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_ptype_declare(const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_ptype_exists(const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_ptype_opnum_callback_add(const char *<Emphasis>ptid</Emphasis>,
int <Emphasis>opnum</Emphasis>,
Tt_message_callback <Emphasis>f</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_ptype_undeclare(const char *<Emphasis>ptid</Emphasis>);
</Synopsis>
<Synopsis>void tt_release(int <Emphasis>mark</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_session_bprop(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
int <Symbol Role="Variable">i</Symbol>,
unsigned char **<Symbol Role="Variable">value</Symbol>,
int *<Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_session_bprop_add(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_session_bprop_set(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_session_join(const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_session_prop(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
int <Symbol Role="Variable">i</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_session_prop_add(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>int tt_session_prop_count(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_session_prop_set(const char *<Emphasis>sessid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_session_propname(const char *<Emphasis>sessid</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>int tt_session_propnames_count(const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_session_quit(const char *<Emphasis>sessid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_session_types_load(const char *<Emphasis>session</Emphasis>,
const char *<Symbol Role="Variable">filename</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_spec_bprop(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
int <Symbol Role="Variable">i</Symbol>,
unsigned char **<Symbol Role="Variable">value</Symbol>,
int *<Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_spec_bprop_add(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_spec_bprop_set(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const unsigned char *<Symbol Role="Variable">value</Symbol>,
int <Symbol Role="Variable">length</Symbol>);
</Synopsis>
<Synopsis>char *tt_spec_create(const char *<Emphasis>filepath</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_spec_destroy(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_spec_file(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_spec_move(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>newfilepath</Emphasis>);
</Synopsis>
<Synopsis>char *tt_spec_prop(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
int <Symbol Role="Variable">i</Symbol>);
</Synopsis>
<Synopsis>Tt_status tt_spec_prop_add(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>int tt_spec_prop_count(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_spec_prop_set(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>propname</Emphasis>,
const char *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
<Synopsis>char *tt_spec_propname(const char *<Emphasis>objid</Emphasis>,
int <Symbol Role="Variable">n</Symbol>);
</Synopsis>
<Synopsis>int tt_spec_propnames_count(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_spec_type(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_spec_type_set(const char *<Emphasis>objid</Emphasis>,
const char *<Emphasis>otid</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_spec_write(const char *<Emphasis>objid</Emphasis>);
</Synopsis>
<Synopsis>char *tt_status_message(Tt_status <Emphasis>ttrc</Emphasis>);
</Synopsis>
<Synopsis>int tt_trace_control(int <Emphasis>onoff</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tt_xcontext_quit(const char *<Emphasis>slotname</Emphasis>,
xdrproc_t <Emphasis>xdr_proc</Emphasis>,
void *<Symbol Role="Variable">value</Symbol>);
</Synopsis>
</RefSect1>
</refentry>

263
cde/doc/C/guides/man/man5/Tttttk.sgm Normal file
View File

@@ -0,0 +1,263 @@
<!-- $XConsortium: Tttttk.sgm /main/6 1996/08/31 14:47: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.MAN326.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN326.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Tt/tttk.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>Tt/tttk.h</Filename></RefName>
<RefPurpose>ToolTalk definitions
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Tttttk.sgm /main/6 1996/08/31 14:47: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>#include &lt;Tt/tttk.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">Tt/tttk.h</Filename> header defines the following enumeration data type,
with at least the following members:
</Para>
<VariableList>
<VarListEntry>
<Term><StructName Role="typedef">Tttk_op</StructName></Term>
<ListItem>
<Para><SystemItem Class="Constant">TTDT_CREATED</SystemItem>,
<SystemItem Class="Constant">TTDT_DELETED</SystemItem>,
<SystemItem Class="Constant">TTDT_DO_COMMAND</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_ENVIRONMENT</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_GEOMETRY</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_ICONIFIED</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_LOCALE</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_MAPPED</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_MODIFIED</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_SITUATION</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_STATUS</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_SYSINFO</SystemItem>,
<SystemItem Class="Constant">TTDT_GET_XINFO</SystemItem>,
<SystemItem Class="Constant">TTDT_LOWER</SystemItem>,
<SystemItem Class="Constant">TTDT_MODIFIED</SystemItem>,
<SystemItem Class="Constant">TTDT_MOVED</SystemItem>,
<SystemItem Class="Constant">TTDT_OP_LAST</SystemItem>,
<SystemItem Class="Constant">TTDT_OP_NONE</SystemItem>,
<SystemItem Class="Constant">TTDT_PAUSE</SystemItem>,
<SystemItem Class="Constant">TTDT_QUIT</SystemItem>,
<SystemItem Class="Constant">TTDT_RAISE</SystemItem>,
<SystemItem Class="Constant">TTDT_RESUME</SystemItem>,
<SystemItem Class="Constant">TTDT_REVERT</SystemItem>,
<SystemItem Class="Constant">TTDT_REVERTED</SystemItem>,
<SystemItem Class="Constant">TTDT_SAVE</SystemItem>,
<SystemItem Class="Constant">TTDT_SAVED</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_ENVIRONMENT</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_GEOMETRY</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_ICONIFIED</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_LOCALE</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_MAPPED</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_SITUATION</SystemItem>,
<SystemItem Class="Constant">TTDT_SET_XINFO</SystemItem>,
<SystemItem Class="Constant">TTDT_SIGNAL</SystemItem>,
<SystemItem Class="Constant">TTDT_STARTED</SystemItem>,
<SystemItem Class="Constant">TTDT_STATUS</SystemItem>,
<SystemItem Class="Constant">TTDT_STOPPED</SystemItem>,
<SystemItem Class="Constant">TTME_ABSTRACT</SystemItem>,
<SystemItem Class="Constant">TTME_COMPOSE</SystemItem>,
<SystemItem Class="Constant">TTME_DEPOSIT</SystemItem>,
<SystemItem Class="Constant">TTME_DISPLAY</SystemItem>,
<SystemItem Class="Constant">TTME_EDIT</SystemItem>,
<![ %CDE.C.CDE; [<SystemItem Class="Constant">TTME_INSTANTIATE</SystemItem>,
]]><SystemItem Class="Constant">TTME_INTERPRET</SystemItem>,
<SystemItem Class="Constant">TTME_MAIL</SystemItem>,
<SystemItem Class="Constant">TTME_MAIL_COMPOSE</SystemItem>,
<SystemItem Class="Constant">TTME_MAIL_EDIT</SystemItem>,
<SystemItem Class="Constant">TTME_PRINT</SystemItem>,
<SystemItem Class="Constant">TTME_TRANSLATE</SystemItem></Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The header declares the following global
string constants for some standard vtypes:
</Para>
<Synopsis>extern const char *Tttk_boolean:
extern const char *Tttk_file:
extern const char *Tttk_height:
extern const char *Tttk_integer:
extern const char *Tttk_message_id:
extern const char *Tttk_string:
extern const char *Tttk_title:
extern const char *Tttk_width:
extern const char *Tttk_xoffset:
extern const char *Tttk_yoffset:
</Synopsis>
<Para>The header declares the following as functions:
</Para>
<Synopsis>int ttdt_Get_Modified(Tt_message <Symbol Role="Variable">context</Symbol>,
const char *<Symbol Role="Variable">pathname</Symbol>,
Tt_scope <Emphasis>the_scope</Emphasis>,
XtAppContext <Emphasis>app2run</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_Revert(Tt_message <Symbol Role="Variable">context</Symbol>,
const char *<Symbol Role="Variable">pathname</Symbol>,
Tt_scope <Emphasis>the_scope</Emphasis>,
XtAppContext <Emphasis>app2run</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_Save(Tt_message <Symbol Role="Variable">context</Symbol>,
const char *<Symbol Role="Variable">pathname</Symbol>,
Tt_scope <Emphasis>the_scope</Emphasis>,
XtAppContext <Emphasis>app2run</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_close(const char *<Emphasis>procid</Emphasis>,
const char *<Emphasis>new_procid</Emphasis>,
int <Emphasis>sendStopped</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_file_event(Tt_message <Symbol Role="Variable">context</Symbol>,
Tttk_op <Symbol Role="Variable">event</Symbol>,
Tt_pattern *<Emphasis>patterns</Emphasis>,
int <Emphasis>send</Emphasis>);
</Synopsis>
<Synopsis>Tt_pattern *ttdt_file_join(const char *<Symbol Role="Variable">pathname</Symbol>,
Tt_scope <Emphasis>the_scope</Emphasis>,
int <Emphasis>join</Emphasis>,
Ttdt_file_cb <Emphasis>cb</Emphasis>,
void *<Emphasis>clientdata</Emphasis>);
</Synopsis>
<Synopsis>Tt_message ttdt_file_notice(Tt_message <Symbol Role="Variable">context</Symbol>,
Tttk_op <Symbol Role="Variable">op</Symbol>,
Tt_scope <Emphasis>scope</Emphasis>,
const char *<Symbol Role="Variable">pathname</Symbol>,
int <Emphasis>send_and_destroy</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_file_quit(Tt_pattern *<Emphasis>patterns</Emphasis>,
int <Symbol Role="Variable">quit</Symbol>);
</Synopsis>
<Synopsis>Tt_message ttdt_file_request(Tt_message <Symbol Role="Variable">context</Symbol>,
Tttk_op <Symbol Role="Variable">op</Symbol>,
Tt_scope <Emphasis>scope</Emphasis>,
const char *<Symbol Role="Variable">pathname</Symbol>,
Ttdt_file_cb <Emphasis>cb</Emphasis>,
void *<Symbol Role="Variable">client_data</Symbol>,
int <Emphasis>send_and_destroy</Emphasis>);
</Synopsis>
<Synopsis>Tt_pattern *ttdt_message_accept(Tt_message <Emphasis>contract</Emphasis>,
Ttdt_contract_cb <Emphasis>cb</Emphasis>,
Widget <Symbol Role="Variable">shell</Symbol>,
void *<Emphasis>clientdata</Emphasis>,
int <Emphasis>accept</Emphasis>,
int <Emphasis>sendStatus</Emphasis>);
</Synopsis>
<Synopsis>char *ttdt_open(int *<Emphasis>ttfd</Emphasis>,
const char *<Emphasis>toolname</Emphasis>,
const char *<Emphasis>vendor</Emphasis>,
const char *<Symbol Role="Variable">version</Symbol>,
int <Emphasis>sendStarted</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_sender_imprint_on(const char *<Emphasis>handler</Emphasis>,
Tt_message <Emphasis>contract</Emphasis>,
char **<Symbol Role="Variable">display</Symbol>,
int *<Symbol Role="Variable">width</Symbol>,
int *<Symbol Role="Variable">height</Symbol>,
int *<Symbol Role="Variable">xoffset</Symbol>,
int *<Symbol Role="Variable">yoffset</Symbol>,
XtAppContext <Emphasis>app2run</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_pattern *ttdt_session_join(const char *<Emphasis>sessid</Emphasis>,
Ttdt_contract_cb <Emphasis>cb</Emphasis>,
Widget <Symbol Role="Variable">shell</Symbol>,
void *<Emphasis>clientdata</Emphasis>,
int <Emphasis>join</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttdt_session_quit(const char *<Emphasis>sessid</Emphasis>,
Tt_pattern *<Emphasis>sess_pats</Emphasis>,
int <Symbol Role="Variable">quit</Symbol>);
</Synopsis>
<Synopsis>Tt_pattern *ttdt_subcontract_manage(Tt_message <Emphasis>subcontract</Emphasis>,
Ttdt_contract_cb <Emphasis>cb</Emphasis>,
Widget <Symbol Role="Variable">shell</Symbol>,
void *<Emphasis>clientdata</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttmedia_Deposit(Tt_message <Emphasis>load_contract</Emphasis>,
const char *<Emphasis>buffer_id</Emphasis>,
const char *<Emphasis>media_type</Emphasis>,
const unsigned char *<Emphasis>new_contents</Emphasis>,
int <Emphasis>new_len</Emphasis>,
const char *<Symbol Role="Variable">pathname</Symbol>,
XtAppContext <Emphasis>app2run</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_message ttmedia_load(Tt_message <Symbol Role="Variable">context</Symbol>,
Ttmedia_load_msg_cb <Emphasis>cb</Emphasis>,
void *<Emphasis>clientdata</Emphasis>,
Tttk_op <Symbol Role="Variable">op</Symbol>,
const char *<Emphasis>media_type</Emphasis>,
const unsigned char *<Emphasis>contents</Emphasis>,
int <Emphasis>len</Emphasis>,
const char *<Symbol Role="Variable">file</Symbol>,
const char *<Emphasis>docname</Emphasis>,
int <Emphasis>send</Emphasis>);
</Synopsis>
<Synopsis>Tt_message ttmedia_load_reply(Tt_message <Emphasis>contract</Emphasis>,
const unsigned char *<Emphasis>new_contents</Emphasis>,
int <Emphasis>new_len</Emphasis>,
int <Emphasis>reply_and_destroy</Emphasis>);
</Synopsis>
<Synopsis>Tt_status ttmedia_ptype_declare(const char *<Emphasis>ptype</Emphasis>,
int <Emphasis>base_opnum</Emphasis>,
Ttmedia_load_pat_cb <Emphasis>cb</Emphasis>,
void *<Emphasis>clientdata</Emphasis>,
int <Emphasis>declare</Emphasis>);
</Synopsis>
<Synopsis>void tttk_Xt_input_handler(XtPointer <Emphasis>procid</Emphasis>,
int *<Symbol Role="Variable">source</Symbol>,
XtInputId *<Emphasis>id</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tttk_block_while(XtAppContext <Emphasis>app2run</Emphasis>,
const int *<Emphasis>blocked</Emphasis>,
int <Emphasis>ms_timeout</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tttk_message_abandon(Tt_message <Emphasis>msg</Emphasis>);
</Synopsis>
<Synopsis>Tt_message tttk_message_create(Tt_message <Symbol Role="Variable">context</Symbol>,
Tt_class <Emphasis>the_class</Emphasis>,
Tt_scope <Emphasis>the_scope</Emphasis>,
const char *<Emphasis>handler</Emphasis>,
const char *<Symbol Role="Variable">op</Symbol>,
Tt_message_callback <Symbol Role="Variable">callback</Symbol>);
</Synopsis>
<Synopsis>Tt_status tttk_message_destroy(Tt_message <Emphasis>msg</Emphasis>);
</Synopsis>
<Synopsis>Tt_status tttk_message_fail(Tt_message <Emphasis>msg</Emphasis>,
Tt_status <Symbol Role="Variable">status</Symbol>,
const char *<Emphasis>status_string</Emphasis>,
int <Symbol Role="Variable">destroy</Symbol>);
</Synopsis>
<Synopsis>Tt_status tttk_message_reject(Tt_message <Emphasis>msg</Emphasis>,
Tt_status <Symbol Role="Variable">status</Symbol>,
const char *<Emphasis>status_string</Emphasis>,
int <Symbol Role="Variable">destroy</Symbol>);
</Synopsis>
<Synopsis>char *tttk_op_string(Tttk_op <Emphasis>opcode</Emphasis>);
</Synopsis>
<Synopsis>Tttk_op tttk_string_op(const char *<Emphasis>opstring</Emphasis>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

606
cde/doc/C/guides/man/man5/csacsa.sgm Normal file
View File

@@ -0,0 +1,606 @@
<!-- $XConsortium: csacsa.sgm /main/5 1996/09/08 20:00: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. -->
<RefEntry Id="CDEMX.MAN100.rsml.1">
<RefMeta>
<RefEntryTitle>csa/csa.h</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>csa/csa.h</Filename></RefName>
<RefPurpose>calendar and appointment services definitions
</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.-->
<!-- (c) Copyright 1994 X.400 API Association-->
<RefSynopsisDiv>
<Synopsis>#include &lt;csa/csa.h>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Filename Role="Header">csa/csa.h</Filename> header defines the following data types through
<Literal>typedef</Literal>:</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef short int CSA_sint16;
typedef long int CSA_sint32;
typedef unsigned char CSA_uint8;
typedef unsigned short int CSA_uint16;
typedef unsigned long int CSA_uint32;
typedef void * CSA_buffer;
typedef CSA_uint32 CSA_entry_handle;
typedef CSA_uint32 CSA_session_handle;
typedef char * CSA_string;
typedef CSA_string CSA_attribute_reference;
typedef CSA_uint32 CSA_boolean;
typedef CSA_string CSA_date_time;
typedef CSA_string CSA_date_time_range;
typedef CSA_sint32 CSA_enum;
typedef CSA_uint32 CSA_flags;
typedef CSA_uint32 CSA_return_code;
typedef CSA_string CSA_service_reference;
typedef CSA_string CSA_time_duration;
#define CSA_FALSE ((CSA_boolean)0)
#define CSA_TRUE ((CSA_boolean)1)
/* EXTENSION FLAGS */
#define CSA_EXT_REQUIRED ((CSA_flags)0x10000)
#define CSA_EXT_OUTPUT ((CSA_flags)0x20000)
#define CSA_EXT_LAST_ELEMENT ((CSA_flags)0x40000)
/* CALENDAR USER TYPE */
#define CSA_USER_TYPE_INDIVIDUAL ((CSA_enum)0)
#define CSA_USER_TYPE_GROUP ((CSA_enum)1)
#define CSA_USER_TYPE_RESOURCE ((CSA_enum)2)
/* CLASSIFICATION
#define CSA_CLASS_PUBLIC ((CSA_enum)0)
#define CSA_CLASS_PRIVATE ((CSA_enum)1)
#define CSA_CLASS_CONFIDENTIAL ((CSA_enum)2)
/* ACCESS RIGHTS FLAGS */
#define CSA_FREE_TIME_SEARCH ((CSA_flags)0x1)
#define CSA_VIEW_PUBLIC_ENTRIES ((CSA_flags)0x2)
#define CSA_VIEW_CONFIDENTIAL_ENTRIES ((CSA_flags)0x4)
#define CSA_VIEW_PRIVATE_ENTRIES ((CSA_flags)0x8)
#define CSA_INSERT_PUBLIC_ENTRIES ((CSA_flags)0x10)
#define CSA_INSERT_CONFIDENTIAL_ENTRIES ((CSA_flags)0x20)
#define CSA_INSERT_PRIVATE_ENTRIES ((CSA_flags)0x40)
#define CSA_CHANGE_PUBLIC_ENTRIES ((CSA_flags)0x80)
#define CSA_CHANGE_CONFIDENTIAL_ENTRIES ((CSA_flags)0x100)
#define CSA_CHANGE_PRIVATE_ENTRIES ((CSA_flags)0x200)
#define CSA_VIEW_CALENDAR_ATTRIBUTES ((CSA_flags)0x400)
#define CSA_INSERT_CALENDAR_ATTRIBUTES ((CSA_flags)0x800)
#define CSA_CHANGE_CALENDAR_ATTRIBUTES ((CSA_flags)0x1000)
#define CSA_ORGANIZER_RIGHTS ((CSA_flags)0x2000)
#define CSA_SPONSOR_RIGHTS ((CSA_flags)0x4000)
#define CSA_OWNER_RIGHTS ((CSA_flags)0x8000)
/* ATTENDEE PRIORITIES */
#define CSA_FOR_YOUR_INFORMATION ((CSA_enum)0)
#define CSA_ATTENDANCE_REQUESTED ((CSA_enum)1)
#define CSA_ATTENDANCE_REQUIRED ((CSA_enum)2)
#define CSA_IMMEDIATE_RESPONSE ((CSA_enum)3)
/* ATTENDEE STATUS */
#define CSA_STATUS_ACCEPTED ((CSA_enum)0)
#define CSA_STATUS_NEEDS_ACTION ((CSA_enum)1)
#define CSA_STATUS_SENT ((CSA_enum)2)
#define CSA_STATUS_TENTATIVE ((CSA_enum)3)
#define CSA_STATUS_CONFIRMED ((CSA_enum)4)
#define CSA_STATUS_REJECTED ((CSA_enum)5)
#define CSA_STATUS_COMPLETED ((CSA_enum)6)
#define CSA_STATUS_DELEGATED ((CSA_enum)7)
/* ATTRIBUTE VALUE TYPE */
#define CSA_VALUE_BOOLEAN ((CSA_enum) 0)
#define CSA_VALUE_ENUMERATED ((CSA_enum) 1)
#define CSA_VALUE_FLAGS ((CSA_enum) 2)
#define CSA_VALUE_SINT32 ((CSA_enum) 3)
#define CSA_VALUE_UINT32 ((CSA_enum) 4)
#define CSA_VALUE_STRING ((CSA_enum) 5)
#define CSA_VALUE_CALENDAR_USER ((CSA_enum) 6)
#define CSA_VALUE_DATE_TIME ((CSA_enum) 7)
#define CSA_VALUE_DATE_TIME_RANGE ((CSA_enum) 8)
#define CSA_VALUE_TIME_DURATION ((CSA_enum) 9)
#define CSA_VALUE_ACCESS_LIST ((CSA_enum) 10)
#define CSA_VALUE_ATTENDEE_LIST ((CSA_enum) 11)
#define CSA_VALUE_DATE_TIME_LIST ((CSA_enum) 12)
#define CSA_VALUE_REMINDER ((CSA_enum) 13)
#define CSA_VALUE_OPAQUE_DATA ((CSA_enum) 14)
/* CROSS FUNCTION FLAGS */
/* SCOPE */
#define CSA_SCOPE_ALL ((CSA_enum)0)
#define CSA_SCOPE_ONE ((CSA_enum)1)
#define CSA_SCOPE_FORWARD ((CSA_enum)2)
/* OPERATORS */
#define CSA_MATCH_ANY ((CSA_enum)0)
#define CSA_MATCH_EQUAL_TO ((CSA_enum)1)
#define CSA_MATCH_NOT_EQUAL_TO ((CSA_enum)2)
#define CSA_MATCH_GREATER_THAN ((CSA_enum)3)
#define CSA_MATCH_LESS_THAN ((CSA_enum)4)
#define CSA_MATCH_GREATER_THAN_OR_EQUAL_TO ((CSA_enum)5)
#define CSA_MATCH_LESS_THAN_OR_EQUAL_TO ((CSA_enum)6)
#define CSA_MATCH_CONTAIN ((CSA_enum)7)
#define CSA_LOOKUP_RESOLVE_PREFIX_SEARCH ((CSA_flags)0x1)
#define CSA_LOOKUP_RESOLVE_IDENTITY ((CSA_flags)0x2)
#define CSA_CONFIG_CHARACTER_SET ((CSA_enum)0)
#define CSA_CONFIG_LINE_TERM ((CSA_enum)1)
#define CSA_CONFIG_DEFAULT_SERVICE ((CSA_enum)2)
#define CSA_CONFIG_DEFAULT_USER ((CSA_enum)3)
#define CSA_CONFIG_REQ_PASSWORD ((CSA_enum)4)
#define CSA_CONFIG_REQ_SERVICE ((CSA_enum)5)
#define CSA_CONFIG_REQ_USER ((CSA_enum)6)
#define CSA_CONFIG_UI_AVALI ((CSA_enum)7)
#define CSA_CONFIG_VER_IMPLEM ((CSA_enum)8)
#define CSA_CONFIG_VER_SPEC ((CSA_enum)9)
/* CHARACTER SET IDENTIFIERS */
#define CSA_CHARSET_437 "&minus;//XAPIA//CHARSET IBM 437//EN"
#define CSA_CHARSET_850 "&minus;//XAPIA//CHARSET IBM 850//EN"
#define CSA_CHARSET_1252 "&minus;//XAPIA//CHARSET Microsoft 1252//EN"
#define CSA_CHARSET_ISTRING "&minus;//XAPIA//CHARSET Apple ISTRING//EN"
#define CSA_CHARSET_UNICODE "&minus;//XAPIA//CHARSET UNICODE//EN"
#define CSA_CHARSET_T61 "&minus;//XAPIA//CHARSET TSS T61//EN"
#define CSA_CHARSET_IA5 "&minus;//XAPIA//CHARSET TSS IA5//EN"
#define CSA_CHARSET_ISO_10646 "&minus;//XAPIA//CHARSET ISO 10646//EN"
#define CSA_CHARSET_ISO_646 "&minus;//XAPIA//CHARSET ISO 646//EN"
#define CSA_CHARSET_ISO_8859_1 "&minus;//XAPIA//CHARSET ISO 8859&minus;1//EN"
#define CSA_CB_CALENDAR_LOGON ((CSA_flags)0x0
#define CSA_CB_CALENDAR_DELETED ((CSA_flags)0x1)
#define CSA_CB_CALENDAR_ATTRIBUTE_UPDATED ((CSA_flags)0x2)
#define CSA_CB_ENTRY_ADDED ((CSA_flags)0x4)
#define CSA_CB_ENTRY_DELETED ((CSA_flags)0x8)
#define CSA_CB_ENTRY_UPDATED ((CSA_flags)0x10)
/* Entry Types */
#define CSA_TYPE_EVENT ((CSA_enum)0)
#define CSA_TYPE_TODO ((CSA_enum)1)
#define CSA_TYPE_MEMO ((CSA_enum)2)
/* RETURN ERROR FLAGS */
#define CSA_ERROR_RSV_MASK ((CSA_return_code)0x0000FFFF)
#define CSA_ERROR_IMPL_MASK ((CSA_return_code)0xFFFF0000)
/* RETURN CODES */
#define CSA_SUCCESS ((CSA_return_code)0)
#define CSA_E_AMBIGUOUS_USER ((CSA_return_code)1)
#define CSA_E_CALENDAR_EXISTS ((CSA_return_code)2)
#define CSA_E_CALENDAR_NOT_EXIST ((CSA_return_code)3)
#define CSA_E_CALLBACK_NOT_REGISTERED ((CSA_return_code)4)
#define CSA_E_DISK_FULL ((CSA_return_code)5)
#define CSA_E_FAILURE ((CSA_return_code)6)
#define CSA_E_FILE_EXIST ((CSA_return_code)7)
#define CSA_E_FILE_NOT_EXIST ((CSA_return_code)8)
#define CSA_E_INSUFFICIENT_MEMORY ((CSA_return_code)9)
#define CSA_E_INVALID_ATTRIBUTE ((CSA_return_code)10)
#define CSA_E_INVALID_ATTRIBUTE_VALUE ((CSA_return_code)11)
#define CSA_E_INVALID_CALENDAR_SERVICE ((CSA_return_code)12)
#define CSA_E_INVALID_CONFIGURATION ((CSA_return_code)13)
#define CSA_E_INVALID_DATA_EXT ((CSA_return_code)14)
#define CSA_E_INVALID_DATE_TIME ((CSA_return_code)15)
#define CSA_E_INVALID_ENTRY_HANDLE ((CSA_return_code)16)
#define CSA_E_INVALID_ENUM ((CSA_return_code)17)
#define CSA_E_INVALID_FILE_NAME ((CSA_return_code)18)
#define CSA_E_INVALID_FLAG ((CSA_return_code)19)
#define CSA_E_INVALID_FUNCTION_EXT ((CSA_return_code)20)
#define CSA_E_INVALID_MEMORY ((CSA_return_code)21)
#define CSA_E_INVALID_PARAMETER ((CSA_return_code)22)
#define CSA_E_INVALID_PASSWORD ((CSA_return_code)23)
#define CSA_E_INVALID_RETURN_CODE ((CSA_return_code)24)
#define CSA_E_INVALID_SESSION_HANDLE ((CSA_return_code)25)
#define CSA_E_INVALID_USER ((CSA_return_code)26)
#define CSA_E_LOCALE_MISMATCH ((CSA_return_code)27)
#define CSA_E_LOGON_FAILURE ((CSA_return_code)28)
#define CSA_E_NO_AUTHORITY ((CSA_return_code)29)
#define CSA_E_NOT_SUPPORTED ((CSA_return_code)30)
#define CSA_E_PASSWORD_REQUIRED ((CSA_return_code)31)
#define CSA_E_READONLY ((CSA_return_code)32)
#define CSA_E_SERVICE_UNAVAILABLE ((CSA_return_code)33)
#define CSA_E_TEXT_TOO_LARGE ((CSA_return_code)34)
#define CSA_E_TOO_MANY_USERS ((CSA_return_code)35)
#define CSA_E_UNABLE_TO_OPEN_FILE ((CSA_return_code)36)
#define CSA_E_UNSUPPORTED_ATTRIBUTE ((CSA_return_code)37)
#define CSA_E_UNSUPPORTED_CHARACTER_SET ((CSA_return_code)38)
#define CSA_E_UNSUPPORTED_DATA_EXT ((CSA_return_code)39)
#define CSA_E_UNSUPPORTED_FLAG ((CSA_return_code)40)
#define CSA_E_UNSUPPORTED_FUNCTION_EXT ((CSA_return_code)41)
#define CSA_E_UNSUPPORTED_PARAMETER ((CSA_return_code)42)
#define CSA_E_UNSUPPORTED_VERSION ((CSA_return_code)43)
#define CSA_E_USER_NOT_FOUND ((CSA_return_code)44)
/* CALENDAR ATTRIBUTES */
/* CALENDAR ATTRIBUTE NAMES */
#define CSA_CAL_ATTR_ACCESS_LIST &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Access List//EN"
#define CSA_CAL_ATTR_CALENDAR_NAME &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Calendar Name//EN"
#define CSA_CAL_ATTR_CALENDAR_OWNER &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Calendar Owner//EN"
#define CSA_CAL_ATTR_CALENDAR_SIZE &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Calendar Size//EN"
#define CSA_CAL_ATTR_CODE_PAGE &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Character Set//EN"
#define CSA_CAL_ATTR_COUNTRY &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Country//EN"
#define CSA_CAL_ATTR_DATE_CREATED &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Date Created//EN"
#define CSA_CAL_ATTR_LANGUAGE &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Language//EN"
#define CSA_CAL_ATTR_NUMBER_ENTRIES &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Number Entries//EN"
#define CSA_CAL_ATTR_PRODUCT_IDENTIFIER &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Product Identifier//EN"
#define CSA_CAL_ATTR_TIME_ZONE &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Time Zone//EN"
#define CSA_CAL_ATTR_VERSION &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Version//EN"
#define CSA_CAL_ATTR_WORK_SCHEDULE &bsol;
"&minus;//XAPIA/CSA/CALATTR//NONSGML Work Schedule//EN"
/* ENTRY ATTRIBUTES */
/* ENTRY ATTRIBUTES NAMES */
#define CSA_ENTRY_ATTR_ATTENDEE_LIST &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Attendee List//EN"
#define CSA_ENTRY_ATTR_AUDIO_REMINDER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Audio Reminder//EN"
#define CSA_ENTRY_ATTR_CLASSIFICATION &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Classification//EN"
#define CSA_ENTRY_ATTR_DATE_COMPLETED &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Date Complated//EN"
#define CSA_ENTRY_ATTR_DATE_CREATED &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Date Created//EN"
#define CSA_ENTRY_ATTR_DESCRIPTION &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Description//EN"
#define CSA_ENTRY_ATTR_DUE_DATE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Due Date//EN"
#define CSA_ENTRY_ATTR_END_DATE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML End Date//EN"
#define CSA_ENTRY_ATTR_EXCEPTION_DATES &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Exception Dates//EN"
#define CSA_ENTRY_ATTR_EXCEPTION_RULE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Exception Rule//EN"
#define CSA_ENTRY_ATTR_FLASHING_REMINDER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Flashing Reminder//EN"
#define CSA_ENTRY_ATTR_LAST_UPDATE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Last Update//EN"
#define CSA_ENTRY_ATTR_MAIL_REMINDER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Mail Reminder//EN"
#define CSA_ENTRY_ATTR_NUMBER_RECURRENCES &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Number Recurrences//EN"
#define CSA_ENTRY_ATTR_ORGANIZER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Organizer//EN"
#define CSA_ENTRY_ATTR_POPUP_REMINDER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Popup Reminder//EN"
#define CSA_ENTRY_ATTR_PRIORITY &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Priority//EN"
#define CSA_ENTRY_ATTR_RECURRENCE_RULE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Recurrence Rule//EN"
#define CSA_ENTRY_ATTR_RECURREING_DATES &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Recurring Dates//EN"
#define CSA_ENTRY_ATTR_REFERENCE_IDENTIFIER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Reference_identifier//EN"
#define CSA_ENTRY_ATTR_SEQUENCE_NUMBER &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Sequence Number//EN"
#define CSA_ENTRY_ATTR_SPONSOR &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Sponsor//EN"
#define CSA_ENTRY_ATTR_START_DATE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Start Date//EN"
#define CSA_ENTRY_ATTR_STATUS &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Status//EN"
#define CSA_ENTRY_ATTR_SUBTYPE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Subtype//EN"
#define CSA_ENTRY_ATTR_SUMMARY &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Summary//EN"
#define CSA_ENTRY_ATTR_TIME_TRANSPARENCY &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Transparency//EN"
#define CSA_ENTRY_ATTR_TYPE &bsol;
"&minus;//XAPIA/CSA/ENTRYATTR//NONSGML Type//EN"
/* COMMON EXTENSIONS DECLARATIONS */
/* EXTENSION SET ID */
/* Common Extension Set */
#define CSA_XS_COM ((CSA_uint32) 0)
/* Bilateral Extension Set */
#define CSA_XS_BLT ((CSA_uint32) 256)
/* FUNCTION EXTENSIONS */
/* Query for extension support in implementation */
#define CSA_X_COM_SUPPORT_EXT ((CSA_uint32) 1)
#define CSA_X_COM_SUPPORTED ((CSA_flags) 1)
#define CSA_X_COM_NOT_SUPPORTED ((CSA_flags) 2)
#define CSA_X_COM_DATA_EXT_SUPPORTED ((CSA_flags) 4)
#define CSA_X_COM_FUNC_EXT_SUPPORTED ((CSA_flags) 8)
#define CSA_X_COM_SUP_EXCLUDE ((CSA_flags) 16)
#define CSA_X_UI_ID_EXT ((CSA_uint32)2)
/* EXTENSION FLAGS */
#define CSA_X_LOGON_UI_ALLOWED ((CSA_flags)0x1)
#define CSA_X_ERROR_UI_ALLOWED ((CSA_flags)0x2)
#define CSA_X_LOOKUP_RESOLVE_UI ((CSA_flags)0x4)
#define CSA_X_LOOKUP_DETAILS_UI ((CSA_flags)0x8)
#define CSA_X_LOOKUP_ADDRESSING_UI ((CSA_flags)0x10)
#define CSA_X_ADD_DEFINE_ENTRY_UI ((CSA_flags)0x20)
/* EXTENSION RETURN CODES */
#define CSA_X_E_INVALID_UI_ID ((CSA_return_code)1025)
#define CSA_X_E_LOGON_FAILURE ((CSA_return_code)1026)
#define CSA_X_E_USER_CANCEL ((CSA_return_code)1027)
#define CSA_X_XT_APP_CONTEXT_EXT ((CSA_uint32)3)
</ProgramListing>
</InformalExample>
<Para>The header declares the following structures:
</Para>
<InformalExample Remap="indent">
<ProgramListing>typedef struct CSA_TAG_EXTENSION {
CSA_uint32 <Emphasis>item_code</Emphasis>;
CSA_uint32 <Emphasis>item_data</Emphasis>;
CSA_buffer <Emphasis>item_reference</Emphasis>;
CSA_flags <Emphasis>extension_flags</Emphasis>;
} CSA_extension;
typedef struct CSA_TAG_CALENDAR_USER {
CSA_string <Emphasis>user_name</Emphasis>;
CSA_enum <Emphasis>user_type</Emphasis>;
CSA_string <Emphasis>calendar_address</Emphasis>;
CSA_extension *<Emphasis>calendar_user_extensions</Emphasis>;
} CSA_calendar_user;
typedef struct CSA_TAG_ACCESS_RIGHTS {
CSA_calendar_user *<Emphasis>user</Emphasis>;
CSA_flags <Emphasis>rights</Emphasis>;
struct CSA_TAG_ACCESS_RIGHTS *<Symbol Role="Variable">next</Symbol>;
} CSA_access_rights, *CSA_access_list;
typedef struct CSA_TAG_ATTENDEE {
CSA_calendar_user <Emphasis>attendee</Emphasis>;
CSA_enum <Emphasis>priority</Emphasis>;
CSA_enum <Symbol Role="Variable">status</Symbol>;
CSA_boolean <Emphasis>rsvp_requested</Emphasis>;
struct CSA_TAG_ATTENDEE *<Symbol Role="Variable">next</Symbol>;
} CSA_attendee, *CSA_attendee_list;
typedef struct CSA_TAG_OPAQUE_DATA {
CSA_uint32 <Symbol Role="Variable">size</Symbol>;
CSA_uint8 *<Symbol Role="Variable">data</Symbol>;
} CSA_opaque_data;
typedef void (*CSA_callback)(
CSA_session_handle <Emphasis>session</Emphasis>,
CSA_flags <Symbol Role="Variable">reason</Symbol>,
CSA_buffer <Symbol Role="Variable">call_data</Symbol>,
CSA_buffer <Symbol Role="Variable">client_data</Symbol>,
CSA_extension *<Emphasis>callback_extensions</Emphasis>
);
typedef struct CSA_TAG_LOGON_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
} CSA_logon_callback_data;
typedef struct CSA_TAG_CALENDAR_DELETED_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
} CSA_calendar_deleted_callback_data;
typedef struct CSA_TAG_CALENDAR_ATTR_UPDATE_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
CSA_uint32 <Emphasis>number_attributes</Emphasis>;
CSA_attribute_reference *<Emphasis>attribute_names</Emphasis>;
} CSA_calendar_attr_update_callback_data;
typedef struct CSA_TAG_ADD_ENTRY_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
CSA_opaque_data <Emphasis>added_entry_id</Emphasis>;
} CSA_add_entry_callback_data;
typedef struct CSA_TAG_DELETE_ENTRY_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
CSA_opaque_data <Emphasis>deleted_entry_id</Emphasis>;
CSA_enum <Emphasis>scope</Emphasis>;
CSA_date_time <Emphasis>date_and_time</Emphasis>;
} CSA_delete_entry_callback_data;
typedef struct CSA_TAG_UPDATE_ENTRY_CB_DATA {
CSA_calendar_user *<Emphasis>user</Emphasis>;
CSA_opaque_data <Emphasis>old_entry_id</Emphasis>;
CSA_opaque_data <Emphasis>new_entry_id</Emphasis>;
CSA_enum <Emphasis>scope</Emphasis>;
CSA_date_time <Emphasis>date_and_time</Emphasis>;
} CSA_update_entry_callback_data;
typedef struct CSA_TAG_DATE_TIME_ITEM {
CSA_date_time <Emphasis>date_time</Emphasis>;
struct CSA_TAG_DATE_TIME_ITEM *<Symbol Role="Variable">next</Symbol>;
} CSA_date_time_entry, *CSA_date_time_list;
typedef struct CSA_TAG_FREE_TIME {
CSA_uint32 <Emphasis>number_free_time_data</Emphasis>;
CSA_date_time_range *<Emphasis>free_time_data</Emphasis>;
} CSA_free_time;
typedef struct CSA_TAG_REMINDER {
CSA_time_duration <Emphasis>lead_time</Emphasis>;
CSA_time_duration <Emphasis>snooze_time</Emphasis>;
CSA_uint32 <Emphasis>repeat_count</Emphasis>;
CSA_opaque_data <Emphasis>reminder_data</Emphasis>;
} CSA_reminder;
typedef struct CSA_TAG_REMINDER_REFERENCE {
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>;
CSA_date_time <Emphasis>run_time</Emphasis>;
CSA_time_duration <Emphasis>snooze_time</Emphasis>;
CSA_uint32 <Emphasis>repeat_count</Emphasis>;
CSA_attribute_reference <Emphasis>attribute_name</Emphasis>;
} CSA_reminder_reference;
typedef struct CSA_TAG_ATTRIBUTE_ITEM {
CSA_enum <Symbol Role="Variable">type</Symbol>;
union {
CSA_boolean <Emphasis>boolean_value</Emphasis>;
CSA_enum <Emphasis>enumerated_value</Emphasis>;
CSA_flags <Emphasis>flags_value</Emphasis>;
CSA_sint32 <Emphasis>sint32_value</Emphasis>;
CSA_uint32 <Emphasis>uint32_value</Emphasis>;
CSA_calendar_user <Emphasis>calendar_user_value</Emphasis>;
CSA_date_time <Emphasis>date_time_value</Emphasis>;
CSA_date_time_range <Emphasis>date_time_range_value</Emphasis>;
CSA_time_duration <Emphasis>time_duration_value</Emphasis>;
CSA_string <Emphasis>string_value</Emphasis>;
CSA_attendee_list <Emphasis>attendee_list_value</Emphasis>;
CSA_date_time_list <Emphasis>date_time_list_value</Emphasis>;
CSA_access_list <Emphasis>access_list_value</Emphasis>;
CSA_reminder *<Emphasis>reminder_value</Emphasis>;
CSA_opaque_data *<Emphasis>opaque_data_value</Emphasis>;
} item;
} CSA_attribute_value;
typedef struct CSA_TAG_ATTRIBUTE {
CSA_string <Symbol Role="Variable">name</Symbol>;
CSA_attribute_value *<Symbol Role="Variable">value</Symbol>;
CSA_extension *<Emphasis>attribute_extensions</Emphasis>;
} CSA_attribute;
typedef struct CSA_TAG_WORK_SCHEDULE {
CSA_date_time <Emphasis>schedule_begin_time</Emphasis>;
CSA_boolean <Emphasis>cyclic_definition_flag</Emphasis>;
CSA_date_time <Emphasis>cycle_end_time</Emphasis>;
CSA_date_time_list *<Emphasis>work_cycle</Emphasis>;
} CSA_work_schedule;
typedef struct CSA_TAG_XCOM {
CSA_uint32 <Emphasis>item_code</Emphasis>;
CSA_flags <Symbol Role="Variable">flags</Symbol>;
} CSA_X_COM_support;
</ProgramListing>
</InformalExample>
<Para>The header declares the following as functions:
</Para>
<Synopsis>CSA_return_code csa_add_calendar(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_calendar_user *<Emphasis>user</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>calendar_attributes</Emphasis>,
CSA_extension *<Emphasis>add_calendar_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_add_entry(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>entry_attributes</Emphasis>,
CSA_entry_handle *<Symbol Role="Variable">entry</Symbol>,
CSA_extension *<Emphasis>add_entry_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_call_callbacks(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_flags <Symbol Role="Variable">reason</Symbol>,
CSA_extension *<Emphasis>call_callbacks_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_delete_calendar(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_extension *<Emphasis>delete_calendar_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_delete_entry(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>,
CSA_enum <Emphasis>delete_scope</Emphasis>,
CSA_extension *<Emphasis>delete_entry_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_free(CSA_buffer <Emphasis>memory</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_free_time_search(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_date_time_range <Emphasis>date_time_range</Emphasis>,
CSA_time_duration <Emphasis>time_duration</Emphasis>,
CSA_uint32 <Emphasis>number_users</Emphasis>,
CSA_calendar_user *<Emphasis>calendar_users</Emphasis>,
CSA_free_time **<Emphasis>free_time</Emphasis>,
CSA_extension *<Emphasis>free_time_search_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_list_calendar_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 *<Emphasis>number_names</Emphasis>,
CSA_attribute_reference **<Emphasis>calendar_attributes_names</Emphasis>,
CSA_extension *<Emphasis>list_calendar_attributes_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_list_calendars(CSA_service_reference <Emphasis>calendar_service</Emphasis>,
CSA_uint32 *<Emphasis>number_names</Emphasis>,
CSA_calendar_user **<Emphasis>calendar_names</Emphasis>,
CSA_extension *<Emphasis>list_calendars_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_list_entries(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>entry_attributes</Emphasis>
CSA_enum *<Emphasis>list_operators</Emphasis>,
CSA_uint32 *<Emphasis>number_entries</Emphasis>,
CSA_entry_handle **<Emphasis>entries</Emphasis>,
CSA_extension *<Emphasis>list_entries_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_list_entry_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>,
CSA_uint32 *<Emphasis>number_names</Emphasis>,
CSA_attribute_reference **<Emphasis>entry_attributes_names</Emphasis>
CSA_extension *<Emphasis>list_entry_attributes_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_list_entry_sequence(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>,
CSA_date_time_range <Emphasis>time_range</Emphasis>,
CSA_uint32 *<Emphasis>number_entries</Emphasis>,
CSA_entry_handle **<Emphasis>entry_list</Emphasis>,
CSA_extension *<Emphasis>list_entry_sequence_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_logoff(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_extension *<Emphasis>logoff_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_logon(CSA_service_reference <Emphasis>calendar_service</Emphasis>,
CSA_calendar_user *<Emphasis>user</Emphasis>,
CSA_string <Emphasis>password</Emphasis>,
CSA_string <Emphasis>character_set</Emphasis>,
CSA_string <Emphasis>required_csa_version</Emphasis>,
CSA_session_handle *<Emphasis>session</Emphasis>,
CSA_extension *<Emphasis>logon_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_look_up(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_calendar_user *<Emphasis>users</Emphasis>,
CSA_flags <Emphasis>look_up_flags</Emphasis>,
CSA_uint32 *<Emphasis>number_users</Emphasis>,
CSA_calendar_user **<Emphasis>user_list</Emphasis>,
CSA_extension *<Emphasis>look_up_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_query_configuration(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_enum <Symbol Role="Variable">item</Symbol>,
CSA_buffer *<Emphasis>reference</Emphasis>,
CSA_extension *<Emphasis>query_configuration_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_read_calendar_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 <Emphasis>number_names</Emphasis>,
CSA_attribute_reference *<Emphasis>attribute_names</Emphasis>,
CSA_uint32 *<Emphasis>number_attributes</Emphasis>,
CSA_attribute **<Emphasis>calendar_attributes</Emphasis>
CSA_extension *<Emphasis>read_calendar_attributes_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_read_entry_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>,
CSA_uint32 <Emphasis>number_names</Emphasis>,
CSA_attribute_reference *<Emphasis>attribute_names</Emphasis>,
CSA_uint32 *<Emphasis>number_attributes</Emphasis>,
CSA_attribute **<Emphasis>entry_attributes</Emphasis>,
CSA_extension *<Emphasis>read_entry_attributes_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_read_next_reminder(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 <Emphasis>number_names</Emphasis>,
CSA_attribute_reference *<Emphasis>reminder_names</Emphasis>,
CSA_date_time <Emphasis>given_time</Emphasis>,
CSA_uint32 *<Emphasis>number_reminders</Emphasis>
CSA_reminder_reference **<Emphasis>reminder_references</Emphasis>,
CSA_extension *<Emphasis>read_next_reminder_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_register_callback(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_flags <Symbol Role="Variable">reason</Symbol>,
CSA_callback <Symbol Role="Variable">callback</Symbol>,
CSA_buffer <Symbol Role="Variable">client_data</Symbol>,
CSA_extension *<Emphasis>register_callback_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_restore(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_string <Emphasis>archive_name</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>attributes</Emphasis>,
CSA_enum *<Emphasis>operators</Emphasis>,
CSA_extension *<Emphasis>restore_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_save(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_string <Emphasis>archive_name</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>
CSA_attribute *<Emphasis>attributes</Emphasis>,
CSA_enum *<Emphasis>operators</Emphasis>,
CSA_boolean <Emphasis>delete_entry</Emphasis>,
CSA_extension *<Emphasis>save_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_unregister_callback(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_flags <Symbol Role="Variable">reason</Symbol>,
CSA_callback <Symbol Role="Variable">callback</Symbol>,
CSA_buffer <Symbol Role="Variable">client_data</Symbol>,
CSA_extension *<Emphasis>unregister_callback_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_update_calendar_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>calendar_attributes</Emphasis>,
CSA_extension *<Emphasis>update_calendar_attributes_extensions</Emphasis>);
</Synopsis>
<Synopsis>CSA_return_code csa_update_entry_attributes(CSA_session_handle <Emphasis>session</Emphasis>,
CSA_entry_handle <Symbol Role="Variable">entry</Symbol>,
CSA_enum <Emphasis>update_scope</Emphasis>,
CSA_boolean <Emphasis>update_propagation</Emphasis>,
CSA_uint32 <Emphasis>number_attributes</Emphasis>,
CSA_attribute *<Emphasis>entry_attributes</Emphasis>,
CSA_entry_handle *<Emphasis>new_entry</Emphasis>,
CSA_extension *<Emphasis>update_entry_attributes_extensions</Emphasis>);
</Synopsis>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

75
cde/doc/C/guides/man/man5/dtactact.sgm Normal file
View File

@@ -0,0 +1,75 @@
<!-- $XConsortium: dtactact.sgm /main/5 1996/08/30 13:52:16 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.XCSA.MAN81.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN81.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtactionaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtactionaction</Literal></RefName>
<RefPurpose>&str-XZ; action management actions
</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>Dtcreate [file]
ReloadActions
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Action Creation Services support the following
action management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtcreate</Literal></Term>
<ListItem>
<Para>Open an empty view of the desktop action and data type editor.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtcreate</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open a view of the desktop action and data type editor
and load the action and data type description file
named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
The description file must have been previously created
by the desktop action and data type editor.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>ReloadActions</Literal></Term>
<ListItem>
<Para>Reload the database of desktop actions.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

64
cde/doc/C/guides/man/man5/dtappact.sgm Normal file
View File

@@ -0,0 +1,64 @@
<!-- $XConsortium: dtappact.sgm /main/5 1996/08/30 13:52: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.XCSA.MAN82.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN82.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtappaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtappaction</Literal></RefName>
<RefPurpose>&str-XZ; application management actions
</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>Dtappmgr
ReloadApps
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Application Integration Services support the following
application management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtappmgr</Literal></Term>
<ListItem>
<Para>Open a view of the Application Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>ReloadApps</Literal></Term>
<ListItem>
<Para>Reload the database of action and data types,
update the Application Manager and update the index of help information.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

91
cde/doc/C/guides/man/man5/dtbuiact.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: dtbuiact.sgm /main/5 1996/08/30 13:52: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.XCSA.MAN83.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN83.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtbuilderaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtbuilderaction</Literal></RefName>
<RefPurpose>&str-XZ; application builder actions
</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>Dtbuilder [<Emphasis>component</Emphasis>]
Dtcodegen [<Emphasis>component</Emphasis>]
Open <Emphasis>component</Emphasis>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Application Builder Services support the following
application builder actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtbuilder</Literal></Term>
<ListItem>
<Para>Open an empty application builder view.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtbuilder</Literal>&numsp;<Emphasis>component</Emphasis></Term>
<ListItem>
<Para>Open an application builder view of the module or project
named by the pathname in the
<Emphasis>component</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtcodegen</Literal></Term>
<ListItem>
<Para>Prompt the user for the pathname of a project
and generate code for the project specified by the user.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtcodegen</Literal>&numsp;<Emphasis>component</Emphasis></Term>
<ListItem>
<Para>Generate code for the project named by the pathname in the
<Emphasis>component</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Emphasis>component</Emphasis></Term>
<ListItem>
<Para>Open an application builder view of the module or project
named by the pathname in the
<Emphasis>component</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

94
cde/doc/C/guides/man/man5/dtcalact.sgm Normal file
View File

@@ -0,0 +1,94 @@
<!-- $XConsortium: dtcalact.sgm /main/5 1996/08/30 13:52: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.XCSA.MAN85.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN85.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtcalendaraction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtcalendaraction</Literal></RefName>
<RefPurpose>&str-XZ; calendar and appointment management actions
</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>Dtcm
DtcmEdit <Emphasis>appointment</Emphasis>
DtcmInsert <Emphasis>appointment</Emphasis>
Open <Emphasis>appointment</Emphasis>
Insert <Emphasis>appointment</Emphasis>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Calendar and Appointment Services support the following
calendar and appointment management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtcm</Literal></Term>
<ListItem>
<Para>Open a view of the user's default calendar.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>DtcmEdit</Literal>&numsp;<Emphasis>appointment</Emphasis></Term>
<ListItem>
<Para>Edit the appointment named by the pathname in the
<Emphasis>appointment</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>DtcmInsert</Literal>&numsp;<Emphasis>appointment</Emphasis></Term>
<ListItem>
<Para>Insert the appointment named by the pathname in the
<Emphasis>appointment</Emphasis> argument into the user's default calendar.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Emphasis>appointment</Emphasis></Term>
<ListItem>
<Para>Edit the appointment named by the pathname in the
<Emphasis>appointment</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Insert</Literal>&numsp;<Emphasis>appointment</Emphasis></Term>
<ListItem>
<Para>Insert the appointment named by the pathname in the
<Emphasis>appointment</Emphasis> argument into the user's default calendar.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
<Para>All
<Emphasis>appointment</Emphasis>s are text files including calendar entries defined in
<![ %CDE.C.CDE; [<Emphasis>dtcm_entry</Emphasis>4]]><![ %CDE.C.XO; [<XRef Linkend="XCSA.M4DEN.anch.1" Role="3">]]>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

55
cde/doc/C/guides/man/man5/dtclcact.sgm Normal file
View File

@@ -0,0 +1,55 @@
<!-- $XConsortium: dtclcact.sgm /main/5 1996/08/30 13:52: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.XCSA.MAN84.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN84.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtcalcaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtcalcaction</Literal></RefName>
<RefPurpose>&str-XZ; calculator actions
</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>Dtcalc
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Action Creation Services support the following
calculator actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtcalc</Literal></Term>
<ListItem>
<Para>Open a view of the desktop calculator tool.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

676
cde/doc/C/guides/man/man5/dtenvvar.sgm Normal file
View File

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

112
cde/doc/C/guides/man/man5/dtfilact.sgm Normal file
View File

@@ -0,0 +1,112 @@
<!-- $XConsortium: dtfilact.sgm /main/5 1996/08/30 13:53:24 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.XCSA.MAN86.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN86.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtfileaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtfileaction</Literal></RefName>
<RefPurpose>&str-XZ; file management actions
</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>Dtfile [<Emphasis>directory</Emphasis>]
DtfileHome
Open <Emphasis>directory</Emphasis>
Open <Symbol Role="Variable">file</Symbol>
Print <Emphasis>directory</Emphasis>
Print <Symbol Role="Variable">file</Symbol>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; File Management Services support the following
file management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtfile</Literal></Term>
<ListItem>
<Para>Prompt the user for the pathname of a directory
and open a folder view of the directory specified by the user.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtfile</Literal>&numsp;<Emphasis>directory</Emphasis></Term>
<ListItem>
<Para>Open a folder view of the directory named by the pathname in the
<Emphasis>directory</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>DtfileHome</Literal></Term>
<ListItem>
<Para>Open a folder view of the user's home directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Emphasis>directory</Emphasis></Term>
<ListItem>
<Para>Open a folder view of the directory named by the pathname in the
<Emphasis>directory</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open the file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
(The nature of the Open action is dependent on
the type of file.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Emphasis>directory</Emphasis></Term>
<ListItem>
<Para>Print a listing of the directory named by the pathname in the
<Emphasis>directory</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Print the file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
(The nature of the Print action is dependent on
the type of file.)
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

389
cde/doc/C/guides/man/man5/dtfilsys.sgm Normal file
View File

@@ -0,0 +1,389 @@
<!-- $XConsortium: dtfilsys.sgm /main/7 1996/09/08 20:01:04 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.MAN102.rsml.1">
<RefMeta>
<RefEntryTitle>dtfilsys</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtfilsys</Literal></RefName>
<RefPurpose>CDE file system; directory tree structure
</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.-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CDE file system is divided into three parts: the root system,
<Filename>/usr/dt</Filename>, the configuration directory,
<Filename>/etc/dt</Filename>, and the temporary directory,
<Filename>/var/dt.</Filename> The root system,
<Filename>/usr/dt</Filename>, is a read-only directory.
It contains all the files
that comprise the CDE.
The configuration directory,
<Filename>/etc/dt</Filename>, is the directory
CDE applications will search to locate configuration files that have
been modified by the system administrator.
Default versions of these
configuration files are typically located in
<Filename>/usr/dt</Filename>. The temporary directory,
<Filename>/var/dt</Filename>, contains temporary information or information that varies
in size and existence.
Below is a diagram of the directory tree structure for CDE.
</Para>
<InformalExample Remap="indent">
<ProgramListing> /etc/dt/appconfig/appmanager/&lt;Lang>
/help/&lt;Lang>
/icons/&lt;Lang>
/types/&lt;Lang>
/backdrops/&lt;Lang>
/config
/palettes/&lt;Lang>
/usr/dt/app-defaults/&lt;Lang>
/appconfig/appmanager/&lt;Lang>
/help/&lt;Lang>
/icons/&lt;Lang>
/types/&lt;Lang>
/bin
/config
/lib
/share/backdrops/&lt;Lang>
/include
/examples
/man
/palettes/&lt;Lang>
/var/dt/appconfig/appmanager
$HOME/.dt/appmanager
/help
/icons
/palettes
/sessions
/types
</ProgramListing>
</InformalExample>
<Para>The following guidelines apply to the contents of these directories:
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>/usr/dt</Filename></Term>
<ListItem>
<Para>This directory is for use by the CDE system.
Applications should never
create files in this directory although they may read and execute
them.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/app-defaults/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the
app-defaults files for the CDE clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/appmanager/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the actions
files used by the Application Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/help/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the CDE help
volumes and help files.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/icons/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the icons
used by the CDE clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/types/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the actions
and data types used by the CDE clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/bin</Filename></Term>
<ListItem>
<Para>This directory contains the CDE clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/config</Filename></Term>
<ListItem>
<Para>This directory contains default configuration files.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/lib</Filename></Term>
<ListItem>
<Para>This directory contains the shared libraries used by the CDE
clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share</Filename></Term>
<ListItem>
<Para>This directory contains CDE elements, typically ASCII files, that are
independent of the architecture.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share/backdrops/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the
backdrops used by the window manager workspaces and by the
Style Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share/examples</Filename></Term>
<ListItem>
<Para>This directory contains examples of CDE functionality.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share/include</Filename></Term>
<ListItem>
<Para>This directory is part of the developmewnt environment and includes
header files associated with CDE.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share/man</Filename></Term>
<ListItem>
<Para>This directory contains the man pages for the CDE clients.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/share/palettes/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains the localized versions of the palettes
used by the Style Manager to determine the color scheme.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt</Filename></Term>
<ListItem>
<Para>This directory is specified as the CDE configuration
directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig</Filename></Term>
<ListItem>
<Para>This directory is used to hold system-administrator defined
configuration files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/appmanager/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory is used to hold system-administrator defined
configuration files for the Application Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/help/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory is used to hold system-administrator defined
configuration files for the Help system.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/icons/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory is used to hold system-administrator defined
configuration files for icons.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/types/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory is used to hold system-administrator defined
configuration files for the action and filetype database.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/backdrops/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains backdrops provided by the system administrator.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/config</Filename></Term>
<ListItem>
<Para>This directory is to contain modified versions of the CDE
configuration files (installed in
<Filename>/usr/dt/config</Filename>).</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/palettes/&lt;Lang></Filename></Term>
<ListItem>
<Para>This directory contains palettes provided by the system administrator.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/var/dt</Filename></Term>
<ListItem>
<Para>This directory is used by CDE for some log files, temporary files,
and files that vary in size.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/var/dt/appconfig/appmanager</Filename></Term>
<ListItem>
<Para>This directory is created at login and is used by the
Application Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt</Filename></Term>
<ListItem>
<Para>This directory contains information specific to the user.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/appmanager</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-defined
configuration files for the Application Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/backdrops</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-customized backdrops for
the Style Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/help</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-defined
configuration files for the Help system.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/icons</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-defined
configuration files for icons.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/palettes</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-customized palettes for
the Style Manager.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/sessions</Filename></Term>
<ListItem>
<Para>This directory is used to store session information between CDE
sessions.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/tmp</Filename></Term>
<ListItem>
<Para>This directory is used to hold temporary information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>$HOME/.dt/types</Filename></Term>
<ListItem>
<Para>This directory is used to hold user-defined
configuration files for the action and filetypes database.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>The Minimum Runtime Environment</Title>
<Para>The minimum environment required for a system to support CDE consists
of the following files and directories:
<Filename>/usr/dt/app-defaults/C/
tpad
Dtksh
Dtterm
/usr/dt/appconfig/tttypes/
types.xdr
/usr/dt/bin/
dsdm
dtaction
dtappgather
dtappintegrate
dtexec
dtksh
dtpad
dtspcd
dtterm
suid_exec
rpc.ttdbserver
tt_type_comp
ttsession</Filename>
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtenvvar;
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

71
cde/doc/C/guides/man/man5/dthelact.sgm Normal file
View File

@@ -0,0 +1,71 @@
<!-- $XConsortium: dthelact.sgm /main/5 1996/08/30 13:53:50 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.XCSA.MAN87.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN87.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dthelpaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dthelpaction</Literal></RefName>
<RefPurpose>&str-XZ; help actions
</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>Dthelpview [<Emphasis>volume</Emphasis>]
Open <Emphasis>volume</Emphasis>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Help Services support the following help actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dthelpview</Literal></Term>
<ListItem>
<Para>Open a view of the top-level help index.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dthelpview</Literal>&numsp;<Emphasis>volume</Emphasis></Term>
<ListItem>
<Para>Open a view of the help volume named by the pathname in the
<Emphasis>volume</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Emphasis>volume</Emphasis></Term>
<ListItem>
<Para>Open a view of the help volume named by the pathname in the
<Emphasis>volume</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

72
cde/doc/C/guides/man/man5/dticoact.sgm Normal file
View File

@@ -0,0 +1,72 @@
<!-- $XConsortium: dticoact.sgm /main/5 1996/08/30 13:54: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.XCSA.MAN88.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN88.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dticonaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dticonaction</Literal></RefName>
<RefPurpose>&str-XZ; icon editing actions
</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>Dticon [<Symbol Role="Variable">icon</Symbol>]
Open <Symbol Role="Variable">icon</Symbol>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Icon Editing Services support the following
icon editing actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dticon</Literal></Term>
<ListItem>
<Para>Open an empty icon editor view.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dticon</Literal>&numsp;<Symbol Role="Variable">icon</Symbol></Term>
<ListItem>
<Para>Open an icon editor view of the bitmap or pixmap named by the pathname in the
<Symbol Role="Variable">icon</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Symbol Role="Variable">icon</Symbol></Term>
<ListItem>
<Para>Open an icon editor view of the bitmap or pixmap named by the pathname in the
<Symbol Role="Variable">icon</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

95
cde/doc/C/guides/man/man5/dtinfact.sgm Normal file
View File

@@ -0,0 +1,95 @@
<!-- $XConsortium: dtinfact.sgm /main/7 1996/08/31 14:47:58 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.dtinfoaction">]]>
<RefMeta>
<RefEntryTitle>
dtinfoaction
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtinfoaction</Literal></RefName>
<RefPurpose>&str-XZ; information management actions
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>
DtLoadInfoLib <symbol role="Variable">filename</symbol>
Open <symbol role="Variable">filename</symbol>
DtShowInfoAtLoc
DtPrintInfoAtLoc
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Information Management Services support the following
information management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol>DtLoadInfoLib</Symbol> <symbol role="Variable">filename</symbol></Term>
<ListItem>
<Para>Load the information library specified by
<symbol role="Variable">filename</symbol>, which can be either
a relative or absolute file path. If
<symbol role="Variable">filename</symbol> is not
specified, <command>dtinfo</command> displays the default
information library(s).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal> <symbol role="Variable">filename</symbol></Term>
<ListItem>
<Para>Load the information library specified by
<symbol role="Variable">filename</symbol>.
Remaps to <Symbol>DtLoadInfoLib</Symbol> <symbol role="Variable">filename</symbol>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol>DtShowInfoAtLoc</Symbol> <symbol role="Variable">filename</symbol> <symbol role="Variable">section</symbol></Term>
<ListItem>
<Para>Display the section or topic specified by <symbol role="Variable">section</symbol>
contained within the infolib specified by <symbol role="Variable">filename</symbol>.
<symbol role="Variable">filename</symbol> can be either a relative or absolute
file path. <symbol role="Variable">section</symbol> specifies the information
library section in generalized locator format.
<command>dtinfo</command> is started if it
is not already running. This corresponds to invoking <command>dtinfo</command>
with the <literal>-sect</literal> option from the command line.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol>DtPrintInfoAtLoc</Symbol></Term>
<ListItem>
<Para>Print one or more infolib sections from
the desktop. This action is invoked whenever a section or sections is
dragged from the book list window in <command>dtinfo</command> and
dropped on the printer icon on the front panel.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtActionInvoke;,
&cdeman.DtInfo.LoadInfoLib;,
&cdeman.DtInfo.PrintInfoAtLoc;,
<Function>DtInfo_ShowInfoAtLoc</Function> 4
</Para>
</RefSect1>
</RefEntry>

70
cde/doc/C/guides/man/man5/dtinfdlb.sgm Normal file
View File

@@ -0,0 +1,70 @@
<!-- $XConsortium: dtinfdlb.sgm /main/5 1996/08/30 13:54:25 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.DtMmdbInfoLibInfo">]]>
<RefMeta>
<RefEntryTitle>
DtMmdbInfoLibInfo
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">DtMmdbInfoLibInfo</StructName>
</RefName>
<RefPurpose><command>dtinfo</command> infolib structure
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <StructName Role="typedef">DtMmdbInfoLibInfo</StructName>
structure contains information about a <command>dtinfo</command>
information library (infolib).
</para>
<para>The <StructName Role="typedef">DtMmdbInfoLibInfo</StructName>
structure is defined as follows:
</para>
<literallayout>
#include &lt;DtInfo/DtMmdb.h>
typedef struct _DtMmdbInfoLibInfo {
const char* path;
const char* name;
unsigned int num_bookcases;
} DtMmdbInfoLibInfo;
</literallayout>
<para>The <StructName Role="typedef">DtMmdbInfoLibInfo</StructName>
members have the following meanings:
</para>
<variablelist>
<varlistentry><term><symbol role="Variable">path</symbol></term>
<listitem>
<para>A pointer to the pathname for the infolib.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">name</symbol></term>
<listitem>
<para>A pointer to the name of the infolib.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">num_books</symbol></term>
<listitem>
<para>The number of bookcases in the infolib.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtInfoLib;,
&cdeman.dtinfogen;
</Para>
</RefSect1>
</RefEntry>

46
cde/doc/C/guides/man/man5/dtinfoaf.sgm Normal file
View File

@@ -0,0 +1,46 @@
<!-- $XConsortium: dtinfoaf.sgm /main/6 1996/08/30 13:54:38 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.dtinfo.af">]]>
<RefMeta>
<RefEntryTitle>
dtinfo.af
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><filename>dtinfo.af</filename></RefName>
<RefPurpose><command>dtinfo</command> architectural forms
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para><filename>dtinfo.af</filename> provides entity definitions for the
<command>dtinfo</command> architectural forms. While these are not
required, using them minimizes updating your DTDs as features are added
to the Dtinfo Toolkit.
</para>
<para>You can also find an ASCII file of the
<filename>dtinfo.af</filename> in
<filename>/usr/dt/infolib/%L/SGML/dtinfo.af</filename>.
</para>
<para>For information on applying <command>dtinfo</command> architectural
forms to your DTDs, see "Modifying Your Existing DTD" in <emphasis>CDE:
Information Manager Author's and Programmer's Guide</emphasis>.
</para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.dtinfogen;,
&cdeman.dtinfoBook.dtd;,
&cdeman.dtinfoStyle.dtd;,
&cdeman.dtinfoTOC.dtd;
</Para>
</RefSect1>
</RefEntry>

62
cde/doc/C/guides/man/man5/dtinfobc.sgm Normal file
View File

@@ -0,0 +1,62 @@
<!-- $XConsortium: dtinfobc.sgm /main/6 1996/09/08 20:01: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.DtMmdbBookCase">]]>
<RefMeta>
<RefEntryTitle>
DtMmdbBookCase
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">DtMmdbBookCase</StructName>
</RefName>
<RefPurpose><command>dtinfo</command> bookcase structure
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <StructName Role="typedef">DtMmdbBookCaseInfo</StructName>
structure contains information about a <command>dtinfo</command> bookcase.
</para>
<para>The <StructName Role="typedef">DtMmdbBookCase</StructName>
structure is defined as follows:
</para>
<literallayout>
#include &lt;DtInfo/DtMmdb.h>
typedef struct _DtMmdbBookCaseInfo {
const char* name;
unsigned int num_books;
} DtMmdbBookCaseInfo;
</literallayout>
<para>The <StructName Role="typedef">DtMmdbBookCase</StructName>
members have the following meanings:
</para>
<variablelist>
<varlistentry><term><symbol role="Variable">name</symbol></term>
<listitem>
<para>A pointer to the name of the infolib that contains the bookcase.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">num_books</symbol></term>
<listitem>
<para>The number of books in the bookcase.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtInfoLib;,
&cdeman.dtinfogen;
</Para>
</RefSect1>
</RefEntry>

130
cde/doc/C/guides/man/man5/dtinfobk.sgm Normal file
View File

@@ -0,0 +1,130 @@
<!-- $XConsortium: dtinfobk.sgm /main/5 1996/08/30 13:55:04 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.dtinfoBook.dtd">]]>
<RefMeta>
<RefEntryTitle>
dtinfoBook.dtd
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><filename>dtinfoBook.dtd</filename></RefName>
<RefPurpose><command>dtinfo</command> bookcase document type definition
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>This is the document type definition for bookcases under
<command>dtinfo</command>. You can also find an ASCII file of the
<filename>dtinfoBook.dtd</filename> in
<filename>/usr/dt/infolib/%L/SGML/dtinfoBook.dtd</filename>.
</para>
<para>The bookcase DTD is defined as follows:
</para>
<LITERALLAYOUT>&lt;!--
Formal Public Identifier (FPI):
-//X Consortium//DTD DTINFO Bookcase Description//EN
--&gt;
&lt;!-- DTINFO Architectural Forms --&gt;
&lt;!ENTITY % OLAF PUBLIC
&ldquo;-//X Consortium//ENTITIES DTINFO Architectural Forms//EN&rdquo;
&gt;
%OLAF;
&lt;!--
Describe the BookCase contents.
</LITERALLAYOUT>
<LITERALLAYOUT> --&gt;
&lt;!ELEMENT BookCase - - ( BookcaseName, BookcaseDesc, StyleSheet+, Book+) &gt;
&lt;!ATTLIST BookCase
StyleSheet IDREF &num;REQUIRED
%DTINFO.Bookcase;
%DTINFO.Style; &ldquo;attr( StyleSheet )&rdquo;
&gt;
&lt;!ELEMENT BookcaseName - - ( &num;PCDATA) &gt;
&lt;!ATTLIST BookcaseName
%DTINFO.BookcaseName;
&gt;
&lt;!ELEMENT BookcaseDesc - - ( &num;PCDATA) &gt;
&lt;!ATTLIST BookcaseDesc
%DTINFO.BookcaseDesc;
&gt;
&lt;!ELEMENT Book - - ( Title, ShortTitle?, Tab*, TOCFile, File+) &gt;
&lt;!ATTLIST Book
StyleSheet IDREF &num;IMPLIED
%DTINFO.Book;
%DTINFO.Style; &ldquo;attr( StyleSheet )&rdquo;
&gt;
&lt;!ELEMENT Title - - ( &num;PCDATA) &gt;
&lt;!ATTLIST Title
%DTINFO.BookTitle;
&lt;!ELEMENT ShortTitle - - ( &num;PCDATA) &gt;
&lt;!ATTLIST ShortTitle
%DTINFO.BookShortTitle;
&gt;
&lt;!ELEMENT Access - O EMPTY &gt;
&lt;!ATTLIST Access
Feature CDATA &num;REQUIRED
VenCode CDATA &num;REQUIRED
Version CDATA &num;REQUIRED
Grouping CDATA &num;REQUIRED
DefaultSection CDATA &num;REQUIRED
DemoTerms CDATA &num;IMPLIED
%DTINFO.BookAccess;
&gt;
&lt;!ELEMENT Tab - - ( &num;PCDATA) &gt;
&lt;!ATTLIST Tab
TabLoc CDATA &num;REQUIRED
%DTINFO.BookTab;
%DTINFO.IDREF; &ldquo;attr( TabLoc )&rdquo;
&gt;
&lt;!--
Any section within the file can override the style
sheet via a DTD modification.
--&gt;
&lt;!ELEMENT TOCFile - - ( &num;PCDATA) &gt;
&lt;!ATTLIST TOCFile
&gt;
&lt;!ELEMENT File - - ( &num;PCDATA) &gt;
&lt;!ATTLIST File
&gt;
&lt;!-- Style Sheet DTD --&gt;
&lt;!ENTITY % StyleSheet.dtd PUBLIC
&ldquo;-//X Consortium//DTD DTINFO Style Sheet//EN&rdquo;
&gt;
%StyleSheet.dtd;</LITERALLAYOUT>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.DtInfoLib;,
&cdeman.dtinfogen;,
&cdeman.dtinfoStyle.dtd;,
&cdeman.dtinfoTOC.dtd;,
</Para>
</RefSect1>
</RefEntry>

133
cde/doc/C/guides/man/man5/dtinfost.sgm Normal file
View File

@@ -0,0 +1,133 @@
<!-- $XConsortium: dtinfost.sgm /main/6 1996/09/08 20:01:21 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.dtinfoStyle.dtd">]]>
<RefMeta>
<RefEntryTitle>
dtinfoStyle.dtd
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><filename>dtinfoStyle.dtd</filename></RefName>
<RefPurpose><command>dtinfo</command> style
sheet document type definition
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><filename>dtinfoStyle.dtd</filename> describes the SGML features
available for specifying how a document should be rendered. Style sheets
associate the elements in a given document hierarchy with on-line or
print formatting characteristics, and are part of the DtInfo Toolkit.
</para>
<para>With <command>dtinfo</command>, you use a single style sheet to specify
both print and online rendering of the elements in your DTD.
The print and online feature sets match in function, description,
and specification, with just four exceptions for print-specific features
</para>
<refsect2>
<title>Basic Style Sheet Format</title>
<para>The basic style sheet format first defines autonumbers. Then, for each
element (<SYSTEMITEM>Path</SYSTEMITEM>) the style sheet defines its
feature set. For information see, "Understanding Dtinfo Style Sheets"
and "Creating a Style Sheet" in <emphasis>CDE: Information Manager
Author's and Programmer's Guide</emphasis>.
</para>
<para>You can also find an ASCII file of the
<filename>dtinfoStyle.dtd</filename> in
<filename>/usr/dt/infolib/%L/SGML/dtinfoStyle.dtd</filename>.
</para>
</refsect2>
<refsect2>
<title>AutoNumber</title>
<para>To use system-generated number tokens in element formatting, first
create an <SYSTEMITEM>AutoNumber</SYSTEMITEM> specification for each
token stream. (Note that these tokens can only be used with the Prefix,
Suffix, Header and Footer features.)
</para>
<para>A simple example is:
</para>
<LITERALLAYOUT>
&lt;AutoNumber
id=chapnum
reset=&rdquo;Book Part&rdquo;
counter=chapter&gt;
</LITERALLAYOUT>
<PARA>A more complex example is:
</PARA>
<LITERALLAYOUT>&lt;AutoNumber
id=fignum
type=UCroman
initial=&rdquo;I&rdquo;
delta=l
counter=&rdquo;FIG TABLE&rdquo;
reset=chap&gt;
&lt;path&gt;NUMITEM&lt;/&gt;
&lt;margin top=4pt bottom=4pt&gt;
&lt;prefix&gt;&lt;auto id=NumList&gt;&lt;/prefix&gt;
</LITERALLAYOUT>
<PARA>where:</PARA>
<VARIABLELIST>
<VARLISTENTRY><TERM><SYSTEMITEM>type</SYSTEMITEM></TERM>
<LISTITEM><PARA>The kind of counter values:Arabic, UCalpha, LCalpha, UCroman, LCroman.
The default value is Arabic.
</PARA></LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY><TERM><SYSTEMITEM>id</SYSTEMITEM></TERM>
<LISTITEM><PARA>The unique name of this token. You can refer
to this name, for example, in a
<SYSTEMITEM>Prefix</SYSTEMITEM>. Required.
</PARA></LISTITEM>
</VARLISTENTRY><VARLISTENTRY><TERM><SYSTEMITEM>initial</SYSTEMITEM></TERM>
<LISTITEM><PARA>The initial value for this token, which must be consistent with the Type.
The default is 1.
</PARA></LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY><TERM><SYSTEMITEM>delta</SYSTEMITEM></TERM>
<LISTITEM><PARA>The value by which the system increments or decrements the token.
The default is to increment by 1.
</PARA></LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY><TERM><SYSTEMITEM>counter</SYSTEMITEM></TERM>
<LISTITEM><PARA>The element(s) that cause this token to use the Delta to change
values. Required.
</PARA></LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY><TERM><SYSTEMITEM>reset</SYSTEMITEM></TERM>
<LISTITEM><PARA>The element(s) that cause this token to reset to its initial value.
Required.
</PARA></LISTITEM>
</VARLISTENTRY>
</VARIABLELIST>
</REFSECT2>
</REFSECT1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><emphasis>CDE: Information Manager
Author's and Programmer's Guide</emphasis>,
&cdeman.dtinfo;,
&cdeman.dtinfogen;,
&cdeman.dtinfoBook.dtd;,
&cdeman.dtinfoTOC.dtd;
</Para>
</RefSect1>
</RefEntry>

176
cde/doc/C/guides/man/man5/dtinfotc.sgm Normal file
View File

@@ -0,0 +1,176 @@
<!-- $XConsortium: dtinfotc.sgm /main/5 1996/08/30 13:55:31 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.dtinfoTOC.dtd">]]>
<RefMeta>
<RefEntryTitle>
dtinfoTOC.dtd
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><filename>dtinfoTOC.dtd</filename></RefName>
<RefPurpose><command>dtinfo</command>
table of contents document type
definition
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>This is the document type definition for tables of contents under
<command>dtinfo</command>. You can also find an ASCII file of the
<filename>dtinfoTOC.dtd</filename> in
<filename>/usr/dt/infolib/%L/SGML/dtinfoTOC.dtd</filename>.
</para>
<para>The table of contents DTD is defined as follows:
</para>
<LITERALLAYOUT>&lt;!ENTITY % commonatts &ldquo;
Lang CDATA &num;IMPLIED
Remap CDATA &num;IMPLIED
Role CDATA &num;IMPLIED
XRefLabel CDATA &num;IMPLIED
&ldquo; &gt;
&lt;!--
Formal Public Identifier (FPI):
-//X Consortium//DTD DTINFO Table of Contents//EN
--&gt;
&lt;!-- DTINFO Architectural Forms --&gt;
&lt;!ENTITY % OLAF PUBLIC
&ldquo;-//X Consortium//ENTITIES DTINFO Architectural Forms//EN&rdquo;
&gt;
%OLAF;
&lt;!ENTITY % userphrase.gp &ldquo;&ldquo; &gt;
&lt;!ENTITY % inlinechar.gp &ldquo;&num;PCDATA %userphrase.gp;&rdquo; &gt;
&lt;!ELEMENT TOC - - ( Title, TitleAbbrev?, TOCfront*, (TOCpart+ | TOCchap+), TOCback*) &gt;
&lt;!ATTLIST TOC
Id ID &num;REQUIRED
%DTINFO.TOC;
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
&gt;
&lt;!ELEMENT Title - - ( (%inlinechar.gp;)+) &gt;
&lt;!ATTLIST Title
Id ID &num;IMPLIED
%DTINFO.Title; &ldquo;&num;CONTENT&rdquo;
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.Scope.Title;
&gt;
&lt;!ELEMENT TitleAbbrev - - ( (%inlinechar.gp;)+) &gt;
&lt;!ATTLIST TitleAbbrev
Id ID &num;IMPLIED
%DTINFO.ShortTitle; &ldquo;&num;CONTENT&rdquo;
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
&gt;
&lt;!ELEMENT TOCfront - - ( (%inlinechar.gp;)+) &gt;
&lt;!ATTLIST TOCfront
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
&gt;
&lt;!ELEMENT TOCentry - - ( (%inlinechar.gp;)+) &gt;
&lt;!ATTLIST TOCentry
Id ID &num;IMPLIED
Linkend CDATA &num;REQUIRED
Pagenum CDATA &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.IDREF; &ldquo;attr( Linkend )&rdquo;
&gt;
&lt;!ELEMENT TOCpart - - ( TOCentry+, TOCchap*) &gt;
&lt;!ATTLIST TOCpart
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOCchap - - ( TOCentry+, TOClevel1*) &gt;
&lt;!ATTLIST TOCchap
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOClevel1 - - ( TOCentry+, TOClevel2*) &gt;
&lt;!ATTLIST TOClevel1
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOClevel2 - - ( TOCentry+, TOClevel3*) &gt;
&lt;!ATTLIST TOClevel2
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOClevel3 - - ( TOCentry+, TOClevel4*) &gt;
&lt;!ATTLIST TOClevel3
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOClevel4 - - ( TOCentry+, TOClevel5*) &gt;
&lt;!ATTLIST TOClevel4
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOClevel5 - - ( TOCentry+) &gt;
&lt;!ATTLIST TOClevel5
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
%DTINFO.TOCEntry;
&gt;
&lt;!ELEMENT TOCback - - ( (%inlinechar.gp;)+) &gt;
&lt;!ATTLIST TOCback
Id ID &num;IMPLIED
%DTINFO.ID; &ldquo;attr( Id )&rdquo;
&gt;
</LITERALLAYOUT>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtinfo;,
&cdeman.dtinfogen;,
&cdeman.dtinfoBook.dtd;,
&cdeman.dtinfoStyle.dtd;
</Para>
</RefSect1>
</RefEntry>

97
cde/doc/C/guides/man/man5/dtmaiact.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: dtmaiact.sgm /main/5 1996/08/30 13:55:42 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.XCSA.MAN89.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN89.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtmailaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtmailaction</Literal></RefName>
<RefPurpose>&str-XZ; mail actions
</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>Compose [<Symbol Role="Variable">file</Symbol> ...]
Dtmail [<Symbol Role="Variable">file</Symbol>]
Open <Symbol Role="Variable">file</Symbol>
Print <Symbol Role="Variable">file</Symbol>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Mail Services support the following mail actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Compose</Literal></Term>
<ListItem>
<Para>Open an empty mail composition view for message construction.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Compose</Literal>&numsp;<Symbol Role="Variable">file</Symbol>&numsp;.&thinsp;.&thinsp;.</Term>
<ListItem>
<Para>Open a mail composition view with attachments named
by the pathnames in the
<Symbol Role="Variable">file</Symbol> arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtmail</Literal></Term>
<ListItem>
<Para>Open a view of the user's inbox for electronic mail.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtmail</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open a view of the mail file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open a view of the mail file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Print the mail file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

81
cde/doc/C/guides/man/man5/dtmanact.sgm Normal file
View File

@@ -0,0 +1,81 @@
<!-- $XConsortium: dtmanact.sgm /main/5 1996/08/30 13:55:55 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.XCSA.MAN90.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN90.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtmanaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtmanaction</Literal></RefName>
<RefPurpose>&str-XZ; manual page actions
</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>Dtmanpageview [<Emphasis>page</Emphasis>]
Open <Emphasis>page</Emphasis>
Print <Emphasis>page</Emphasis>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Help Services support the following manual page actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtmanpageview</Literal></Term>
<ListItem>
<Para>Prompt the user for a manual page and open a view of the manual page
specified by the user.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtmanpageview</Literal>&numsp;<Emphasis>page</Emphasis></Term>
<ListItem>
<Para>Open a view of the manual page named by the pathname in the
<Emphasis>page</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Emphasis>page</Emphasis></Term>
<ListItem>
<Para>Open a view of the manual page named by the pathname in the
<Emphasis>page</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Emphasis>page</Emphasis></Term>
<ListItem>
<Para>Print the manual page named by the pathname in the
<Emphasis>page</Emphasis> argument.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

87
cde/doc/C/guides/man/man5/dtpriact.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: dtpriact.sgm /main/6 1996/08/31 14:48: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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN91.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN91.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtprintinfoaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtprintinfoaction</Literal></RefName>
<RefPurpose>&str-XZ; print job actions
</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>Dtprintinfo [<Emphasis>printer</Emphasis>]
DtPrintManager
Print <Symbol Role="Variable">file</Symbol>
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Print Job Services support the following
action for viewing printers and print jobs:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtprintinfo</Literal></Term>
<ListItem>
<Para>Display the default printer and its print jobs.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtprintinfo</Literal>&numsp;<Emphasis>printer</Emphasis></Term>
<ListItem>
<Para>Display the printer named by the printer in the
<Emphasis>printer</Emphasis> argument and its print jobs.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol>DtPrintManager</Symbol></Term>
<ListItem>
<Para>Display all configured printers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol></Term>
<ListItem>
<Para>Display the default printer and its print jobs.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Submit the file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument to the default printer.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

399
cde/doc/C/guides/man/man5/dtsearch.sgm Normal file
View File

@@ -0,0 +1,399 @@
<!-- $XConsortium: dtsearch.sgm /main/8 1996/10/29 16:04:20 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.SEARCH.DtSearch">]]>
<RefMeta>
<RefEntryTitle>DtSearch</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>DtSearch</RefName>
<RefPurpose>
Introduces the DtSearch text search and retrieval system
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>DtSearch is a general purpose text search and retrieval system that
serves as the text search engine for the DtInfo browser in the Common
Desktop Environment (CDE). DtSearch utilizes a full text inverted index
of natural language words and stems. Both queries and documents have
been internationalized for CDE single- and multi-byte languages, with
provision for the definition of custom languages. Queries are simple
text strings that can optionally include full boolean specifications
with a simple intuitive syntax. Results of searches can be ranked
statistically. Document retrievals can include information for
highlighting query words in retrieved documents.
</Para>
<Para>DtSearch consists of two major functional areas.
The first is a set of offline build tools that:
</Para>
<itemizedlist>
<listitem>
<Para>Create searchable databases.
</Para>
</listitem>
<listitem>
<Para>Index the user's text files and load the resultant search
information into the databases.
</Para>
</listitem>
<listitem>
<Para>Maintain the databases.
</Para>
</listitem>
</itemizedlist>
<Para>The second functional area is an online search API. It provides a simple
interface to the search engine to facilitate user-written search and
retrieval programs. The API consists of a set of functions compiled into
the library <filename>libDtSearch</filename>, with function prototypes,
constant definitions, and data structures defined in
<filename>Search.h</filename>. DtSearch includes a sample browser source
program, <filename>dtsrtest.c</filename>, to demonstrate API usage.
</Para>
<Para>Information and error messages in both functional areas, including those
appended to the online API MessageList, are generated from a single
DtSearch Message catalog, <filename>dtsearch.cat</filename>. The source
for this catalog is <filename>dtsearch.msg</filename>.
</Para>
<Para>Each DtSearch database is associated with a single full text inverted
index. In addition, each database can be partitioned into logical
subsets of documents called "keytypes" by a naming convention of the
database keys. The search engine can open multiple databases and users
can specify any combination of databases and keytypes for each query,
thus providing a two tier search capability. Users can further qualify
searches by restricting the search return list by date ranges and
maximum number of documents returned.
</Para>
<Para>DtSearch is written in ANSI Standard and POSIX compliant C. The DtSearch
online search API is not reentrant (not "thread-safe") and must
therefore be directly linked into the user-written search program. The
DtSearch API will increase the size of a browser search program from
100K to 200K bytes depending on which functions are called.
</Para>
</RefSect1>
<RefSect1>
<Title>GENERAL SPECIFICATIONS AND CONVENTIONS</Title>
<RefSect2>
<Title>Database Names</Title>
<para>Databases consist of a set of binary and ASCII files whose names are the
1- to 8-character ASCII database name specified to the
<command>dtsrcreate</command> command, a period (.), and a 1- to
3-character ASCII file name suffix. Executing
<command>dtsrcreate</command> will create and initialize these files.
After creation, databases are always identified by the 1- to 8-character
name string used in <command>dtsrcreate</command>. The database names
<literal>dtsearch</literal> and <literal>austext</literal> are reserved
and may not be specified.
</Para>
</RefSect2>
<RefSect2>
<Title>DtSearch Languages</Title>
<para>Each database is associated with a single natural language. Unlike
conventional locales, a DtSearch language includes code set presumptions
and, most importantly, linguistic parsing and stemming rules to identify
indexable terms in a text stream. A DtSearch language is specified when
a database is created. Developers can also define custom languages with
special code sets and linguistic rules. See "Language Parsing and
Stemming" in this man page below for details.
</Para>
</RefSect2>
<RefSect2>
<Title>Database Types</Title>
<para>The API can be used simply as a search engine, referring to documents
only through the inverted indexes. Alternatively, a database can be
configured to store actual document text in compressed format in a
repository efficiently accessible to the engine. The configuration
options that indicate these alternatives are referred to as database
types and are specified to <command>dtsrcreate</command> at database
creation time.
</Para>
</RefSect2>
<RefSect2>
<Title>Abstracts</Title>
<para>A field called the "abstract" is included in the fzk file for each
document loaded into a database, and is included on the Results list for
each document in a successful search. When documents are not stored in a
repository, the abstract typically specifies a file name, URL, or other
reference useful to the browser. It can also include summary information
viewable by users to help them select documents for retrieval and
display.
</Para>
</RefSect2>
<RefSect2>
<Title>Offline Build Tools</Title>
<para><command>dtsrcreate</command> creates and initializes new databases or
reinitializes preexisting databases. Textual data is loaded into
databases by the execution of two programs. <command>dtsrload</command>
creates a database object record for each text document, and
<command>dtsrindex</command> creates the full text inverted index of
words and stems for each object record. Based on unique database keys
for each object, <command>dtsrload</command> and
<command>dtsrindex</command> can also serve as update programs for
preexisting databases.
</Para>
<para>The input to the load and index programs is a canonical text file with a
<Filename>.fzk</Filename> file name suffix. The format of fzk files is
sufficiently simple that they can be generated manually. In addition,
DtSearch includes a utility program, <command>dtsrhan</command>, which
can generate a correctly formatted fzk file for some kinds of text
documents.
</Para>
<para>Several other utilites provided in the distribution package are suitable
for extracting summary database information, including
<command>dtsrdbrec</command> and <command>dtsrkdump</command>.
</Para>
</RefSect2>
<RefSect2>
<Title>Argument Conventions</Title>
<para>Optional command line arguments are specified with a dash (&minus;) and
typically a single character argument identifier. Some required
arguments also use the dash convention. Unless specifically indicated
otherwise, dash arguments may be specified in any order. Where values
are used with dash arguments, they must be directly appended to the
argument without white space.
</Para>
<para>Optional arguments precede required arguments. Non-dash required
arguments must usually be specified in the order indicated by the usage
statement.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>LANGUAGE PARSING AND STEMMING</Title>
<RefSect2>
<Title>Parsing and Stemming</Title>
<para>Word parsing is fundamental to DtSearch operations at both index time
and query time. Linguistic parsing algorithms filter incoming text
strings into sequences of word tokens for each natural language.
Depending on the language, word tokens may also be processed into stem
tokens. At index time each linguistic token, or term, in a document is
stored in the inverted index. At search time queries are parsed for
linguistic terms and used to access the documents that contain them.
</Para>
<para>Each database is assigned its own DtSearch language identified by a
language number at database creation time. A language number determines
the parsing and stemming algorithms to be applied to the database's text
and queries. Internal DtSearch algorithms are supplied for supported
languages including several European languages and Japanese. In addition
a user exit mechanism permits developers to provide their own custom
language algorithms for a database.
</Para>
</RefSect2>
<RefSect2>
<Title>Language Files</Title>
<para>Language algorithms often use various word lists. Typically, these lists
are stored in language files for easy maintenance, with the type of list
identified by the file name extension. Language files are opened and
read into internal tables when the offline programs initialize or when
the <function>DtSearchInit</function> online API function is called. Some
language files are required and initialization will return fatal errors
if they are missing. Some language files are optional and associated
algorithms will be silently bypassed if they are missing. Files for
supported languages may be edited to provide database specific
enhancements. At open time, database specific files supercede generic
language files.
</Para>
</RefSect2>
<RefSect2>
<Title>General European Parsing Rules</Title>
<para>The currently supported European languages are
</Para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="0.52in">
<colspec align="left" colwidth="3.10in">
<tbody>
<row>
<entry><para>0</para></entry>
<entry><para>English, ASCII character set</para></entry>
</row>
<row>
<entry><para>1</para></entry>
<entry><para>English, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry><para>2</para></entry>
<entry><para>Spanish, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry><para>3</para></entry>
<entry><para>French, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry><para>4</para></entry>
<entry><para>Italian, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry><para>5</para></entry>
<entry><para>German, ISO Latin-1 character set</para></entry>
</row>
</tbody></tgroup></informaltable>
<para>If not otherwise specified, <command>dtscreate</command> will initialize
databases with language number 0. Note that all supported European
languages use a single-byte encoding method, with the ASCII code set as
a proper subset.
</Para>
<para>Parsed text, including both queries and indexed text in documents,
is case insensitive in supported European languages.
</Para>
<para>In supported European languages parsing is accomplished with the Teskey
algorithm, which partitions a character set into characters that are
always parts of words (concordable), characters that are never parts of
words (nonconcordable), and characters that may be parts of words
depending on context (optionally concordable). Typically, alphanumeric
characters are concordable. Whitespace and most punctuation is
nonconcordable. Slashes are examples of characters that may or may not
separate words depending on context. The essence of the parsing
algorithm is "optionally concordable characters preceding concordable
characters are concordable; otherwise, they are nonconcordable". For
example, UNIX directory names of the form
<filename>/usr/local/bin</filename> would be considered just one word,
but slashes in isolation would be discarded as nonconcordable.
</Para>
<para>The parsing algorithm does a table lookup to determine the
concordability of characters. The tables are arrays of the characters
for each code page supported by the algorithm. Currently 7-bit ASCII and
ISO Latin-1 are supported.
</Para>
</RefSect2>
<RefSect2>
<Title>Words Not Indexed</Title>
<para>Several additional parsing rules are applied to prevent indexing
meaningless terms. These terms include common prepositions, indefinite
articles, and nonlinguistic text strings such as formatting tags,
sequences of hexadecimal dump characters, list identifiers, etc.
</Para>
<para>Tokens whose lengths are less than a minimum word size or greater than a
maximum word size are discarded. The default minimum and maximum word
sizes can be overridden in <command>dtsrcreate</command>.
</Para>
<para>Similarly words found in the "stop list" file for the database are
discarded. Stop lists are external, editable language files. Each
supported European language is provided with a default stop list.
</Para>
<para>Words found in an "include list" file are forcibly indexed even if they
would otherwise be discarded. Include list database files are optional;
no defaults are provided.
</Para>
</RefSect2>
<RefSect2>
<Title>Stemming</Title>
<para>When specified for a language, individual parsed words will be
"conflated" or mapped into their "stem" form, a new word that represents
the etymological root of the original word. A default null stemming
algorithm is used for languages that are not otherwise provided with a
supported stemmer. The null stemmer returns the original word as its own
stem. Both words and stems are stored in the inverted index. API
searches can be specified for either words or stems, but the two search
methods are distinguished only when real stems have been stored in the
inverted index.
</Para>
<para>In the supported European languages stemming can be accomplished
heuristically or by dictionary lookup. The heuristic algorithms
typically remove affixes in a language-dependent way. Affix lists are
usually stored in language files. Currently stemming is supported
for English languages 0 and 1, Spanish language 2, French language 3,
Italian language 4, and German language 5.
</Para>
</RefSect2>
<RefSect2>
<Title>Japanese</Title>
<para>Two Japanese DtSearch languages (numbers 6 and 7) are supported. Both
use the same packed, Extended UNIX Code (EUC) character set. The two
languages differ only in the technique used to parse compound kanji
words. All validly encoded text for supported Japanese languages
incorporates ASCII encoding as a proper, single-byte subset. The
supported Japanese languages use the null stemmer.
</Para>
</RefSect2>
<RefSect2>
<Title>Kanji Compounds</Title>
<para>Individual kanji characters are parsed as single words. In addition, for
language number 6 all possible kanji substrings (pairs, triplets, etc.)
found in any contiguous string of kanjis will be parsed as compound
kanji words, up to a maximum word size of 6 kanji characters. For
language number 7, only kanji substrings listed in the
<filename>jpn.knj</filename> language file may be treated as compound
kanji words. At offline index time all possible individual kanjis and
kanji compounds for a language are stored in the inverted index. At
online search time kanji substrings in the query are treated as single
query terms and are not compounded further.
</Para>
</RefSect2>
<RefSect2>
<Title>Japanese Code Sets</Title>
<para>The supported packed EUC character set consists of four separate
multibyte Code Sets. Code Set 0 can be either 7-bit ASCII or 7-bit
JIS-Roman. The first and only byte of a character in Code Set 0 is less
than 0x80. Substrings of Code Set 0 in supported Japanese text are
parsed into individual words with the European language parser described
above. Minimum and maximum word sizes, stop lists, and include lists
will be used as in European languages if provided with a Japanese
database.
</Para>
<para>Code Set 1 is JIS X 0208-1990. The two-byte characters in Code Set 1
always begin with a byte greater than 0xA0 and less than 0xFF. Symbols
and line drawing elements are not indexed. Hirigana strings are
discarded as equivalent to stop list words. Contiguous substrings of
katakana, Roman, Greek, or cyrillic are parsed as single words.
Individual kanji characters are treated as single words with additional
kanji compounding depending on language number, as described above.
Characters from unassigned kuten rows are treated as user-defined kanji.
</Para>
<para>Code Set 2 is halfwidth katakana. The two-byte characters in Code Set 2
always begin with the unique byte 0x8E. Contiguous strings are parsed as
single words.
</Para>
<para>Code Set 3 is JIS X 0212-1990. The three-byte characters in Code Set 3
always begin with the unique byte 0x8F. Parsing is similar to Code Set
1: discard symbols, etc., contiguous strings of related foreign
characters equal words, and individual kanjis and unassigned characters
equal single words, with additional kanji compounding depending on
language. Kuten row 5 is treated as katakana; undefined rows are treated
as kanji.
</Para>
</RefSect2>
<RefSect2>
<Title>Custom Languages</Title>
<para>All language dependent data structures and functions are referenced by
fields in the main internal DtSearch structure for databases (DBLK). The
same structure is used for offline build programs as well as online API
search functions. Language processing is initialized database by
database by an internal language loader function which stores values in
DBLK fields. A database whose language number is not supported is
presumed to be associated with a custom language. A special function,
<Function>load_custom_language</Function>, is called to initialize
language fields for custom languages. The default
<Function>load_custom_language</Function> merely returns an error code.
However, developers can link in their own
<Function>load_custom_language</Function> function, which will be called
to initialize the DBLK fields needed to parse and stem one or more
custom languages. Values required for the language fields of a DBLK are
specified in &cdeman.DtSrAPI;.
</Para>
</refsect2>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsrcreate;,
&cdeman.dtsrdbrec;,
&cdeman.dtsrhan;,
&cdeman.dtsrindex;,
&cdeman.dtsrload;,
&cdeman.dtsrkdump;,
&cdeman.huffcode;,
&cdeman.DtSrAPI;,
&cdeman.dtsrfzkfiles;,
&cdeman.dtsrocffile;,
&cdeman.dtsrhanfile;,
&cdeman.dtsrlangfiles;,
&cdeman.dtsrdbfiles;
</Para>
</RefSect1>
</RefEntry>

71
cde/doc/C/guides/man/man5/dtsesact.sgm Normal file
View File

@@ -0,0 +1,71 @@
<!-- $XConsortium: dtsesact.sgm /main/5 1996/08/30 13:56: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.XCSA.MAN92.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN92.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtsessionaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtsessionaction</Literal></RefName>
<RefPurpose>&str-XZ; session management actions
</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>ExitSession
LockDisplay
ReloadResources
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Session Management Services support the following
session management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>ExitSession</Literal></Term>
<ListItem>
<Para>Exit the user's current session.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>LockDisplay</Literal></Term>
<ListItem>
<Para>Lock the user's display.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>ReloadResources</Literal></Term>
<ListItem>
<Para>Reload the user's resources.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

55
cde/doc/C/guides/man/man5/dtstyact.sgm Normal file
View File

@@ -0,0 +1,55 @@
<!-- $XConsortium: dtstyact.sgm /main/5 1996/08/30 13:56: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.XCSA.MAN93.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN93.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtstyleaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtstyleaction</Literal></RefName>
<RefPurpose>&str-XZ; style management actions
</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>Dtstyle
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Style Management Services support the following
style management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtstyle</Literal></Term>
<ListItem>
<Para>Open a view of the desktop style manager.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

63
cde/doc/C/guides/man/man5/dtteract.sgm Normal file
View File

@@ -0,0 +1,63 @@
<!-- $XConsortium: dtteract.sgm /main/5 1996/08/30 13:56: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.XCSA.MAN94.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN94.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dttermaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dttermaction</Literal></RefName>
<RefPurpose>&str-XZ; terminal emulation actions
</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>Dtterm
Terminal
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Terminal Emulation Services support the following
terminal emulation actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtterm</Literal></Term>
<ListItem>
<Para>Open a view of the desktop terminal emulator.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Terminal</Literal></Term>
<ListItem>
<Para>Open a view of the user's preferred terminal emulator.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

1717
cde/doc/C/guides/man/man5/dttermes.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

89
cde/doc/C/guides/man/man5/dttexact.sgm Normal file
View File

@@ -0,0 +1,89 @@
<!-- $XConsortium: dttexact.sgm /main/5 1996/08/30 13:57:37 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.XCSA.MAN95.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN95.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dttextaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dttextaction</Literal></RefName>
<RefPurpose>&str-XZ; text editing actions
</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>Dtpad [<Symbol Role="Variable">file</Symbol>]
Open <Symbol Role="Variable">file</Symbol>
Print <Symbol Role="Variable">file</Symbol>
TextEditor
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Text Editing Services support the following
text editing actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dtpad</Literal></Term>
<ListItem>
<Para>Open an empty view of the desktop text editor.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dtpad</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open a desktop text editor view of the text file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Open</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Open a view of the text file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Message">Print</Symbol>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Print the text file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>TextEditor</Literal></Term>
<ListItem>
<Para>Open a view of the user's preferred text editor.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

63
cde/doc/C/guides/man/man5/dttraact.sgm Normal file
View File

@@ -0,0 +1,63 @@
<!-- $XConsortium: dttraact.sgm /main/5 1996/08/30 13:58: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.XCSA.MAN96.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN96.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dttrashaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dttrashaction</Literal></RefName>
<RefPurpose>&str-XZ; trash management actions
</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>Dttrash [<Symbol Role="Variable">file</Symbol>]
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; File Management Services support the following
trash management actions:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dttrash</Literal></Term>
<ListItem>
<Para>Open a folder view of the desktop trash folder.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Dttrash</Literal>&numsp;<Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Move the file named by the pathname in the
<Symbol Role="Variable">file</Symbol> argument to the desktop trash folder.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]><![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

79
cde/doc/C/guides/man/man5/imssact.sgm Normal file
View File

@@ -0,0 +1,79 @@
<!-- $XConsortium: imssact.sgm /main/3 1996/10/30 10:47:04 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.XCSA.imssact">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.imssact">]]>
<RefMeta>
<RefEntryTitle>dtimsstartaction</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Literal>dtimsstartaction</Literal></RefName>
<RefPurpose>&str-XZ; input method server actions
</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>Dtimsstart
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The &str-XZ; Input Method Server Services support the following
input method server actions:
</Para>
<variablelist>
<varlistentry>
<term><literal>DtImsMode</literal></term>
<listitem>
<para>
Change the IM Selection Mode. This action is located at <literal>Desktop_Tools</literal>
in the Application Manager.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>DtImsGetRemoteConf</literal></term>
<listitem>
<para>
Retrieve IMS configuration data on a remote system (used internally
by <command>dtimsstart</command>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>DtImsRunRemoteIms</literal></term>
<listitem>
<para>
Run an IMS on a remote system (used internally by
<command>dtimsstart</command>).
</para>
</listitem>
</varlistentry>
</variablelist>
<Para>These actions can be invoked from an application using the
&cdeman.DtActionInvoke; function or invoked from a command line using the
&cdeman.dtaction; utility.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtimsstart;,
&cdeman.dtaction;, <![ %CDE.C.CDE; [&cdeman.DtActionInvoke;. ]]>
<![ %CDE.C.XO; [&cdeman.DtActionInvoke; in the &str-Zd;.
]]></Para>
</RefSect1>
</RefEntry>

165
cde/doc/C/guides/man/man5/mmdbgifo.sgm Normal file
View File

@@ -0,0 +1,165 @@
<!-- $XConsortium: mmdbgifo.sgm /main/7 1996/09/08 20:01:38 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.dtmmdbgraphicinfo">]]>
<RefMeta>
<RefEntryTitle>
DtMmdbGraphicInfo
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">DtMmdbGraphicInfo</StructName>
</RefName>
<RefPurpose>graphic object structure in <command>dtinfo</command>
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <StructName Role="typedef">DtMmdbGraphicInfo</StructName>
structure contains information about a graphic object in <command>dtinfo</command>.
</para>
<para>The <StructName Role="typedef">DtMmdbGraphicInfo</StructName>
structure is defined as follows:
</para>
<literallayout>
#include &lt;DtInfo/DtMmdb.h>
typedef struct _DtMmdbGraphicInfo {
unsigned short coding;
unsigned short width;
unsigned short height;
unsigned int llx;
unsigned int lly;
unsigned int urx;
unsigned int ury;
char* version;
} DtMmdbGraphicInfo;
</literallayout>
<para>The <StructName Role="typedef">DtMmdbGraphicInfo</StructName>
members have the following meanings:
</para>
<variablelist>
<varlistentry><term><symbol role="Variable">coding</symbol></term>
<listitem>
<para>Specifies the type of the object. Valid values are:
</para>
<variablelist>
<varlistentry><term><Symbol>DtMmdbGraphicEPS</Symbol></term>
<listitem>
<para>Indicates an Encapsulated PostScript typed object.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicGIF</Symbol></term>
<listitem>
<para>Indicates a GIF typed object.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicXPM</Symbol></term>
<listitem>
<para>Indicates an XPM typed object.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicXBM</Symbol></term>
<listitem>
<para>Indicates an XBM typed object.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicCGM</Symbol></term>
<listitem>
<para>Indicates a CGM typed object (not supported)
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicJPEG</Symbol></term>
<listitem>
<para>Indicates a JPEG typed object (not supported)
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicTIFF</Symbol></term>
<listitem>
<para>Indicates a TIFF typed object (not supported)
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicXWD</Symbol></term>
<listitem>
<para>Indicates an XWD typed object (not supported)
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtMmdbGraphicUnknown</Symbol></term>
<listitem>
<para>Indicates an object of unknown type
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">width</symbol></term>
<listitem>
<para>Specifies the width of the object (in points).
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">height</symbol></term>
<listitem>
<para>Specifies the height of the object (in points).
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">llx</symbol></term>
<listitem>
<para>Specifies the X coordinate for the lower left corner if the object is of
type Encapsulated PostScript.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">lly</symbol></term>
<listitem>
<para>Specifies the Y coordinate for the lower left corner if the object is of
type Encapsulated PostScript.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">urx</symbol></term>
<listitem>
<para>Specifies the X coordinate for the upper right corner if the object is of
type Encapsulated PostScript.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">ury</symbol></term>
<listitem>
<para>Specifies the Y coordinate for the upper right corner if the object is of
type Encapsulated PostScript.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">version</symbol></term>
<listitem>
<para>Specifies the version of the object. Currently returns NULL. To be
specified in the future.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtMmdbFreeGraphicInfo;,
&cdeman.DtMmdbGraphicGetData;,
&cdeman.DtMmdbGraphicGetInfo;
</Para>
</RefSect1>
</RefEntry>

55
cde/doc/C/guides/man/man5/mmdbhndl.sgm Normal file
View File

@@ -0,0 +1,55 @@
<!-- $XConsortium: mmdbhndl.sgm /main/6 1996/09/08 20:01:47 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.dtmmdbhandle">]]>
<RefMeta>
<RefEntryTitle>
DtMmdbHandle
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">DtMmdbHandle</StructName>
</RefName>
<RefPurpose>object identifier structure in <command>dtinfo</command>
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <StructName Role="typedef">DtMmdbHandle</StructName>
structure contains information about the identifier of
an object in <command>dtinfo</command>.
</para>
<para>The <StructName Role="typedef">DtMmdbHandle</StructName>
structure is defined as follows:
</para>
<literallayout>
#include &lt;DtInfo/DtMmdb.h>
typedef struct _DtMmdbObjectId {
void* oid_ptr;
} DtMmdbHandle;
</literallayout>
<para>The <StructName Role="typedef">DtMmdbHandle</StructName>
member is defined as follows:
</para>
<variablelist>
<varlistentry><term><symbol role="Variable">oid_ptr</symbol></term>
<listitem>
<para>Specifies the identifier of a DtInfo object.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtMmdbFreeHandleList;,
&cdeman.DtMmdbFreeHandle;
</Para>
</RefSect1>
</RefEntry>

82
cde/doc/C/guides/man/man5/mmdbireq.sgm Normal file
View File

@@ -0,0 +1,82 @@
<!-- $XConsortium: mmdbireq.sgm /main/6 1996/08/30 14:00:19 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.dtmmdbinforequest">]]>
<RefMeta>
<RefEntryTitle>
DtMmdbInfoRequest
</RefEntryTitle>
<ManVolNum>file formats</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">DtMmdbInfoRequest</StructName>
</RefName>
<RefPurpose>
database access request structure in <command>dtinfo</command>
</RefPurpose>
</RefNameDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para>The <StructName Role="typedef">DtMmdbInfoRequest</StructName>
structure contains information about a DtInfo database access request.
</para>
<para>The <StructName Role="typedef">DtMmdbInfoRequest</StructName>
structure is defined as follows:
</para>
<literallayout>
#include &lt;DtInfo/DtMmdb.h>
typedef struct _DtMmdbInfoRequest {
int bookcase_descriptor;
char* locator_ptr;
DtMmdbHandle* primary_oid;
DtMmdbHandle* secondary_oid;
int sequence_num;
} DtMmdbInfoRequest;
P</literallayout>
<para>The <StructName Role="typedef">DtMmdbInfoRequest</StructName>
members have the following meanings:
</para>
<variablelist>
<varlistentry><term><symbol role="Variable">bookcase_descriptor</symbol></term>
<listitem>
<para>Specifies the bookcase from which the access will be performed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">locator_ptr</symbol></term>
<listitem>
<para>Specifies the locator of the object to be accessed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">primary_oid</symbol></term>
<listitem>
<para>Specifies the primary object id with which the object can be accessed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">secondary_oid</symbol></term>
<listitem>
<para>Specifies the secondary object id with which the object can be accessed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">sequence_num</symbol></term>
<listitem>
<para>Specifies the sequence number of the object to be accessed.
</para>
</listitem>
</varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtMmdbHandle;
</Para>
</RefSect1>
</RefEntry>