Preface

Sun WorkShop TeamWare User's Guide

Preface

The Sun WorkShop TeamWare User's Guide describes how to use the Sun Workshop^TM TeamWare code management tools. This manual is intended for the software developer, but can be used by anyone involved in team development of a product, including integrators, administrators, and release engineers.

As a software developer, you typically acquire code from a code integration area or integration workspace. You then:

Add new features to your program module
Test and debug the program
Put the code back in the implementation or integration workspace from which it was acquired.

This manual assumes some understanding of the Solaris^TM Operating Environment and UNIX^® commands. You need not have previous experience with the Source Code Control System (SCCS).

Chapter ," and Chapter ," are a supplement to the Solaris Operating Environment make documentation. They describe how to use Building and Distributed Make to improve the process of building programs and make it more efficient. Use these chapters if you maintain programs using the make utility and wish to speed up the build process. These chapters assume that you are familiar with the standard make utility and that you are familiar with programming constructs and processes.

Multiplatform Release

This Sun WorkShop release supports versions 2.6, 7, and 8 of the Solaris^TM SPARC^TM Platform Edition and Solaris Intel Platform Edition Operating Environments.

Note – The term "x86" refers to the Intel 8086 family of microprocessor chips, including the Pentium, Pentium Pro, and Pentium II processors and compatible microprocessor chips made by AMD and Cyrix. In this document, the term "x86" refers to the overall platform architecture, whereas "Intel Platform Edition" appears in the product name.

Access to Sun WorkShop Development Tools

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 containing /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.
Note – The information in this section assumes that your Sun WorkShop 6 products were installed in the /opt directory. Contact your system administrator if your Sun WorkShop software is not installed in /opt.

The PATH and MANPATH variables should be set in your home .cshrc file if you are using the C shell or in your home .profile file if you are using the Bourne or Korn shells:

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

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

Chapter 1, "Introduction to Sun WorkShop TeamWare," provides a full introduction to the Sun WorkShop TeamWare product.

Chapter 2, "Managing Workspaces," presents step-by-step instructions on how to create and manage workspace.

Chapter 3, "Advanced Workspace Management," provides step-by-step instructions on how to customize Configuring and perform more advanced tasks on workspaces.

Chapter 4, "Controlling Workspace Access," provides step-by-step instructions on how to grant or deny permission to perform workspace transactions.

Chapter 5, "Managing Files," provides step-by-step instructions on how to check out and put back files.

Chapter 6, "Resolving Differences Between Files," provides step-by-step instructions on how to resolve the differences between files in the Merging tool.

Chapter 7, "Advanced File Management," provides step-by-step instructions on how to view file history, move or rename files, and customize Versioning.

Chapter 8, "Using Freezepointing," provides step-by-step instructions on how to create and use freezepoints.

Chapter 9, "Building Programs in Sun WorkShop TeamWare," provides step-by-step instructions on how to build specific targets, as well as hints on fixing build errors.

Chapter 10, "Using the dmake Utility," describes dmake, a tools that allows you to distribute builds over several hosts concurrently. The operation of dmake is described, and instructions given on how to distribute your build efficiently.

Chapter 11, "Sun WorkShop TeamWare Shortcuts," provides information on how to use Sun WorkShop TeamWare commands at the command line, and also lists mouse and keyboard shortcuts.

Chapter 12, "Sun WorkShop TeamWare Architecture," lists metadata files, describes how Configuring manipulates SCCS history files during file transfer transactions, and explains SCCS Mergeable IDs (SMIDs) and SCCS delta IDS (SIDs).

Appendix A, "Error and Warning Messages," lists error messages and warnings. Each message is defined, and a possible solution is provided.

The Glossary provides an explanation of the special terms used in this manual.

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.

Shell Prompts

TABLE P-2 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 %

Bourne shell and Korn shell $

C shell, Bourne shell, and Korn shell superuser #

Related Documentation

You can access documentation related to the subject matter of this book in the following ways:

Through the Internet at the docs.sun.com^sm Web site. You can search for a specific book title or you can browse by subject, document collection, or product at the following Web site:

http://docs.sun.com

Through the installed Sun WorkShop products on your local system or network. Sun WorkShop 6 HTML documents (manuals, online help, man pages, component readme files, and release notes) are available with your installed Sun WorkShop 6 products. To access the HTML documentation, do one of the following:

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

/opt/SUNWspro/docs/index.html

Contact your system administrator if your Sun WorkShop software is not installed in the /opt directory. Your browser displays an index of Sun WorkShop 6 HTML documents. To open a document in the index, click the document's title.

TABLE P-3 lists related Sun WorkShop 6 manuals by document collection.

TABLE P-3   Related Sun WorkShop 6 Documentation by Document Collection
Document Collection Document Title Description

Forte^TM Developer 6 / Sun WorkShop 6 Release Documents About Sun WorkShop 6 Documentation Describes the documentation available with this Sun WorkShop release and how to access it.

What's New in Sun WorkShop 6 Provides information about the new features in the current and previous release of Sun WorkShop.

Sun WorkShop 6 Release Notes Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.

Forte Developer 6 / Sun WorkShop 6 Analyzing Program Performance With Sun WorkShop 6 Explains how to use the new Sampling Collector and Sampling Analyzer (with examples and a discussion of advanced profiling topics) and includes information about the command-line analysis tool er_print, the LoopTool and LoopReport utilities, and UNIX profiling tools prof, gprof, and tcov.

Debugging a Program With dbx Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.

Introduction to Sun WorkShop Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.

Forte^TM C 6 / Sun WorkShop 6 Compilers C C User's Guide Describes the C compiler options, Sun-specific capabilities such as pragmas, the lint tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.

Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++ C++ Library Reference Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.

C++ Migration Guide Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.

C++ Programming Guide Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.

C++ User's Guide Provides information on command-line options and how to use the compiler.

Sun WorkShop Memory Monitor User's Manual Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see /opt/SUNWspro/docs/index.html) and not at the docs.sun.com Web site.

Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95 Fortran Library Reference Provides details about the library routines supplied with the Fortran compiler.

Fortran Programming Guide Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.

Fortran User's Guide Provides information on command-line options and how to use the compilers.

FORTRAN 77 Language Reference Provides a complete language reference.

Interval Arithmetic Programming Reference Describes the intrinsic INTERVAL data type supported by the Fortran 95 compiler.

Forte^TM TeamWare 6 / Sun WorkShop TeamWare 6 Sun WorkShop TeamWare User's Guide Describes how to use the Sun WorkShop TeamWare code management tools.

Forte Developer 6/ Sun WorkShop Visual 6 Sun WorkShop Visual User's Guide Describes how to use Visual to create C++ and Java^TM graphical user interfaces.

Forte^TM / Sun Performance Library 6 Sun Performance Library Reference Discusses the optimized library of subroutines and functions used to perform computational linear algebra and fast Fourier transforms.

Sun Performance Library User's Guide Describes how to use the Sun-specific features of the Sun Performance Library, which is a collection of subroutines and functions used to solve linear algebra problems.

Numerical Computation Guide Numerical Computation Guide Describes issues regarding the numerical accuracy of floating-point computations.

Standard Library 2 Standard C++ Class Library Reference Provides details on the Standard C++ Library.

Standard C++ Library User's Guide Describes how to use the Standard C++ Library.

Tools.h++ 7 Tools.h++ Class Library Reference Provides details on the Tools.h++ class library.

Tools.h++ User's Guide Discusses use of the C++ classes for enhancing the efficiency of your programs.

TABLE P-4 describes related Solaris documentation available through the docs.sun.com Web site.

TABLE P-4   Related Solaris Documentation
Document Collection Document Title Description

Solaris Software Developer Linker and Libraries Guide Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.

Programming Utilities Guide Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

`%` `echo $PATH`

`%` `man workshop`

**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.

**TABLE P-2** Shell Prompts
Shell	Prompt
C shell	`%`
Bourne shell and Korn shell	`$`
C shell, Bourne shell, and Korn shell superuser	`#`

**TABLE P-3** Related Sun WorkShop 6 Documentation by Document Collection
Document Collection	Document Title	Description
Forte^TM Developer 6 / Sun WorkShop 6 Release Documents	About Sun WorkShop 6 Documentation	Describes the documentation available with this Sun WorkShop release and how to access it.
	What's New in Sun WorkShop 6	Provides information about the new features in the current and previous release of Sun WorkShop.
	Sun WorkShop 6 Release Notes	Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.
Forte Developer 6 / Sun WorkShop 6	Analyzing Program Performance With Sun WorkShop 6	Explains how to use the new Sampling Collector and Sampling Analyzer (with examples and a discussion of advanced profiling topics) and includes information about the command-line analysis tool `er_print`, the LoopTool and LoopReport utilities, and UNIX profiling tools `prof`, `gprof`, and `tcov`.
	Debugging a Program With dbx	Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.
	Introduction to Sun WorkShop	Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.
Forte^TM C 6 / Sun WorkShop 6 Compilers C	C User's Guide	Describes the C compiler options, Sun-specific capabilities such as pragmas, the `lint` tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.
Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++	C++ Library Reference	Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.
	C++ Migration Guide	Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.
	C++ Programming Guide	Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.
	C++ User's Guide	Provides information on command-line options and how to use the compiler.
	Sun WorkShop Memory Monitor User's Manual	Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see `/opt/SUNWspro/docs/index.html`) and not at the `docs.sun.com` Web site.
Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95	Fortran Library Reference	Provides details about the library routines supplied with the Fortran compiler.
	Fortran Programming Guide	Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.
	Fortran User's Guide	Provides information on command-line options and how to use the compilers.
	FORTRAN 77 Language Reference	Provides a complete language reference.
	Interval Arithmetic Programming Reference	Describes the intrinsic `INTERVAL` data type supported by the Fortran 95 compiler.
Forte^TM TeamWare 6 / Sun WorkShop TeamWare 6	Sun WorkShop TeamWare User's Guide	Describes how to use the Sun WorkShop TeamWare code management tools.
Forte Developer 6/ Sun WorkShop Visual 6	Sun WorkShop Visual User's Guide	Describes how to use Visual to create C++ and Java^TM graphical user interfaces.
Forte^TM / Sun Performance Library 6	Sun Performance Library Reference	Discusses the optimized library of subroutines and functions used to perform computational linear algebra and fast Fourier transforms.
	Sun Performance Library User's Guide	Describes how to use the Sun-specific features of the Sun Performance Library, which is a collection of subroutines and functions used to solve linear algebra problems.
Numerical Computation Guide	Numerical Computation Guide	Describes issues regarding the numerical accuracy of floating-point computations.
Standard Library 2	Standard C++ Class Library Reference	Provides details on the Standard C++ Library.
	Standard C++ Library User's Guide	Describes how to use the Standard C++ Library.
Tools.h++ 7	Tools.h++ Class Library Reference	Provides details on the `Tools.h++` class library.
	Tools.h++ User's Guide	Discusses use of the C++ classes for enhancing the efficiency of your programs.

**TABLE P-4** Related Solaris Documentation
Document Collection	Document Title	Description
Solaris Software Developer	Linker and Libraries Guide	Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.
	Programming Utilities Guide	Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

Library | Contents | Previous | Next | Index