/
README.csupport
230 lines (163 loc) · 9.08 KB
/
README.csupport
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
README for c.vim (Version 5.13) / January 21 2011
* DESCRIPTION
* INSTALLATION
* RELEASE NOTES
* FILES
* ADDITIONAL TIPS
* CREDITS
================================================================================
DESCRIPTION
================================================================================
C/C++-IDE for Vim/gVim. It is written to considerably speed up writing code in
a consistent style. This is done by inserting complete statements, idioms,
code snippets, templates, and comments. Syntax checking, compiling, running a
program, running indent or code checkers can be done with a keystroke. There
are many additional hints and options which can improve speed and comfort when
writing C/C++. See the help file csupport.txt for more information.
================================================================================
INSTALLATION
================================================================================
(1) LINUX
----------
The subdirectories in the zip archive cvim.zip mirror the directory structure
which is needed below the local installation directory $HOME/.vim/ (find the
value of $HOME with ":echo $HOME" from inside Vim).
(1.0) Save the template files in '$HOME/.vim/c-support/templates/Templates' if
you have changed any of them.
(1.1) Copy the zip archive cvim.zip to $HOME/.vim and run
unzip cvim.zip
If you have already an older version of c-support and you have modified
the template files you may want to save your templates first and suppress
overwriting them with
unzip cvim.zip -x *Templates *.template
(1.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
This is the minimal content of the file '$HOME/.vimrc'. Create one if there
is none or use the files in $HOME/.vim/c-support/rc as a starting point.
(1.3) Set at least some personal details in the file
'$HOME/.vim/c-support/templates/Templates'
Here is the minimal personalization (my settings as an example):
|AUTHOR| = Dr. Fritz Mehner
|AUTHORREF| = fgm
|EMAIL| = mehner@fh-swf.de
|COMPANY| = FH Südwestfalen, Iserlohn
|COPYRIGHT| = Copyright (c) |YEAR|, |AUTHOR|
(Read more about the template system in the plugin documentation)
(1.4) Consider additional settings in the file '$HOME/.vimrc'. The files
customization.vimrc and customization.gvimrc are replacements or extensions
for your .vimrc and .gvimrc. You may want to use parts of them. The files
are documented.
(2) WINDOWS
------------
The subdirectories in the zip archive cvim.zip mirror the directory structure
which is needed below the local installation directory $HOME/vimfiles/ (find
the value of $HOME with ":echo $HOME" from inside Vim).
(2.0) Save the template files in '$HOME/vimfiles/c-support/templates/Templates' if
you have changed any of them.
(2.1) Copy the zip archive cvim.zip to $HOME/vimfiles and run
unzip cvim.zip
If you have already an older version of c-support and you have modified
the template files you may want to save your templates first and suppress
overwriting them with
unzip cvim.zip -x *Templates *.template
(2.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
This is the minimal content of the file '$HOME/_vimrc'. Create one if there
is none or use the files in $HOME/vimfiles/c-support/rc as a starting point.
(2.3) Set at least some personal details in the file
'$HOME/vimfiles/c-support/templates/Templates'
Here is the minimal personalization (my settings as an example):
|AUTHOR| = Dr. Fritz Mehner
|AUTHORREF| = fgm
|EMAIL| = mehner@fh-swf.de
|COMPANY| = FH Südwestfalen, Iserlohn
|COPYRIGHT| = Copyright (c) |YEAR|, |AUTHOR|
(Read more about the template system in the plugin documentation)
(2.4) Consider additional settings in the file '$HOME/_vimrc'. The files
customization.vimrc and customization.gvimrc are replacements or extensions
for your _vimrc and _gvimrc. You may want to use parts of them. The files
are documented.
There are a lot of features and options which can be used and influenced:
* use of template files and tags
* surround marked blocks with statements
* using and managing personal code snippets
* generate/remove multiline comments
* picking up prototypes
* C/C++ dictionaries for keyword completion
* (re)moving the root menu
Restart gVim/Vim generate the help tags
:helptags ~/.vim/doc
and look at csupport help with
:help csupport
or use the 'help' item in the root menu of this plug-in.
+-----------------------------------------------+
| +-------------------------------------------+ |
| | ** PLEASE READ THE DOCUMENTATION ** | |
| | Actions differ for different modes! | |
| +-------------------------------------------+ |
+-----------------------------------------------+
Any problems ? See the TROUBLESHOOTING section at the end of the help file
'doc/csupport.txt'.
================================================================================
RELEASE NOTES FOR VERSION 5.13
================================================================================
- New hotkeys \rmc (run 'make clean') and \rme (executable to run).
- Hotkeys for make are working when in a makefile.
- Linker errors and errors during a make will be shown in a quickfix buffer.
- Bugfix: detection of a systemwide installation can fail.
- Bugfix: preprocessor directive '#if 0 #endif' not working.
OLDER RELEASE NOTES : see file 'ChangeLog'
================================================================================
FILES
================================================================================
README.csupport This file.
doc/csupport.txt The help file for the local on-line help.
ftplugin/c.vim A file type plug-in. Define hotkeys, creates a
local dictionary for each C/C++ file.
ftplugin/make.vim Access hotkeys for make(1) in makefiles.
plugin/c.vim The C/C++ plug-in for GVIM.
c-support/scripts/wrapper.sh The wrapper script for the use of a xterm.
c-support/templates/* C-style and C++-style template files
(see csupport.txt on how to adapt the templates).
c-support/wordlists/c-c++-keywords.list All C and C++ keywords (also in word.list).
c-support/wordlists/k+r.list K&R-Book: Words from the table of content.
They appear frequently in comments.
c-support/wordlists/stl_index.list STL: method and type names.
-------------------------- ---------------------------------------------------
The following files and extensions are for
convenience only. c.vim will work without them.
---------------------------------------------------
c-support/doc/c-hotkeys.pdf Hotkey reference card.
c-support/doc/ChangeLog The change log.
rc/customization.ctags Additional settings I use in .ctags to enable
navigation through makefiles ans qmake files with
the plug-in taglist.vim.
rc/customization.gvimrc Additional settings I use in .gvimrc :
hot keys, mouse settings, ... The file is
commented. Append it to your .gvimrc if you like.
rc/customization.indent.pro Additional settings I use in .indent.pro :
See the indent manual.
rc/customization.vimrc Additional settings I use in .vimrc : incremental
search, tabstop, hot keys, font, use of
dictionaries, ... The file is commented. Append
it to your .vimrc if you like.
================================================================================
CREDITS
================================================================================
Some ideas are taken from the following documents:
1. Recommended C Style and Coding Standards (Indian Hill Style Guide)
www.doc.ic.ac.uk/lab/secondyear/cstyle/cstyle.html
2. Programming in C++, Ellemtel Telecommunication Systems Laboratories
www.it.bton.ac.uk/burks/burks/language/cpp/cppstyle/ellhome.htm
3. C++ Coding Standard, Todd Hoff
www.possibility.com/Cpp/CppCodingStandard.html
The splint error format is taken from the file splint.vim (Vim standard
distribution).
------------------
... finally
Johann Wolfgang von Goethe (1749-1832), the greatest of the German poets,
about LINUX, Vim/gVim and other great tools (Ok, almost.) :
Ein Mann, der recht zu wirken denkt, Who on efficient work is bent,
Muß auf das beste Werkzeug halten. Must choose the fittest instrument.
Faust, Teil 1, Vorspiel auf dem Theater Faust, Part 1, Prologue for the Theatre
================================================================================