1*workshop.txt*  For Vim version 7.3.  Last change: 2010 Jul 20
2
3
4		  VIM REFERENCE MANUAL    by Gordon Prieur
5
6
7Sun Visual WorkShop Features			*workshop* *workshop-support*
8
91. Introduction						|workshop-intro|
102. Commands						|workshop-commands|
113. Compiling vim/gvim for WorkShop			|workshop-compiling|
124. Configuring gvim for a WorkShop release tree		|workshop-configure|
135. Obtaining the latest version of the XPM library	|workshop-xpm|
14
15{Vi does not have any of these features}
16{only available when compiled with the |+sun_workshop| feature}
17
18==============================================================================
191. Introduction						*workshop-intro*
20
21Sun Visual WorkShop has an "Editor of Choice" feature designed to let users
22debug using their favorite editors.  For the 6.0 release we have added support
23for gvim.  A workshop debug session will have a debugging window and an editor
24window (possibly others as well).  The user can do many debugging operations
25from the editor window, minimizing the need to switch from window to window.
26
27The version of vim shipped with Sun Visual WorkShop 6 (also called Forte
28Developer 6) is vim 5.3.  The features in this release are much more reliable
29than the vim/gvim shipped with Visual WorkShop.  VWS users wishing to use vim
30as their editor should compile these sources and install them in their
31workshop release tree.
32
33==============================================================================
342. Commands						*workshop-commands*
35
36						*:ws* *:wsverb*
37:ws[verb] verb			Pass the verb to the verb executor
38
39Pass the verb to a workshop function which gathers some arguments and
40sends the verb and data to workshop over an IPC connection.
41
42==============================================================================
433. Compiling vim/gvim for WorkShop			*workshop-compiling*
44
45Compiling vim with FEAT_SUN_WORKSHOP turns on all compile time flags necessary
46for building a vim to work with Visual WorkShop.  The features required for VWS
47have been built and tested using the Sun compilers from the VWS release.  They
48have not been built or tested using Gnu compilers.  This does not mean the
49features won't build and run if compiled with gcc, just that nothing is
50guaranteed with gcc!
51
52==============================================================================
534. Configuring gvim for a WorkShop release tree		*workshop-configure*
54
55There are several assumptions which must be met in order to compile a gvim for
56use with Sun Visual WorkShop 6.
57
58    o You should use the compiler in VWS rather than gcc.  We have neither
59      built nor tested with gcc and cannot guarantee it will build properly.
60
61    o You must supply your own XPM library.  See |workshop-xpm| below for
62      details on obtaining the latest version of XPM.
63
64    o Edit the Makefile in the src directory and uncomment the lines for Sun
65      Visual WorkShop.  You can easily find these by searching for the string
66      FEAT_SUN_WORKSHOP
67
68    o We also suggest you use Motif for your gui.  This will provide gvim with
69      the same look-and-feel as the rest of Sun Visual WorkShop.
70
71The following configuration line can be used to configure vim to build for use
72with Sun Visual WorkShop:
73
74    $ CC=cc configure --enable-workshop --enable-gui=motif \
75	-prefix=<VWS-install-dir>/contrib/contrib6/<vim-version>
76
77The VWS-install-dir should be the base directory where your Sun Visual WorkShop
78was installed.  By default this is /opt/SUNWspro.  It will normally require
79root permissions to install the vim release.  You will also need to change the
80symlink <VWS-install-dir>/bin/gvim to point to the vim in your newly installed
81directory.  The <vim-version> should be a unique version string.  I use "vim"
82concatenated with the equivalent of version.h's VIM_VERSION_SHORT.
83
84==============================================================================
855. Obtaining the latest version of the XPM library	*workshop-xpm*
86
87The XPM library is required to show images within Vim with Motif or Athena.
88Without it the toolbar and signs will be disabled.
89
90The XPM library is provided by Arnaud Le Hors of the French National Institute
91for Research in Computer Science and Control.  It can be downloaded from
92http://cgit.freedesktop.org/xorg/lib/libXpm.  The current release, as of this
93writing, is xpm-3.4k-solaris.tgz, which is a gzip'ed tar file.  If you create
94the directory /usr/local/xpm and untar the file there you can use the
95uncommented lines in the Makefile without changing them.  If you use another
96xpm directory you will need to change the XPM_DIR in src/Makefile.
97
98 vim:tw=78:ts=8:ft=help:norl:
99