Man Page workshop.1




NAME

     workshop - An Integrated Programming Environment


SYNOPSIS

     workshop [ standard motif toolkit options ]  [  -D  a.out  [
     core  |  pid  ]  ]  [ -s editsessionname ] [ -x sessionfile-
     directory ] [ -V ] [ projectname ]


AVAILABILITY

     Available   on   the   Solaris(TM)   operating   environment
     (SPARC(TM)  Platform  Edition)  and  the  Solaris  operating
     environment (Intel Platform Edition) versions 2.6, 7, and  8
     running CDE or OpenWindows(TM).


DESCRIPTION

     The  Sun  WorkShop(TM)  integrated  programming  environment
     allows you to edit, build, debug, analyze, and browse a pro-
     gram without having to  explicitly  start  individual  tools
     from the command line.

     To change your integrated text  editor,  choose  Options  ->
     Text  Editor Options from the main window and select an edi-
     tor in the Text Editor Options dialog box.


OPTIONS

     workshop accepts all standard  Motif  Toolkit  command  line
     options.  In addition, the following options are accepted:

     -D a.out [core|pid]
          Run the Sun WorkShop integrated programming environment
          and  start  a debugging session. If a.out is specified,
          load this program into the Debugging window. If core is
          specified,  the  Debugging  window  will  use  it to do
          post-mortem debugging on a.out. If  pid  is  specified,
          the  Debugging  window  will attach to the process with
          the given process id. In this  case  you  can  use  "-"
          instead  of  a.out  but then the executable information
          will not be stored in project cache picklists.

     -s editsessionname
          Run the Sun WorkShop tools under the edit server  named
          editsessionname.  If  there  is no edit server with the
          given name, the  Sun  WorkShop  integrated  programming
          environment  will  start  one.  If  this  option is not
          specified (the default), Sun WorkShop tools  share  the
          same editor.

     -x sessionfile-directory
          Read and write Sun WorkShop session files .workshop* in
          the specified directory rather than the home directory.
          Allows multiple configurations.

     -V   Display the Sun WorkShop  version  string  on  standard
          output.

     projectname
          Load  the  specified  project  into  the  Sun  WorkShop
          integrated programming environment.


Starting From a Shell

     To start the Sun WorkShop integrated  programmming  environ-
     ment from a shell, type workshop & at the command prompt.


Starting From the Emacs Editor

     You  can  start  the  Sun  WorkShop  integrated  programming
     environment  directly  from  the  editor  without  having to
     return to the command line. When you exit from  Emacs,  both
     the Sun WorkShop windows and the Emacs window close.

     You  can  start  the  Sun  WorkShop  integrated  programming
     environment from the XEmacs editor in three ways:
     *  Type M-x workshop-start in the minibuffer.
     *  Choose Start Sun WorkShop from the Tools menu.
     *  Click on the WorkShop button in the tool bar.

     You can start Sun WorkShop from the GNU Emacs editor as fol-
     lows:

     1. Load workshop.el by setting the load path in your  .emacs
        file as follows:

        (setq load-path
          (append load-path '("/WorkShop-install-directory/lib")))
        (require 'workshop)

        and then restarting Emacs.

     2. Type M-x workshop-start or choose Start Sun WorkShop from
        the Tools menu.


Breaking the Sun WorkShop-Emacs Connection

     You can break the connection between Emacs and Sun  WorkShop
     tools with the command M-x workshop-quit, which will end the
     Sun WorkShop process and  continue  to  run  Emacs  (if  you
     started Sun WorkShop from Emacs).

     If you try to start Sun WorkShop from Emacs and Sun WorkShop
     does  not  connect  to the editor or does not appear at all,
     choose Quit WorkShop from the WorkShop menu to end  the  Sun
     WorkShop process.


Customizations

     Sun WorkShop windows  can  be  customized  by  changing  the
     default  X resource values. The X resource files for the Sun
     WorkShop integrated programming environment (named  WORKSHOP
     and ESERVE) can be found in the directory:

       wdir/WS6U2/lib/locale/LANG/app-defaults/CDE

     where:
     wdir is the directory where the Sun WorkShop software
          was installed, usually /opt/SUNWspro.
     LANG is your current locale, for example, C or ja.
     CDE is either CDE or non-CDE, depending on whether
          or not the Sun WorkShop integrated programming environ-
          ment is running in a CDE environment.

     You do not have to modify any of the resources in  order  to
     use  the  Sun  WorkShop  integrated programming environment.
     However, if you do want to make modifications, follow  these
     steps:

     1. Copy the X resource files to be  modified  to  your  home
        directory  or some other private directory on your XUSER-
        FILESEARCHPATH.

     2. Modify the resources you are interested in changing.  For
        example,  if  you  wish to change the background color of
        the push buttons to white, you would  set  the  following
        resource in the WORKSHOP resource file:

           WORKSHOP*XmPushButton*background: #FFFFFF

     By default, the Sun WorkShop integrated programming environ-
     ment  binds  Emacs  function  keys  to  commands  useful for
     interacting with Sun WorkShop tools.  You  can  disable  the
     key    rebinding    by   re-setting   the   Emacs   variable
     eserve-bind-fkeys. To do this, add  the  following  line  to
     your .emacs file:

       (setq eserve-bind-fkeys nil)


ENVIRONMENT

     SPRO_LAUNCH_EDITOR_FROM_PATH
          When launching XEmacs, the Sun WorkShop integrated pro-
          gramming  environment  first  looks  for  xemacs in the
          top-level bin directory of the Sun  WorkShop  installa-
          tion.  If  it cannot find xemacs there, it searches for
          xemacs using the  PATH  environment  variable.  Setting
          SPRO_LAUNCH_EDITOR_FROM_PATH  to any value disables the
          check for xemacs in the top-level bin directory of  the
          Sun WorkShop installation.

     SPRO_LAUNCH_TOOLS_FROM_PATH
          When launching tools from the main  window  toolbar  or
          from  the  Tools  menu,  the  Sun  WorkShop  integrated
          programming environment first looks for a binary in the
          top-level  bin  directory of the Sun WorkShop installa-
          tion. If it cannot find the binary there,  it  searches
          for  the  binary  using  the PATH environment variable.
          Setting SPRO_LAUNCH_TOOLS_FROM_PATH to any  value  dis-
          ables  the  check  for  the binary in the top-level bin
          directory of the Sun WorkShop installation.

     SPRO_DBX_PATH
          When launching  dbx,  use  this  path  instead  of  the
          default location.


SEE ALSO

     makeprd(1), dbx(1), analyzer(1), codemgr(1), teamware(1)

     The following Sun WorkShop documentation is available online
     through http://docs.sun.com:
     *  Introduction to Sun WorkShop
     *  Analyzing Program Performance With Sun WorkShop
     *  Debugging a Program With dbx
     *  Sun WorkShop TeamWare User's Guide