Return to preface.sgml CVS log

Up to [Development] / failsafe / FailSafe-books / LnxFailSafe_PG

New documentation files for the Programmers' Guide.

<!-- Fragment document type declaration subset:
ArborText, Inc., 1988-1997, v.4001
<!DOCTYPE SET PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY scriptlib.sgml SYSTEM "scriptlib.sgml">
<!ENTITY scriptlibapp.sgml SYSTEM "scriptlibapp.sgml">
<!ENTITY startgui.sgml SYSTEM "startgui.sgml">
<!ENTITY overview.sgml SYSTEM "overview.sgml">
<!ENTITY action.sgml SYSTEM "action.sgml">
<!ENTITY failover.sgml SYSTEM "failover.sgml">
<!ENTITY database.sgml SYSTEM "database.sgml">
<!ENTITY install.sgml SYSTEM "install.sgml">
<!ENTITY gloss.sgml SYSTEM "gloss.sgml">
<!ENTITY monitor SYSTEM "figures/monitor.eps" NDATA eps>
<!ENTITY resource.ai SYSTEM "figures/resource.ai.eps" NDATA eps>
<!ENTITY optional.ai SYSTEM "figures/optional.ai.eps" NDATA eps>
<!ENTITY manager.ai SYSTEM "figures/manager.ai.eps" NDATA eps>
<!ENTITY depend.ai SYSTEM "figures/depend.ai.eps" NDATA eps>
<!ENTITY type.ai SYSTEM "figures/type.ai.eps" NDATA eps>
<!ENTITY attrib.ai SYSTEM "figures/attrib.ai.eps" NDATA eps>
<!ENTITY action.ai SYSTEM "figures/action.ai.eps" NDATA eps>
<!ENTITY star.configuration SYSTEM "figures/star.configuration.eps" NDATA eps>
<!ENTITY n.plus.2.configuration SYSTEM "figures/n.plus.2.configuration.eps" NDATA eps>
<!ENTITY square.configuration SYSTEM "figures/square.configuration.eps" NDATA eps>
]>
-->
<preface id="LE21374-PARENT">
<title id="LE21374-TITLE">About This Guide</title>
<para>This guide explains how to write the set of scripts that are required
to turn an application into a highly available service in conjunction
with Linux FailSafe software. It also tells you how to create a new resource
type.</para>
<para>This guide assumes that the Linux FailSafe system has been configured
as described in the <citetitle>Linux FailSafe Administrator's Guide</citetitle>.
</para>
<sect1>
<title>Audience</title>
<para>This guide is written for system programmers who are developing
scripts for the Linux FailSafe system. These scripts allow the failover
of applications that are not handled by the base and optional products.
Readers must be familiar with the operation and administration of nodes
running Linux FailSafe, with the applications that are to be failed over,
and with the <citetitle>Linux FailSafe Administrator's Guide</citetitle>.
</para>
</sect1>
<sect1>
<title>Related Documentation</title>
<para>Besides this guide, other documentation for Linux FailSafe includes
the following:</para>
<itemizedlist>
<listitem><para><citetitle>Linux FailSafe Administrator's Guide</citetitle></para>
</listitem>
</itemizedlist>
<para>System man pages for referenced commands are as follows:</para>
<itemizedlist>
<listitem><para><command>cbeutil</command></para>
</listitem>
<listitem><para><command>cdbBackup</command></para>
</listitem>
<listitem><para><command>cdbRestore</command></para>
</listitem>
<listitem><para><command>cdbutil</command></para>
</listitem>
<listitem><para><command>cluster_mgr</command></para>
</listitem>
<listitem><para><command>crsd</command></para>
</listitem>
<listitem><para><command>failsafe</command></para>
</listitem>
<listitem><para><command>cdbd</command></para>
</listitem>
<listitem><para><command>ha_cilog</command></para>
</listitem>
<listitem><para><command>ha_cmsd</command></para>
</listitem>
<listitem><para><command>ha_exec2</command></para>
</listitem>
<listitem><para><command>ha_fsd</command></para>
</listitem>
<listitem><para><command>ha_gcd</command></para>
</listitem>
<listitem><para><command>ha_ifd</command></para>
</listitem>
<listitem><para><command>ha_ifdadmin</command></para>
</listitem>
<listitem><para><command>ha_macconfig2</command></para>
</listitem>
<listitem><para><command>ha_srmd</command></para>
</listitem>
<listitem><para><command>ha_statd2</command></para>
</listitem>
<listitem><para><command>haStatus</command></para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Conventions Used in This Guide</title>
<para>These type conventions and symbols are used in this guide:</para>
<variablelist>
<varlistentry><term><command>command</command></term>
<listitem>
<para>Function names, literal command-line arguments (options/flags)</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>filename</filename></term>
<listitem>
<para>Name of a file or directory</para>
</listitem>
</varlistentry>
<varlistentry><term><userinput>command -o option</userinput> </term>
<listitem>
<para>Commands and text that you are to type literally in response to
shell and command prompts</para>
</listitem>
</varlistentry>
<varlistentry><term><firstterm>term</firstterm></term>
<listitem>
<para>New terms</para>
</listitem>
</varlistentry>
<varlistentry><term><citetitle>Book Title</citetitle></term>
<listitem>
<para>Manual or book title</para>
</listitem>
</varlistentry>
<varlistentry><term><replaceable>variable</replaceable></term>
<listitem>
<para>Command-line arguments, filenames, and variables to be supplied
by the user in examples, code, and syntax statements</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>literal text<?Pub Caret></literal> </term>
<listitem>
<para>Code examples, error messages, prompts, and screen text</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>#</literal> </term>
<listitem>
<para>System shell prompt for the superuser (<literal>root</literal>)
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</preface>
<?Pub *0000005732>