About Sun WorkShop 6 Documentation

Preface

About Sun WorkShop 6 Documentation describes the documentation available with this Sun WorkShop^TM release and how to access it.

Access to Sun WorkShop

Because Sun WorkShop product components and man pages do not install into the standard /usr/bin/ and /usr/share/man directories, you must change your PATH and MANPATH environment variables to enable access to Sun WorkShop compilers and tools.

To determine if you need to set your PATH environment variable:

1. Display the current value of the PATH variable by typing:

% echo $PATH

2. Review the output for a string of paths that contains /opt/SUNWspro/bin/.

If you find the paths, your PATH variable is already set to access Sun WorkShop development tools. If you do not find the paths, set your PATH environment variable by following the instructions in this section.

To determine if you need to set your MANPATH environment variable:

1. Request the workshop man page by typing:

% man workshop

2. Review the output, if any.

If the workshop(1) man page cannot be found or if the man page displayed is not for the current version of the software installed, follow the instructions in this section for setting your MANPATH environment variable.

To set your PATH and MANPATH environment variables:

Open your home .cshrc file if you are using the C shell or your home .profile file if you are using the Bourne or Korn shells, and do the following:

• To use Sun WorkShop commands, add the following to your PATH variable:

  /opt/SUNWspro/bin

• To access Sun WorkShop man pages with the man command, add the following to your MANPATH variable:

  /opt/SUNWspro/man

  ---

  Note – If your Sun WorkShop software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

  ---

For more information about the PATH variable, see the csh(1), sh(1), and ksh(1) man pages. For more information about the MANPATH variable, see the man(1) man page. For more information about setting your PATH and MANPATH variables to access this release, see the Sun WorkShop 6 Installation Guide or your system administrator.

How This Book Is Organized

About Sun WorkShop 6 Documentation contains the following chapters:

Chapter 1, "Accessing Sun WorkShop 6 Documentation," describes documentation formats and how to find Sun WorkShop 6 documentation on the Internet and through your installed product on your local system or network.

Chapter 2, "Understanding the Changes to Sun WorkShop Documentation," describes changes to the documentation since the Sun WorkShop 5.0 release.

Chapter 3, "Identifying the Documentation That You Need," lists Sun WorkShop 6 documentation by subject.

Typographic Conventions

TABLE P-1 shows the typographic conventions that are used in Sun WorkShop documentation.

TABLE P-1   Typographic Conventions

Typeface	Meaning	Examples
AaBbCc123	The names of commands, files, and directories; on-screen computer output	Edit your .login file. Use ls -a to list all files. % You have mail.
AaBbCc123	What you type, when contrasted with on-screen computer output	% su Password:
AaBbCc123	Book titles, new words or terms, words to be emphasized	Read Chapter 6 in the User's Guide. These are called class options. You must be superuser to do this.
AaBbCc123	Command-line placeholder text; replace with a real name or value	To delete a file, type rm filename.