annotate runtime/doc/workshop.txt @ 85:fc244e0a6e7e

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