Preface

This purpose of this manual to help you become familiar with WorkShop by learning how to perform basic developing operations through WorkShop. In addition to the overview of WorkShop features, this guide show you how to:

Select a default text editor
Run a build job
Debug a program
Browse source code
Analyze performance data
Set some WorkShop resources

Who Should Use This Book

This manual is written for application developers who want to use the main development features of WorkShop. For a discussion of advanced programming topics, see WorkShop: Beyond the Basics. For a discussion of WorkShop features with command-line implementations, see WorkShop: Command-Line Utilities.

How This Book Is Organized

WorkShop: Getting Started contains the following chapters:

Chapter 1, "About Sun WorkShop," is an overview of the WorkShop programming environment. This chapter also highlights the components available in the various WorkShop products.

Chapter 2, "Starting Sun WorkShop," explains what you need to do to start developing in WorkShop, such as how to start WorkShop, how to select a text editor, and what WorkSets are and how to use them,

Chapter 3, "Building Programs in Sun Workshop," shows you how to build an application with WorkShop default settings or your own build settings, and how to fix build errors.

Chapter 4, "Debugging A Program," highlights the many debugging features offered in WorkShop, and explains how to debug in quick mode. Quick Mode allows you to run your program normally, but keeps debugging ready in the background to take over the process at any time.

Chapter 5, "Browsing Source Code," shows you how to use the Browsing window, the Call Grapher, the Class Grapher, and the Class Browser to examine source files, function call relationships, and class hierarchies.

Chapter 6, "Analyzing Program Performance," explains how to gather and examine the various types of data with the Behaviour Data Collector and the Analyzer to improve the performance of an application.

Chapter 7, "Merging Source Files," shows you how to compare different versions of a source file and merge the changes.

Appendix A, "Setting WorkShop Resources," shows you how to modify the some of the resource settings in WorkShop.

How to Get Help

This release of the WorkShop includes a new documentation delivery system as well as online manuals and video demonstrations. To find out more, you can start in any of the following places:

Online Help - A new help system containing extensive task-oriented, context-sensitive help. To access the help, choose Help Help Contents. Help menus are available in all WorkShop windows.
WorkShop Documentation - A complete set of online manuals. These manuals make up the complete documentation set for WorkShop and are available using AnswerBook^TM or using an HTML browser. To access the online manuals, choose Help WorkShop Manuals in the main WorkShop window.
Video Demonstrations - These demos provide a general overview of the WorkShop and describe how to use WorkShop to build targets or debug programs. To access them, choose Help Demos in the WorkShop main window.
Release Notes - The Release Notes contain general information about WorkShop and specific information about software limitations and bugs. To access the Release Notes, choose Help Release Notes.

How to Access the AnswerBook Documentation

To access the AnswerBook online documentation for WorkShop, you must run a script to set up your environment.

: 1. To start AnswerBook, type the following at a command prompt:

% workshop-answerbooks

The script sets the AB_CARDCATALOG environment variable and runs /usr/openwin/bin/answerbook. The AnswerBook Navigator opens and displays the available AnswerBook documents.

2. Add the WorkShop AnswerBook documents to your library by clicking the Modify Library button.

The AnswerBooks Navigator: Modify Library window is displayed.

3. Select the AnswerBook documents you wish to add to your library from the list; then click the Apply button.

The AnswerBook documents are added to your library.

4. To view an AnswerBook document, double-click on the title you wish to view.

Sun WorkShop Documentation

Available with all WorkShop products.


WorkShop Roadmap	(hard copy only) Provides a documentation map to the WorkShop printed and online documentation. Includes a complete list of the documentation included with your WorkShop.
WorkShop Installation and Licensing Guide	Provides instructions about product licensing and installation of Workshop products on Solaris^TM 2.x systems. Provides instructions for local or remote installation for single independent license servers, multiple independent license servers, and redundant license servers.
WorkShop Quick Install for Solaris	Provides quick installation instructions for product installation and licensing.
WorkShop: Getting Started	Provides a basic introduction. This book provides the information you need to use the basic WorkShop features.
WorkShop: Beyond the Basics	Contains information about the advanced programming, debugging, browsing, and visualization applications in the WorkShop product suite, including: DMake, LoopTool, Thread Analyzer, WorkShop Browsing, and WorkShop Visual.
WorkShop: Command-Line Utilities	Provides reference information for all of the workshop utilities that can be run directly from the command line, including Loop Report, LockLint Utilities, sbquery, and all the dbx commands.
Using XEmacs	(online only) Contains user-level information for XEmacs.
WorkShop Online Help	(online only) Contains extensive task-oriented information for all the tools included with the WorkShop
WorkShop Video Demonstrations	(online only) Three video demonstrations providing information about WorkShop building and debugging as well as general product information.
Release Notes	(online only) Contains any information that was too late to get into the other documentation. To access the Release Notes, open any Help menu and then click on Release Notes.
Manual Pages	(online only) Provide information about the WorkShop command-line utilities.

Sun WorkShop TeamWare Documentation

Available only with Performance WorkShop Fortran and Visual WorkShop C++.


Sun WorkShop TeamWare: User's Guide	Describes how to use all the tools in the TeamWare tool set, for both the command-line interface and the graphical user interface.
Sun WorkShop TeamWare: Solutions Guide	Provides an in-depth case study and eight scenario-based topics to help users take full advantage of TeamWare's features.
Sun WorkShop TeamWare: Online Help	Provides succinct task-oriented information to help you become familiar with the application. Help volume includes video overview.
Manual Pages	(online only) Provide information about the TeamWare command-line commands and utilities.

Sun Visual WorkShop C++ Documentation

Available only with Sun Visual WorkShop C++.


WorkShop documentation	Visual WorkShop C++ contains the entire WorkShop and TeamWare documentation sets.
C++ User's Guide	Describes how to use the Sun C++ compiler to write programs in C++. It covers the C++ compiler options, programs, templates, exception handling, and more. It is intended for the experienced C++ programmer.
C++ Library Reference	Describes how to use the complex, coroutine, and iostream libraries, and it lists the manual pages (man pages) for these libraries.
Tools.h++ User's Guide	Describes how to use the Tools.h++ libraries to make programs more efficient.
Tools.h++ Class Library Reference	Describes how to use the Tools.h++ class library, and also describes a set of C++ classes that can simplify programming while maintaining efficiency.
C++ 4.2 Quick Reference Card	Provides concise descriptions of the C++ compiler flags.
C User's Guide	Describes how to use the Sun ANSI C compiler to write programs in C. It covers the C compiler options, the pragmas, the lint tool, the cscope tool, and more. It is intended for the experienced C programmer.
Making the Transition to ANSI C	(online only) Provides information about the transition from K&R C to ANSI C.
C 4.2 Quick Reference Card	Provides concise descriptions of the C compiler flags.
WorkShop: Visual User's Guide	Explains how to use Visual, an interactive tool for building graphical user interfaces (GUIs) using the widgets of the standard OSF/Motif toolkit or Microsoft Foundation Class. It includes a tutorial as well as reference information for the more advanced user.
Sun WorkShop 2.0 Visual Quick Reference Card	Contains menu shortcuts and icon explanations for Visual.
Numerical Computation Guide	Describes the floating-point software and hardware for the SPARC^TM, Intel, HP 700, and PowerPC system architectures. It also contains a tutorial on floating-point arithmetic.
Incremental Link Editor	Describes how to use `ild` as an incremental linker to replace `ld` for linking programs. `ild` allows you to complete the development sequence more quickly than is possible with a standard linker.
Performance Profiling Tools	Describes the `prof`(1), `gprof`(1), and `tcov`(1) utilities
Manual Pages	(online only) Provides information about the command-line commands and utilities included with Visual WorkShop C++.

Sun Performance WorkShop Fortran Documentation

Available only with Sun Performance WorkShop Fortran.


WorkShop documentation	Performance WorkShop Fortran contains the entire WorkShop and TeamWare documentation sets.
Fortran User's Guide	Describes how to use the Sun Fortran 77 4.0 and Fortran 90 1.2 compilers, including the compiler command options, debugging and development tools, program profiling and performance tuning, mixing C and Fortran, and making and using libraries. It is intended for programmers with knowledge of Fortran.
FORTRAN 77 Language Reference	Describes and defines the Fortran 77 language accepted by the Sun `f77` compiler under Solaris 1.x and 2.x. It is intended for use by programmers with knowledge of and experience with Fortran.
Fortran Programmer's Guide	Provides the essential information programmers need to develop efficient applications using the Fortran 77 and Fortran 90 compilers. Includes information on input/output, program development, use and creation of software libraries, program analysis and debugging, numerical accuracy, porting, performance, optimization, parallelization, and the C/Fortran interface.
Fortran Library Reference	(online only) Describes the language and routines of the Fortran compilers.
Sun Performance Library 1.2 Quick Reference Card	Provides a quick reference to Sun Performance Library language routines with brief descriptions.
Fortran 90 Handbook	(online only) Contains user-level information about this release of Fortran90.
Fortran 90 Browser	Describes how to use the Sun Fortran 90 Browser, one of the development tools in the `f90` package, to view Fortran 90 source code. It is intended for programmers with knowledge of Fortran 90.
Fortran Quick Reference Card	Lists the `f77` 4.0 compiler's command-line options with brief descriptions.
C User's Guide	Describes how to use the Sun ANSI C compiler to write programs in C. It covers the C compiler options, the pragmas, the lint tool, the cscope tool, and more. It is intended for the experienced C programmer.
Making the Transition to ANSI C	(online only) Provides information about the transition from K&R C to ANSI C.
C 4.2 Quick Reference Card	Describes the C compiler options in a concise and easy-to-read format.
Numerical Computation Guide	Describes the floating-point software and hardware for the SPARC^TM, Intel, HP 700, and PowerPC system architectures. It also contains a tutorial on floating-point arithmetic.
Incremental Link Editor	Describes how to use `ild` as an incremental linker to replace `ld` for linking programs. `ild` allows you to complete the development sequence more quickly than is possible with a standard linker.
Performance Profiling Tools	Describes the `prof`(1), `gprof`(1), and `tcov`(1) utilities.
Manual Pages	(online only) Provide information about the Fortran command-line commands and utilities included with Performance WorkShop Fortran.

Sun WorkShop Professional Pascal Documentation

Available only with Sun WorkShop Professional Pascal.


WorkShop documentation	WorkShop Professional Pascal contains the entire WorkShop documentation set.
Pascal User's Guide	Describes how to begin writing and compiling Pascal programs for the Solaris computing environment. Pascal is a derivative of the Berkeley Pascal system distributed with UNIX®4.2 BSD. It complies with FIPS PUB 109 ANSI/IEEE 770 X3.97-1983 and BS6192/ISO7185 at both level 0 and level 1, and it includes many extensions to the standard.
Pascal Language Reference	Provides reference material for the Pascal 4.0 compiler, an implementation of the Pascal language that includes all the standard language elements and many extensions. Pascal 4.0 contains a compiler switch, `-xl`, to provide compatibility with Apollo DOMAIN Pascal to ease the task of porting your Apollo Pascal applications to workstations.
Pascal 4.2 Quick Reference Card	Lists all of the Pascal 4.2 compiler options with a brief, one-line description of each option.
Numerical Computation Guide	Describes the floating-point software and hardware for the SPARC^TM, Intel, HP 700, and PowerPC system architectures. It also contains a tutorial on floating-point arithmetic.
Incremental Link Editor	Describes how to use `ild` as an incremental linker to replace `ld` for linking programs. `ild` allows you to complete the development sequence more quickly than is possible with a standard linker.
Performance Profiling Tools	Describes the `prof`(1), `gprof`(1), and `tcov`(1) utilities.
Manual Pages	(online only) Provide information about the command-line commands and utilities included with WorkShop Professional Pascal.

Sun WorkShop Professional C Documentation

Available with Sun WorkShop Professional C only.


WorkShop documentation	WorkShop Professional C contains the entire WorkShop documentation set.
C User's Guide	Describes how to use the Sun ANSI C compiler to write programs in C. It covers the C compiler options, the pragmas, the lint tool, the cscope tool, and more. It is intended for the experienced C programmer.
Making the Transition to ANSI C	(online only) Provides information about the transition from K&R C to ANSI C.
C 4.2 Quick Reference Card	Describes the C compiler options in a concise and easy-to-read format.
Numerical Computation Guide	Describes the floating-point software and hardware for the SPARC^TM, x86, HP 700 and PowerPC system architectures. It also contains a tutorial on floating-point arithmetic.
Incremental Link Editor	Describes how to use `ild` as an incremental linker to replace `ld` for linking programs. `ild` allows you to complete the development sequence more quickly than is possible with a standard linker.
Performance Profiling Tools	Describes the `prof`(1), `gprof`(1), and `tcov`(1) utilities.
Manual Pages	(online only) Provides information about the command-line commands and utilities included with WorkShop Professional C.

Ordering Additional Hardcopy Documentation

You can order additional copies of the hard copy documentation by calling SunExpress at 1-800-USE-SUNX or visiting their web page at

http://sunexpress.usec.sun.com

Sun on the World Wide Web

World Wide Web (WWW) users can view Sun's Developer Products site at the following URL:

http://www.sun.com/developer-products/index.html

This area is updated regularly and contains helpful information, including current release and configuration tables, special programs, and success stories.

What Typographic Changes Mean

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

The following table describes the typographic changes used in this book.Table P-1 Typographic Conventions Typeface or Symbol Meaning Example AaBbCc123 The names of commands, files, and directories; on-screen computer output Edit your .login file. Use ls -a to list all files. machine_name% You have mail. AaBbCc123 What you type, contrasted with on-screen computer output machine_name% su Password: AaBbCc123 Command-line placeholder: replace with a real name or value To delete a file, type rm filename. AaBbCc123 Book titles, new words or terms, or words to be emphasized Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.

Shell Prompts in Command Examples

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	`#`

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 #