About Sun WorkShop 6 Documentation

Chapter 1

Accessing Sun WorkShop 6 Documentation

This chapter describes documentation formats and where to find Sun WorkShop^TM 6 documentation on the Internet and on your local system or network.

Documentation Formats and Requirements

Sun WorkShop 6 documentation is available in the following formats.

TABLE 1-1   Sun WorkShop 6 Documentation Formats

Description	HTML	ASCII	Printed
Manuals
Online help
Man pages
Component readme files

To view Sun WorkShop documentation that is available in HTML format, you must use Netscape^TM Communicator 4.0 or a compatible Netscape version. Netscape Communicator is included in the Solaris^TM 7 Operating Environment and the Solaris^TM 8 Operating Environment.

If you are running the Solaris 2.6 Operating Environment and you do not have Netscape Communicator 4.0 or a compatible version, you can download Netscape Communicator 4.7 for the Solaris 2.6 Operating Environment.

To download Netscape Communicator 4.7, see the following Netscape Communications Corporation Web site:

http://www.netscape.com/download/index.html

Sun WorkShop online help (in HTML) requires that you have JavaScript^TM enabled, which is a default setting in Netscape preferences.

Documentation Availability

You can access Sun WorkShop 6 documentation in the following ways:

• Through the Internet at the docs.sun.com^sm Web site
• Through the Sun WorkShop 6 Web site
• Through the installed Sun WorkShop products on your local system or network

The docs.sun.com Web Site

The docs.sun.com Web site enables you to access Sun technical and product documentation through the Internet. You can search for a book title or you can browse by subject, document collection, or product at http://docs.sun.com.

For a list of Sun WorkShop 6 documentation by subject and by document collection name and book title, see Chapter 3.

The Sun WorkShop 6 Web Site

The Sun WorkShop 6 Web site at http://www.sun.com/workshop gives you access to the following Sun WorkShop 6 documentation:

• Manuals
• Online help
• Man pages
• Component readme files
• Release notes

Installed Products

The following documentation is available in HTML format with your installed Sun WorkShop 6 products:

• Manuals
• Online help
• Man pages
• Component readme files
• Release notes

HTML manuals replace AnswerBook2^TM collections. AnswerBook2 collections are not available with this Sun WorkShop release.

In order to view the HTML versions of the documentation, you must have Netscape Communicator 4.0 or a compatible Netscape version. If you do not have Netscape Communicator 4.0 or a compatible version, you can download Netscape Communicator 4.7. For more information, see Documentation Formats and Requirements.

---

Note – The information in this section assumes that your Sun WorkShop 6 products were installed in the /opt directory. If your Sun WorkShop software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

---

Manuals

All Sun WorkShop 6 manuals are available in HTML format.

To access Sun WorkShop 6 manuals in HTML format, do one of the following:

• In any Sun WorkShop or Sun WorkShop^TM TeamWare window, choose Help About Documentation.
• In your Netscape Communicator 4.0 or compatible Netscape version browser, open the following file:

  /opt/SUNWspro/docs/index.html

Your browser displays an index of the HTML documents for Sun WorkShop 6. To open a document in the index, click the document's title.

Online Help

Sun WorkShop provides an online help system in HTML format that contains extensive task-oriented information about Sun WorkShop and Sun WorkShop TeamWare. Access the online help in one of the following ways:

• Through the Help menu in any Sun WorkShop or Sun WorkShop TeamWare window
• By opening the file /opt/SUNWspro/docs/index.html in your Netscape browser

You must have Netscape Communicator 4.0 or a compatible Netscape version in order to view the online help. If you do not have Netscape Communicator 4.0 or a compatible version, you can download Netscape Communicator 4.7. For more information, see Documentation Formats and Requirements.

Man Pages

Man pages are available in ASCII text and in HTML format:

• To access a Sun WorkShop command's man page from the command line, type the following at a command-line prompt:

  % man command

  If the man page you requested cannot be found or if the man page displayed is not for the current version of the software installed, follow the instructions in Access to Sun WorkShop.

• To access a Sun WorkShop command's man page in HTML format, open the following file in your Netscape Communicator 4.0 or compatible browser:

  /opt/SUNWspro/docs/index.html

  To open a file listed in the index, click the file's title.

Component Readme Files

The readme files contain last-minute information about Sun WorkShop 6 components and are available in ASCII text and in HTML format.

To access the HTML version of a readme file, open the following index file in your Netscape Communicator 4.0 or compatible browser, and click on a document's title in the index to open it:

/opt/SUNWspro/docs/index.html

To access a text version of a readme file, do the following:

1. Type the following commands at a command line:

% cd /opt/SUNWspro/READMEs % ls

2. View a readme file by typing:

% more readme-filename

Release Notes

Sun WorkShop 6 Release Notes are accessible in HTML format. Open the following file in your Netscape Communicator 4.0 or compatible Netscape version browser, and click on the release notes file link:

/opt/SUNWspro/docs/index.html