Preface

Use this portion of the template to cite the Book Title, and identify precisely what the book provides for the reader. For example, one book might explain in detail how to perform the basic duties of administrating a system, while another book concentrates on devices only. Identify the book's place in the document set, but do not list the other documents here. Use one or two paragraphs to provide a preliminary explanation of your book.

Who Should Use This Book

Identify the audience. Use this text to promote the features of the document that are particularly useful to the target audience. If other books cover similar information for a different audience, direct the reader to those books. For example, if this document is targeted for entry users, indicate the books that developers might want to read for more in-depth information.

The audience description might include the following information:

• Required knowledge, such as a specific programming language

• Required experience or familiarity with the Solaris operating environment or a hardware platform

• Definition of the type of user or functional responsibility, such as applications programmer, system administrator, or field engineer

• Terms that relate to the tasks the user might perform

[Editor's note: Resist any temptation to write “Those of you...,” “Some of you...,” or similar wording. Remember, only one person at a time is reading.]

Before You Read This Book

If the reader must be familiar with other books before reading this book, list those books here:

• Sun Editorial Style Guide

• Epic User's Guide

• SGML Writer's Guide

This section is not intended for recommended reading. You include that information in a later section.

If the reader must know how to do something or must have completed some task before using this book, provide that information here.

How This Book Is Organized

List your chapters and appendixes here. Write a description of one or two sentences for each chapter and appendix:

---

Note –

In your book, make these items live cross-references.

---

Chapter 1 provides an overview of the SunFoo product.

Chapter 2 discusses how to program for the SunFoo product.

Chapter 3 describes the commands used in the SunFoo product.

Appendix A provides tables containing keyboard shortcuts and other helpful information.

Glossary is a list of words and phrases found in this book and their definitions.

Related Books

List titles of Sun documents that are related to this manual. For example, do not recommend the entire system administration set here. Also list third-party books, and their authors and publishers, that are mentioned in the text or that readers might find useful.

• SunFoo Installation Guide

• SunFoo Developer's Guide

• Programming With the SunFoo Language

Related Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

---

Note –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

---

Documentation, Support, and Training

Sun Function	URL	Description
Documentation	http://www.sun.com/documentation/	Download PDF and HTML documents, and order printed documents
Support and Training	http://www.sun.com/supportraining/	Obtain technical support, download patches, and learn about Sun courses

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–1 Typographic Conventions

Typeface or Symbol	Meaning	Example
AaBbCc123	The names of commands, files, and directories, and onscreen computer output	Edit your .login file. Use ls -a to list all files. machine_name% you have mail.
AaBbCc123	What you type, contrasted with onscreen computer output	machine_name% su Password:
AaBbCc123	Command-line placeholder: replace with a real name or value	The command to remove a file is rm filename.
AaBbCc123	Book titles, new terms, and terms to be emphasized	Read Chapter 6 in the User's Guide. Perform a patch analysis. Do not save the file. [Note that some emphasized items appear bold online.]

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–2 Shell Prompts

Shell	Prompt
C shell prompt	machine_name%
C shell superuser prompt	machine_name#
Bourne shell and Korn shell prompt	$
Bourne shell and Korn shell superuser prompt	#