CDE/cde/doc/C/guides/ttGuide/preface.sgm

<!-- $XConsortium: preface.sgm /main/7 1996/09/08 19:35:59 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. -->
<Preface Id="TTUG.Pref.div.1">
<Title>Preface</Title>
<Para>This book describes the Common Desktop Environment (CDE) components,
commands, and error messages of the ToolTalk<Superscript>&reg;</Superscript> service.</Para>
<Note>
<Para>In-depth information about the functionality of the ToolTalk service in
general is beyond the scope of this book. That is, <Emphasis>CDE ToolTalk Messaging Overview</Emphasis> does <Emphasis Role="Lead-in">not</Emphasis> describe all ToolTalk APIs or commands, or other ToolTalk
functionality not specifically related to this release of the ToolTalk service for
the Common Desktop Environment. See the<IndexTerm>
<Primary>ToolTalk Reference Manual</Primary>
</IndexTerm>
<Emphasis>ToolTalk Reference Manual</Emphasis> and the<IndexTerm>
<Primary>ToolTalk User'</Primary>
</IndexTerm><IndexTerm>
<Primary>s Guide</Primary>
</IndexTerm>
<Emphasis>ToolTalk User's Guide</Emphasis> for this information.</Para>
</Note>
<Sect1 Id="TTUG.Pref.div.2">
<Title>Who Should Use This Book</Title>
<Para>This manual is for developers who create or maintain applications that use the
ToolTalk service to inter&hyphen;operate with other applications in Common Desktop Environment
. This manual assumes familiarity with <![ %Solaris; [the ToolTalk service and
its functionality, UNIX<Superscript>&trade;</Superscript> ]]>operating system commands, system administrator
commands, and system terminology.</Para>
</Sect1>
<Sect1 Id="TTUG.Pref.div.3">
<Title>How This Book Is Organized</Title>
<Para>This book is organized as follows:</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Chapter&numsp;1, &xd2;Introducing the ToolTalk Service'--><XRef Role="ChapNumAndTitle" Linkend="TTUG.tttrc.mkr.1">, describes how the ToolTalk
service works and how it uses information that your application supplies to
deliver messages; how applications use the ToolTalk service; and application
and ToolTalk components.</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Chapter&numsp;2, &xd2;How to Use ToolTalk Messaging'--><XRef Role="ChapNumAndTitle" Linkend="TTUG.HTU.mkr.1">, contains the information you
need to write an application using the ToolTalk service in the Common Desktop Environment
, including the kinds of ToolTalk toolkit messages that
need to be included in your application in order for it to inter-operate with
other ToolTalk-aware Common Desktop Environment-compliant applications.</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Chapter&numsp;3, &xd2;Using TTSnoop to Debug Messages and Patterns'--><XRef Role="ChapNumAndTitle" Linkend="TTUG.tttrc.mkr.1">, describes how
to create and send custom&hyphen;constructed ToolTalk messages, and also how to
selectively monitor any or all ToolTalk messages.</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Chapter&numsp;4, &xd2;Using ToolTalk Tracing'--><XRef Role="ChapNumAndTitle" Linkend="TTUG.tttrc.mkr.1">, describes how a ToolTalk pattern
matches and delivers every message ttsession sees.</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Appendix&numsp;A, &xd2;The Messaging Toolkit'--><XRef Role="AppendixNumAndTitle" Linkend="TTUG.MsgTk.mkr.1">, describes some of the application
program interface (API functions) that are a part of the messaging toolkit.</Para>
<Para><Literal><!--Literal closed to allow XRef:--></Literal>
<!--Original XRef content: 'Appendix&numsp;B, &xd2;The broadcast Demonstration Program'--><XRef Role="AppendixNumAndTitle" Linkend="TTUG.BrCast.mkr.1">, contains the source code
for the ToolTalk demo program, <literal>broadcast</literal>.</Para>
<para>Appendix C discusses writing thread-safe ToolTalk applications.
</para>
</Sect1>
<Sect1 Id="TTUG.Pref.div.4">
<Title>Related Books and Other Documentation</Title>
<Para><Emphasis>CDE ToolTalk Messaging Overview</Emphasis> does <Emphasis>not</Emphasis> provide in&hyphen;depth information about<IndexTerm>
<Primary>ToolTalk functionality, in-depth information about</Primary>
</IndexTerm>
ToolTalk and its functionality. In addition to the ToolTalk product base
documentation (that is, <Emphasis>ToolTalk User's Guide</Emphasis> and the <Emphasis>ToolTalk Reference Manual</Emphasis>),
the following related ToolTalk documentation provide in-depth information
about the ToolTalk functionality that is beyond the<IndexTerm>
<Primary>scope, of this book</Primary>
</IndexTerm>
scope of this book:</Para>
<ItemizedList Remap="Bullet1">
<ListItem>
<Para><Emphasis><IndexTerm>
<Primary>The ToolTalk Service - An Inter-Operability Solution, ISBN 013-088717-X</Primary>
</IndexTerm>The ToolTalk Service - An Inter-Operability Solution</Emphasis> <Emphasis>(Published by SunSoft Press/PTR Prentice Hall, ISBN 013-088717-X)</Emphasis></Para>
<Para><Emphasis>This book describes ToolTalk and its functionality in depth, and is
appropriate for all platforms to which ToolTalk has been ported. It is
available at your local bookstore or directly from PTR Prentice Hall.</Emphasis></Para>
</ListItem>
<ListItem>
<Para><Emphasis><IndexTerm>
<Primary>ToolTalk and Open Protocols, ISBN 013-031055-7</Primary>
</IndexTerm>ToolTalk and Open Protocols</Emphasis> <Emphasis>by Astrid M. Julienne and Brian Holtz
(Published by SunSoft Press/PTR Prentice Hall, ISBN 013-031055-7)</Emphasis></Para>
<Para>This book describes how to create and develop open protocols for
applications that use a messaging service to communicate with other
applications. The general principles described in this book provide an
application with the flexibility required for users to easily inter&hyphen;change
tools. It is available at your local bookstore or directly from PTR Prentice
Hall.</Para>
</ListItem>
<ListItem>
<Para><Emphasis>ToolTalk Message Sets</Emphasis></Para>
<ItemizedList Remap="Bullet2">
<ListItem>
<Para>ToolTalk<IndexTerm>
<Primary>Desktop Services Message Set</Primary>
</IndexTerm>
Desktop Services Message Set</Para>
<Para>These conventions apply to any tools in a POSIX or X11 environment. In
addition to standard messages for these environments, the Desktop
conventions define data types and error codes that apply to all of the
ToolTalk inter&hyphen;client conventions.</Para>
</ListItem>
<ListItem>
<Para>ToolTalk<IndexTerm>
<Primary>Document and Media Exchange Message Set</Primary>
</IndexTerm>
Document and Media Exchange Message Set</Para>
<Para>Allows a tool to be a container for arbitrary media, or to be a media
player/editor that can be driven from such a container.</Para>
</ListItem>
<ListItem>
<Para><Emphasis><IndexTerm>
<Primary>CASE Inter-Operability Message Set</Primary>
</IndexTerm>CASE Inter-Operability Message Set</Emphasis></Para>
<Para>An <Emphasis>open</Emphasis> specification defining abstract, framework-neutral message
interfaces for CASE set-up by Sunsoft, DEC, and SGI. This work has been
merged with HP's CASE Communique work, which defined message
interfaces for HP's SoftBench Broadcast Message Server framework, and
was submitted as a joint draft to ANSI X3H6. As of this writing, ANSI
X3H6 is still reviewing the joint submission draft. More information on
the draft<IndexTerm>
<Primary>X3H6 standard</Primary>
</IndexTerm>
X3H6 standard can be retrieved from <Emphasis><IndexTerm>
<Primary>ftp.netcomcom</Primary>
</IndexTerm>ftp.netcom.com</Emphasis>, in<IndexTerm>
<Primary>/pub/X3H</Primary>
</IndexTerm>
/pub/X3H6; or you can contact:</Para>
</ListItem>
</ItemizedList>
</ListItem>
</ItemizedList>
<Para>X3 Secretariat<IndexTerm>
<Primary>Computer and Business Equipment Manufactures Assoc</Primary>
</IndexTerm>
Computer and Business Equipment Manufactures Assoc
1250 Eye St NW
Washington DC&numsp;&numsp;20005-3922
Telephone: (202) 737-8888 (press `1' twice)
Fax: (202) 638-4922 or (202) 628-2829</Para>
</Sect1>
<Sect1 Id="TTUG.Pref.div.5">
<Title>ToolTalk News Group</Title>
<Para>The ToolTalk<IndexTerm>
<Primary>news group</Primary>
</IndexTerm>
news group is:</Para>
<Para><IndexTerm>
<Primary>alt.soft-sys.tooltalk</Primary>
</IndexTerm><Emphasis>alt.soft-sys.tooltalk</Emphasis></Para>
</Sect1>
<sect1 id="TTUG.Pref.div.6">
<title>What DocBook SGML Markup Means</title>
<para>This book is written in the Structured Generalized Markup
Language (SGML) using the DocBook Document Type Definition (DTD).
The following table describes the DocBook markup used for
various semantic elements.
</para>
<table id="TTUG.Pref.tbl.1" frame="Topbot">
<title>DocBook SGML Markup</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colwidth="1.65in">
<colspec colwidth="2.63in">
<colspec colwidth="2.92in">
<thead>
<row>
<entry align="left" valign="bottom"><para><literal>Markup Appearance</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>Semantic Element(s)</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>Example</literal></para></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top"><para><command>AaBbCc123</command></para></entry>
<entry align="left" valign="top"><para>The names of commands.</para></entry>
<entry align="left" valign="top"><para>Use the <command>ls</command> command to list files.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><literal>AaBbCc123</literal></para></entry>
<entry align="left" valign="top"><para>The names of command options.</para></entry>
<entry align="left" valign="top"><para>Use <command>ls</command> <literal>&minus;a</literal>
to list all files.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">AaBbCc123</symbol></para></entry>
<entry align="left" valign="top"><para>Command-line placeholder:
replace with a real name or value.</para></entry>
<entry align="left" valign="top"><para>To delete a file, type <command>rm</command> <symbol role="Variable">filename</symbol>.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><filename>AaBbCc123</filename></para></entry>
<entry align="left" valign="top"><para>The names of files and
directories.</para></entry>
<entry align="left" valign="top"><para>Edit your <filename>.login</filename>
file.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><emphasis>AaBbCc123</emphasis></para></entry>
<entry align="left" valign="top"><para>Book titles, new words or terms, or
words to be emphasized.</para></entry>
<entry align="left" valign="top"><para>Read Chapter 6 in <emphasis>User's
Guide</emphasis>.
These are called <emphasis>class</emphasis> options.
You <emphasis>must</emphasis> be root to do this.</para></entry>
</row></tbody></tgroup></table>
</sect1>
</Preface>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 05:02:32-->