Files
cdesktop/cde/doc/C/guides/dtkshGuide/preface.sgm

183 lines
9.9 KiB
Plaintext

<!-- $XConsortium: preface.sgm /main/8 1996/08/25 15:09:35 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<preface id="DKSUG.Pref.div.1">
<title>Preface</title>
<para>The <emphasis>Desktop KornShell User's Guide</emphasis> provides the
information you need to create Motif applications with KornShell (kshell)
scripts. In addition to the basic information you'll need to get started,
several example scripts of increasing complexity are described. Throughout
this guide the term <command>dtksh</command> means the Desktop KornShell.
</para>
<sect1 id="DKSUG.Pref.div.2">
<title>Who Should Use This Guide</title>
<para>This guide is intended for programmers who want a quick and easy means
of creating Motif applications, but don't have the time, knowledge, or inclination
to use the C programming language. A good understanding of kshell programming,
Motif, the Xt Intrinsics, and, to a lesser extent, Xlib is needed. An understanding
of C would also be helpful.</para>
</sect1>
<sect1 id="DKSUG.Pref.div.3">
<title>How This Guide Is Organized</title>
<para><emphasis role="Lead-in">Chapter 1, &ldquo;Introduction to Desktop KornShell,&rdquo;</emphasis> describes the basic information you need to begin writing Motif
applications in <command>dtksh</command> scripts.</para>
<para><emphasis role="Lead-in">Chapter 2, &ldquo;A Sample Script,&rdquo;</emphasis> describes two simple <command>dtksh</command> scripts. The first
script creates a push button widget within a bulletin board widget. The
second script expands the first by adding a callback for the push button.
</para>
<para><emphasis role="Lead-in">Chapter 3, &ldquo;Advanced Topics,&rdquo;</emphasis> describes more advanced topics pertaining to <command>dtksh</command>
scripts.</para>
<para><emphasis role="Lead-in">Chapter 4, &ldquo;A Complex Script,&rdquo;</emphasis> describes a much more complex script than either of the ones
described in Chapter 2. This script creates a graphic interface to the <command>find</command> command.</para>
<para><emphasis role="Lead-in">Appendix A, &ldquo;dtksh Commands,&rdquo;</emphasis> lists all the <command>dtksh</command> commands.</para>
<para><emphasis role="Lead-in">Appendix B, &ldquo;dtksh Convenience Functions,&rdquo;</emphasis> contains man pages for commands or functions that are not documented
elsewhere.</para>
<para><emphasis role="Lead-in">Appendix C, &ldquo;Listing for script_find,&rdquo;</emphasis> contains the complete listing of the complex script described
in Chapter 4.</para>
</sect1>
<sect1 id="DKSUG.Pref.div.4">
<title>Related Books</title>
<para>The following books provide information on kshell programming, Motif,
the Xt Intrinsics, and Xlib:</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>Desktop KornShell
Graphical Programming For the Common Desktop Environment Version 1.0,</emphasis>
by J. Stephen Pendergrast, Jr., published by Addison-Wesley, Reading, MA
01867.</para>
</listitem><listitem><para><emphasis>The New KornShell Command and Programming
Language</emphasis>, by Morris I. Bolsky and David G. Korn, published by
Prentice-Hall, Englewood Cliffs, NJ 07632.</para>
</listitem><listitem><para><emphasis>KornShell Programming Tutorial</emphasis>,
by Barry Rosenberg, published by Addison-Wesley, Reading, MA 01867.</para>
</listitem><listitem><para><emphasis>Motif Programmer's Guide</emphasis>,
Open Software Foundation, 11 Cambridge Center, Cambridge, MA 02142, published
by Prentice-Hall, Englewood Cliffs, NJ 07632.</para>
</listitem><listitem><para><emphasis>Motif Programmer's Reference</emphasis>,
Open Software Foundation, 11 Cambridge Center, Cambridge, MA 02142, published
by Prentice-Hall, Englewood Cliffs, NJ 07632.</para>
</listitem><listitem><para><emphasis>Motif Reference Guide</emphasis>,
by Douglas A. Young, published by Prentice-Hall, Englewood Cliffs, NJ 07632.
</para>
</listitem><listitem><para><emphasis>Mastering Motif Widgets</emphasis> (Second
Edition), by Donald L. McMinds, published by Addison-Wesley, Reading, MA
01867</para>
</listitem><listitem><para><emphasis>The X Window System Programming and Applications
with Xt Motif Edition</emphasis>, by Douglas A. Young, published by Prentice-Hall,
Englewood Cliffs, NJ 07632.</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 1: Xlib Programming Manual</emphasis>, by Adrian Nye, published
by O'Reilly and Associates, Sebastopol, CA 95472.</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 2: Xlib Reference Manual</emphasis>, edited by Adrian Nye,
published by O'Reilly and Associates, Sebastopol, CA 95472.</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 3: X Window System User's Guide</emphasis>, by Valerie Quercia
and Tim O'Reilly, published by O'Reilly and Associates, Sebastopol, CA 95472.
</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 4: X Toolkit Intrinsics Programming Manual</emphasis>, by
Adrian Nye and Tim O'Reilly, published by O'Reilly and Associates, Sebastopol,
CA 95472.</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 5: X Toolkit Intrinsics Reference Manual,</emphasis> edited
by Tim O'Reilly, published by O'Reilly and Associates, Sebastopol, CA 95472.
</para>
</listitem><listitem><para><emphasis>The Definitive Guides to the X Window
System, Volume 6: Motif Programming Manual</emphasis>, by Dan Heller, published
by O'Reilly and Associates, Sebastopol, CA 95472.</para>
</listitem></itemizedlist>
</sect1>
<sect1 id="DKSUG.Pref.div.4a">
<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="DKSUG.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>
<sect1 id="DKSUG.Pref.div.5">
<title>Shell Prompt Characters</title>
<para>The following table shows shell prompt characters
used in this book.</para>
<table id="DKSUG.Pref.tbl.2" frame="Topbot">
<title>Shell Prompt Characters</title>
<tgroup cols="3" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.33in">
<colspec colname="col1" colwidth="128*">
<colspec colname="col2" colwidth="201*">
<colspec colname="col3" colwidth="193*">
<spanspec nameend="col2" namest="col1" spanname="1to2">
<thead>
<row><entry align="left" valign="bottom"><para><literal>Character</literal></para></entry><entry align="left" valign="bottom"><para><literal>Meaning</literal></para></entry><entry align="left" valign="bottom"><para><literal>Example</literal></para></entry></row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para><filename>%</filename></para></entry>
<entry align="left" valign="top"><para>UNIX C shell prompt</para></entry>
<entry align="left" valign="top"><para><filename>system%</filename></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><filename>$</filename></para></entry>
<entry align="left" valign="top"><para>UNIX Bourne and Korn shell prompt
</para></entry>
<entry align="left" valign="top"><para><filename>system$</filename></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><filename>#</filename></para></entry>
<entry align="left" valign="top"><para>Superuser prompt, all shells</para></entry>
<entry align="left" valign="top"><para><filename>system#</filename></para></entry>
</row></tbody></tgroup><?Pub Caret></table>
</sect1>
</preface>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 10:26:11-->
<?Pub *0000010499>