1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
4 | %general-entities;
|
---|
5 | ]>
|
---|
6 | <sect1 id="ch-system-vim" role="wrap">
|
---|
7 | <title>Vim-&vim-version;</title>
|
---|
8 | <?dbhtml filename="vim.html"?>
|
---|
9 |
|
---|
10 | <indexterm zone="ch-system-vim"><primary sortas="a-Vim">Vim</primary></indexterm>
|
---|
11 |
|
---|
12 | <sect2 role="package"><title/>
|
---|
13 | <para>The Vim package contains a powerful text editor.</para>
|
---|
14 |
|
---|
15 | <segmentedlist>
|
---|
16 | <segtitle>&buildtime;</segtitle>
|
---|
17 | <segtitle>&diskspace;</segtitle>
|
---|
18 | <seglistitem><seg>0.4 SBU</seg><seg>34 MB</seg></seglistitem>
|
---|
19 | </segmentedlist>
|
---|
20 |
|
---|
21 | <segmentedlist>
|
---|
22 | <segtitle>Vim installation depends on</segtitle>
|
---|
23 | <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
|
---|
24 | GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
|
---|
25 | </segmentedlist>
|
---|
26 |
|
---|
27 | <tip>
|
---|
28 | <title>Alternatives to Vim</title>
|
---|
29 | <para>If you prefer another editor—such as Emacs, Joe, or
|
---|
30 | Nano—please refer to <ulink url="&blfs-root;view/svn/postlfs/editors.html"/>
|
---|
31 | for suggested installation instructions.</para>
|
---|
32 | </tip>
|
---|
33 | </sect2>
|
---|
34 |
|
---|
35 | <sect2 role="installation">
|
---|
36 | <title>Installation of Vim</title>
|
---|
37 |
|
---|
38 | <para>First, unpack both
|
---|
39 | <filename>vim-&vim-version;.tar.bz2</filename> and (optionally)
|
---|
40 | <filename>vim-&vim-version;-lang.tar.gz</filename> archives into the
|
---|
41 | same directory. Then, change the default locations of the
|
---|
42 | <filename>vimrc</filename> and <filename>gvimrc</filename>
|
---|
43 | configuration files to <filename
|
---|
44 | class="directory">/etc</filename>:</para>
|
---|
45 |
|
---|
46 | <screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' >> src/feature.h
|
---|
47 | echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' >> src/feature.h</userinput></screen>
|
---|
48 |
|
---|
49 | <para>Vim has a security vulnerability already addressed upstream. The
|
---|
50 | following patch fixes the problem:</para>
|
---|
51 |
|
---|
52 | <screen><userinput>patch -Np1 -i ../vim-&vim-version;-security_fix-1.patch</userinput></screen>
|
---|
53 |
|
---|
54 | <para>Now prepare Vim for compilation:</para>
|
---|
55 |
|
---|
56 | <screen><userinput>./configure --prefix=/usr --enable-multibyte</userinput></screen>
|
---|
57 |
|
---|
58 | <para>The optional but highly recommended
|
---|
59 | <parameter>--enable-multibyte</parameter> switch includes support for
|
---|
60 | editing files in multibyte character encodings into
|
---|
61 | <command>vim</command>. This is needed if using a locale with
|
---|
62 | a multibyte character set. This switch is also helpful to be able to
|
---|
63 | edit text files initially created in Linux distributions like Fedora
|
---|
64 | Core that use UTF-8 as a default character set.</para>
|
---|
65 |
|
---|
66 | <para>Compile the package:</para>
|
---|
67 |
|
---|
68 | <screen><userinput>make</userinput></screen>
|
---|
69 |
|
---|
70 | <beginpage/>
|
---|
71 | <para>To test the results, issue:
|
---|
72 | <userinput>make test</userinput>. However, this test suite outputs a
|
---|
73 | lot of chaotic characters to the screen, which can cause issues with
|
---|
74 | the settings of the current terminal. Therefore, running the test
|
---|
75 | suite here is optional.</para>
|
---|
76 |
|
---|
77 | <para>Install the package:</para>
|
---|
78 |
|
---|
79 | <screen><userinput>make install</userinput></screen>
|
---|
80 |
|
---|
81 | <para>Many users are used to using <command>vi</command> instead of
|
---|
82 | <command>vim</command>. To allow execution of <command>vim</command>
|
---|
83 | when users habitually enter <command>vi</command>, create a
|
---|
84 | symlink:</para>
|
---|
85 |
|
---|
86 | <screen><userinput>ln -s vim /usr/bin/vi</userinput></screen>
|
---|
87 |
|
---|
88 | <para>If the X Window System is going to be installed on the LFS
|
---|
89 | system, it may be necessary to recompile Vim after installing X. Vim
|
---|
90 | comes with a GUI version of the editor that requires X and some
|
---|
91 | additional libraries to be installed. For more information on this
|
---|
92 | process, refer to the Vim documentation and the Vim installation page
|
---|
93 | in the BLFS book at <ulink
|
---|
94 | url="&blfs-root;view/svn/postlfs/editors.html#postlfs-editors-vim"/>.</para>
|
---|
95 |
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 id="conf-vim" role="configuration"><title>Configuring Vim</title>
|
---|
99 | <indexterm zone="conf-vim"><primary sortas="e-/etc/vim">/etc/vim</primary></indexterm>
|
---|
100 |
|
---|
101 | <para>By default, <command>vim</command> runs in vi-incompatible mode.
|
---|
102 | This may be new to users who have used other editors in the past. The
|
---|
103 | <quote>nocompatible</quote> setting is included below to highlight the
|
---|
104 | fact that a new behavior is being used. It also reminds those who
|
---|
105 | would change to <quote>compatible</quote> mode that it should appear
|
---|
106 | first. This is necessary because it changes other settings, and
|
---|
107 | overrides must come after this setting. Create a default <command>vim</command>
|
---|
108 | configuration file by running the following:</para>
|
---|
109 |
|
---|
110 | <screen><userinput>cat > /etc/vimrc << "EOF"
|
---|
111 | <literal>" Begin /etc/vimrc
|
---|
112 |
|
---|
113 | set nocompatible
|
---|
114 | set backspace=2
|
---|
115 | syntax on
|
---|
116 | if (&term == "iterm") || (&term == "putty")
|
---|
117 | set background=dark
|
---|
118 | endif
|
---|
119 |
|
---|
120 | " End /etc/vimrc</literal>
|
---|
121 | EOF</userinput></screen>
|
---|
122 |
|
---|
123 | <beginpage/>
|
---|
124 | <para>The <parameter>set nocompatible</parameter> makes
|
---|
125 | <command>vim</command> behave in a more useful way (the default) than
|
---|
126 | the vi-compatible manner. Remove the <quote>no</quote> to keep the
|
---|
127 | old <command>vi</command> behavior. The <parameter>set
|
---|
128 | backspace=2</parameter> allows backspacing over line breaks,
|
---|
129 | autoindents, and the start of insert. The <parameter>syntax
|
---|
130 | on</parameter> enables vim's syntax highlighting. Finally, the
|
---|
131 | <emphasis>if</emphasis> statement with the <parameter>set
|
---|
132 | background=dark</parameter> corrects <command>vim</command>'s guess
|
---|
133 | about the background color of some terminal emulators. This gives the
|
---|
134 | highlighting a better color scheme for use on the black background of
|
---|
135 | these programs.</para>
|
---|
136 |
|
---|
137 | <para>Documentation for other available options can be obtained by
|
---|
138 | running the following command:</para>
|
---|
139 |
|
---|
140 | <screen><userinput>vim -c ':options'</userinput></screen>
|
---|
141 |
|
---|
142 | </sect2>
|
---|
143 |
|
---|
144 | <sect2 id="contents-vim" role="content"><title>Contents of Vim</title>
|
---|
145 |
|
---|
146 | <segmentedlist>
|
---|
147 | <segtitle>Installed programs</segtitle>
|
---|
148 | <seglistitem><seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
|
---|
149 | pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl, tcltags, vi (link to vim),
|
---|
150 | view (link to vim), vim, vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh,
|
---|
151 | vimtutor, and xxd</seg></seglistitem>
|
---|
152 | </segmentedlist>
|
---|
153 |
|
---|
154 | <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
155 | <?dbfo list-presentation="list"?>
|
---|
156 |
|
---|
157 | <varlistentry id="efm_filter.pl">
|
---|
158 | <term><command>efm_filter.pl</command></term>
|
---|
159 | <listitem>
|
---|
160 | <para>A filter for creating an error file that can be read by <command>vim</command></para>
|
---|
161 | <indexterm zone="ch-system-vim efm_filter.pl"><primary sortas="b-efm_filter.pl">efm_filter.pl</primary></indexterm>
|
---|
162 | </listitem>
|
---|
163 | </varlistentry>
|
---|
164 |
|
---|
165 | <varlistentry id="efm_perl.pl">
|
---|
166 | <term><command>efm_perl.pl</command></term>
|
---|
167 | <listitem>
|
---|
168 | <para>Reformats the error messages of the
|
---|
169 | Perl interpreter for use with the <quote>quickfix</quote> mode of <command>vim</command></para>
|
---|
170 | <indexterm zone="ch-system-vim efm_perl.pl"><primary sortas="b-efm_perl.pl">efm_perl.pl</primary></indexterm>
|
---|
171 | </listitem>
|
---|
172 | </varlistentry>
|
---|
173 |
|
---|
174 | <varlistentry id="ex">
|
---|
175 | <term><command>ex</command></term>
|
---|
176 | <listitem>
|
---|
177 | <para>Starts <command>vim</command> in ex mode</para>
|
---|
178 | <indexterm zone="ch-system-vim ex"><primary sortas="b-ex">ex</primary></indexterm>
|
---|
179 | </listitem>
|
---|
180 | </varlistentry>
|
---|
181 |
|
---|
182 | <varlistentry id="less.sh">
|
---|
183 | <term><command>less.sh</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>A script that starts <command>vim</command> with less.vim</para>
|
---|
186 | <indexterm zone="ch-system-vim less.sh"><primary sortas="b-less.sh">less.sh</primary></indexterm>
|
---|
187 | </listitem>
|
---|
188 | </varlistentry>
|
---|
189 |
|
---|
190 | <varlistentry id="mve.awk">
|
---|
191 | <term><command>mve.awk</command></term>
|
---|
192 | <listitem>
|
---|
193 | <para>Processes <command>vim</command> errors</para>
|
---|
194 | <indexterm zone="ch-system-vim mve.awk"><primary sortas="b-mve.awk">mve.awk</primary></indexterm>
|
---|
195 | </listitem>
|
---|
196 | </varlistentry>
|
---|
197 |
|
---|
198 | <varlistentry id="pltags.pl">
|
---|
199 | <term><command>pltags.pl</command></term>
|
---|
200 | <listitem>
|
---|
201 | <para>Creates a tags file for Perl code for use by <command>vim</command></para>
|
---|
202 | <indexterm zone="ch-system-vim pltags.pl"><primary sortas="b-pltags.pl">pltags.pl</primary></indexterm>
|
---|
203 | </listitem>
|
---|
204 | </varlistentry>
|
---|
205 |
|
---|
206 | <varlistentry id="ref">
|
---|
207 | <term><command>ref</command></term>
|
---|
208 | <listitem>
|
---|
209 | <para>Checks the spelling of arguments</para>
|
---|
210 | <indexterm zone="ch-system-vim ref"><primary sortas="b-ref">ref</primary></indexterm>
|
---|
211 | </listitem>
|
---|
212 | </varlistentry>
|
---|
213 |
|
---|
214 | <varlistentry id="rview">
|
---|
215 | <term><command>rview</command></term>
|
---|
216 | <listitem>
|
---|
217 | <para>Is a restricted version of <command>view</command>; no shell
|
---|
218 | commands can be started and <command>view</command> cannot be suspended</para>
|
---|
219 | <indexterm zone="ch-system-vim rview"><primary sortas="b-rview">rview</primary></indexterm>
|
---|
220 | </listitem>
|
---|
221 | </varlistentry>
|
---|
222 |
|
---|
223 | <varlistentry id="rvim">
|
---|
224 | <term><command>rvim</command></term>
|
---|
225 | <listitem>
|
---|
226 | <para>Is a restricted version of <command>vim</command>; no shell
|
---|
227 | commands can be started and <command>vim</command> cannot be suspended</para>
|
---|
228 | <indexterm zone="ch-system-vim rvim"><primary sortas="b-rvim">rvim</primary></indexterm>
|
---|
229 | </listitem>
|
---|
230 | </varlistentry>
|
---|
231 |
|
---|
232 | <varlistentry id="shtags.pl">
|
---|
233 | <term><command>shtags.pl</command></term>
|
---|
234 | <listitem>
|
---|
235 | <para>Generates a tag file for Perl scripts</para>
|
---|
236 | <indexterm zone="ch-system-vim shtags.pl"><primary sortas="b-shtags.pl">shtags.pl</primary></indexterm>
|
---|
237 | </listitem>
|
---|
238 | </varlistentry>
|
---|
239 |
|
---|
240 | <varlistentry id="tcltags">
|
---|
241 | <term><command>tcltags</command></term>
|
---|
242 | <listitem>
|
---|
243 | <para>Generates a tag file for TCL code</para>
|
---|
244 | <indexterm zone="ch-system-vim tcltags"><primary sortas="b-tcltags">tcltags</primary></indexterm>
|
---|
245 | </listitem>
|
---|
246 | </varlistentry>
|
---|
247 |
|
---|
248 | <varlistentry id="view">
|
---|
249 | <term><command>view</command></term>
|
---|
250 | <listitem>
|
---|
251 | <para>Starts <command>vim</command> in read-only mode</para>
|
---|
252 | <indexterm zone="ch-system-vim view"><primary sortas="b-view">view</primary></indexterm>
|
---|
253 | </listitem>
|
---|
254 | </varlistentry>
|
---|
255 |
|
---|
256 | <varlistentry id="vi">
|
---|
257 | <term><command>vi</command></term>
|
---|
258 | <listitem>
|
---|
259 | <para>Is the editor</para>
|
---|
260 | <indexterm zone="ch-system-vim vi"><primary sortas="b-vi">vi</primary></indexterm>
|
---|
261 | </listitem>
|
---|
262 | </varlistentry>
|
---|
263 |
|
---|
264 | <varlistentry id="vim">
|
---|
265 | <term><command>vim</command></term>
|
---|
266 | <listitem>
|
---|
267 | <para>Is the editor</para>
|
---|
268 | <indexterm zone="ch-system-vim vim"><primary sortas="b-vim">vim</primary></indexterm>
|
---|
269 | </listitem>
|
---|
270 | </varlistentry>
|
---|
271 |
|
---|
272 | <varlistentry id="vim132">
|
---|
273 | <term><command>vim132</command></term>
|
---|
274 | <listitem>
|
---|
275 | <para>Starts <command>vim</command> with the terminal in 132-column mode</para>
|
---|
276 | <indexterm zone="ch-system-vim vim132"><primary sortas="b-vim132">vim132</primary></indexterm>
|
---|
277 | </listitem>
|
---|
278 | </varlistentry>
|
---|
279 |
|
---|
280 | <varlistentry id="vim2html.pl">
|
---|
281 | <term><command>vim2html.pl</command></term>
|
---|
282 | <listitem>
|
---|
283 | <para>Converts Vim documentation to HypterText Markup Language (HTML)</para>
|
---|
284 | <indexterm zone="ch-system-vim vim2html.pl"><primary sortas="b-vim2html.pl">vim2html.pl</primary></indexterm>
|
---|
285 | </listitem>
|
---|
286 | </varlistentry>
|
---|
287 |
|
---|
288 | <varlistentry id="vimdiff">
|
---|
289 | <term><command>vimdiff</command></term>
|
---|
290 | <listitem>
|
---|
291 | <para>Edits two or three versions of a file with <command>vim</command> and show differences</para>
|
---|
292 | <indexterm zone="ch-system-vim vimdiff"><primary sortas="b-vimdiff">vimdiff</primary></indexterm>
|
---|
293 | </listitem>
|
---|
294 | </varlistentry>
|
---|
295 |
|
---|
296 | <varlistentry id="vimm">
|
---|
297 | <term><command>vimm</command></term>
|
---|
298 | <listitem>
|
---|
299 | <para>Enables the DEC locator input model on a remote terminal</para>
|
---|
300 | <indexterm zone="ch-system-vim vimm"><primary sortas="b-vimm">vimm</primary></indexterm>
|
---|
301 | </listitem>
|
---|
302 | </varlistentry>
|
---|
303 |
|
---|
304 | <varlistentry id="vimspell.sh">
|
---|
305 | <term><command>vimspell.sh</command></term>
|
---|
306 | <listitem>
|
---|
307 | <para>Spells a file and generates the syntax statements necessary
|
---|
308 | to highlight in <command>vim</command>. This script requires the old Unix <command>spell</command>
|
---|
309 | command, which is provided neither in LFS nor in BLFS</para>
|
---|
310 | <indexterm zone="ch-system-vim vimspell.sh"><primary sortas="b-vimspell.sh">vimspell.sh</primary></indexterm>
|
---|
311 | </listitem>
|
---|
312 | </varlistentry>
|
---|
313 |
|
---|
314 | <varlistentry id="vimtutor">
|
---|
315 | <term><command>vimtutor</command></term>
|
---|
316 | <listitem>
|
---|
317 | <para>Teaches the basic keys and commands of <command>vim</command></para>
|
---|
318 | <indexterm zone="ch-system-vim vimtutor"><primary sortas="b-vimtutor">vimtutor</primary></indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="xxd">
|
---|
323 | <term><command>xxd</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>Creates a hex dump of the given file; it can
|
---|
326 | also do the reverse, so it can be used for binary patching</para>
|
---|
327 | <indexterm zone="ch-system-vim xxd"><primary sortas="b-xxd">xxd</primary></indexterm>
|
---|
328 | </listitem>
|
---|
329 | </varlistentry>
|
---|
330 | </variablelist>
|
---|
331 |
|
---|
332 | </sect2>
|
---|
333 |
|
---|
334 | </sect1>
|
---|
335 |
|
---|