source: chapter06/vim.xml@ ddd5542

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.3 6.4 6.5 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since ddd5542 was ddd5542, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Finished the XML indentation plus few tags changes.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7369 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 15.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-vim" role="wrap">
9 <?dbhtml filename="vim.html"?>
10
11 <title>Vim-&vim-version;</title>
12
13 <indexterm zone="ch-system-vim">
14 <primary sortas="a-Vim">Vim</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Vim package contains a powerful text editor.</para>
21
22 <segmentedlist>
23 <segtitle>&buildtime;</segtitle>
24 <segtitle>&diskspace;</segtitle>
25
26 <seglistitem>
27 <seg>0.4 SBU</seg>
28 <seg>38.0 MB</seg>
29 </seglistitem>
30 </segmentedlist>
31
32 <segmentedlist>
33 <segtitle>&dependencies;</segtitle>
34
35 <seglistitem>
36 <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make,
37 Ncurses, and Sed</seg>
38 </seglistitem>
39 </segmentedlist>
40
41 <tip>
42 <title>Alternatives to Vim</title>
43
44 <para>If you prefer another editor&mdash;such as Emacs, Joe, or
45 Nano&mdash;please refer to <ulink
46 url="&blfs-root;view/svn/postlfs/editors.html"/> for suggested
47 installation instructions.</para>
48 </tip>
49
50 </sect2>
51
52 <sect2 role="installation">
53 <title>Installation of Vim</title>
54
55 <para>First, unpack both
56 <filename>vim-&vim-version;.tar.bz2</filename> and (optionally)
57 <filename>vim-&vim-version;-lang.tar.gz</filename> archives into the
58 same directory. Then, change the default location of the
59 <filename>vimrc</filename> configuration file to <filename
60 class="directory">/etc</filename>:</para>
61
62<screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h</userinput></screen>
63
64 <para>Now prepare Vim for compilation:</para>
65
66<screen><userinput>./configure --prefix=/usr --enable-multibyte</userinput></screen>
67
68 <variablelist>
69 <title>The meaning of the configure options:</title>
70
71 <varlistentry>
72 <term><parameter>--enable-multibyte</parameter></term>
73 <listitem>
74 <para>This switch enables support for editing files in multibyte
75 character encodings. This is needed if using a locale with a
76 multibyte character set. This switch is also helpful to be able
77 to edit text files initially created in Linux distributions like
78 Fedora Core that use UTF-8 as a default character set.</para>
79 </listitem>
80 </varlistentry>
81
82 </variablelist>
83
84 <para>Compile the package:</para>
85
86<screen><userinput>make</userinput></screen>
87
88 <para>To test the results, issue: <userinput>make test</userinput>. However,
89 this test suite outputs a lot of binary data to the screen, which can cause
90 issues with the settings of the current terminal. This can be resolved by
91 redirecting the output to a log file.</para>
92
93 <para>Install the package:</para>
94
95<screen><userinput>make install</userinput></screen>
96
97 <para>In UTF-8 locales, the <command>vimtutor</command> program tries to
98 convert the tutorials from ISO-8859-1 to UTF-8. Since some tutorials are
99 not in ISO-8859-1, the text in them is thus made unreadable. If you
100 unpacked the <filename>vim-&vim-version;-lang.tar.gz</filename> archive
101 and are going to use a UTF-8 based locale, remove non-ISO-8859-1 tutorials.
102 An English tutorial will be used instead.</para>
103 <!-- Removal is used instead of conversion in order for the user to be able to
104 painlessly revert his UTF-8 locale choice. -->
105
106<screen><userinput>rm -f /usr/share/vim/vim64/tutor/tutor.{gr,pl,ru,sk}
107rm -f /usr/share/vim/vim64/tutor/tutor.??.*</userinput></screen>
108
109 <para>Many users are used to using <command>vi</command> instead of
110 <command>vim</command>. To allow execution of <command>vim</command>
111 when users habitually enter <command>vi</command>, create a
112 symlink:</para>
113
114<screen><userinput>ln -sv vim /usr/bin/vi</userinput></screen>
115
116 <para>By default, Vim's documentation is installed in <filename
117 class="directory">/usr/share/vim</filename>. The following symlink
118 allows the documentation to be accessed via <filename
119 class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
120 it consistent with the location of documentation for other packages:</para>
121
122<screen><userinput>ln -sv ../vim/vim64/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
123
124 <para>If an X Window System is going to be installed on the LFS
125 system, it may be necessary to recompile Vim after installing X. Vim
126 comes with a GUI version of the editor that requires X and some
127 additional libraries to be installed. For more information on this
128 process, refer to the Vim documentation and the Vim installation page
129 in the BLFS book at <ulink
130 url="&blfs-root;view/svn/postlfs/editors.html#postlfs-editors-vim"/>.</para>
131
132 </sect2>
133
134 <sect2 id="conf-vim" role="configuration">
135 <title>Configuring Vim</title>
136
137 <indexterm zone="conf-vim">
138 <primary sortas="e-/etc/vimrc">/etc/vimrc</primary>
139 </indexterm>
140
141 <para>By default, <command>vim</command> runs in vi-incompatible mode.
142 This may be new to users who have used other editors in the past. The
143 <quote>nocompatible</quote> setting is included below to highlight the
144 fact that a new behavior is being used. It also reminds those who would
145 change to <quote>compatible</quote> mode that it should be the first
146 setting in the configuration file. This is necessary because it changes
147 other settings, and overrides must come after this setting. Create a default
148 <command>vim</command> configuration file by running the following:</para>
149
150<screen><userinput>cat &gt; /etc/vimrc &lt;&lt; "EOF"
151<literal>" Begin /etc/vimrc
152
153set nocompatible
154set backspace=2
155syntax on
156if (&amp;term == "iterm") || (&amp;term == "putty")
157 set background=dark
158endif
159
160" End /etc/vimrc</literal>
161EOF</userinput></screen>
162
163 <para>The <parameter>set nocompatible</parameter> makes
164 <command>vim</command> behave in a more useful way (the default) than
165 the vi-compatible manner. Remove the <quote>no</quote> to keep the
166 old <command>vi</command> behavior. The <parameter>set
167 backspace=2</parameter> allows backspacing over line breaks,
168 autoindents, and the start of insert. The <parameter>syntax
169 on</parameter> enables vim's syntax highlighting. Finally, the
170 <emphasis>if</emphasis> statement with the <parameter>set
171 background=dark</parameter> corrects <command>vim</command>'s guess
172 about the background color of some terminal emulators. This gives the
173 highlighting a better color scheme for use on the black background of
174 these programs.</para>
175
176 <para>Documentation for other available options can be obtained by
177 running the following command:</para>
178
179<screen role="nodump"><userinput>vim -c ':options'</userinput></screen>
180
181 </sect2>
182
183 <sect2 id="contents-vim" role="content">
184 <title>Contents of Vim</title>
185
186 <segmentedlist>
187 <segtitle>Installed programs</segtitle>
188
189 <seglistitem>
190 <seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
191 pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl,
192 tcltags, vi (link to vim), view (link to vim), vim, vim132, vim2html.pl,
193 vimdiff (link to vim), vimm, vimspell.sh, vimtutor, and xxd</seg>
194 </seglistitem>
195 </segmentedlist>
196
197 <variablelist>
198 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
199 <?dbfo list-presentation="list"?>
200 <?dbhtml list-presentation="table"?>
201
202 <varlistentry id="efm_filter.pl">
203 <term><command>efm_filter.pl</command></term>
204 <listitem>
205 <para>A filter for creating an error file that can be read
206 by <command>vim</command></para>
207 <indexterm zone="ch-system-vim efm_filter.pl">
208 <primary sortas="b-efm_filter.pl">efm_filter.pl</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="efm_perl.pl">
214 <term><command>efm_perl.pl</command></term>
215 <listitem>
216 <para>Reformats the error messages of the Perl interpreter for use
217 with the <quote>quickfix</quote> mode of <command>vim</command></para>
218 <indexterm zone="ch-system-vim efm_perl.pl">
219 <primary sortas="b-efm_perl.pl">efm_perl.pl</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="ex">
225 <term><command>ex</command></term>
226 <listitem>
227 <para>Starts <command>vim</command> in ex mode</para>
228 <indexterm zone="ch-system-vim ex">
229 <primary sortas="b-ex">ex</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="less.sh">
235 <term><command>less.sh</command></term>
236 <listitem>
237 <para>A script that starts <command>vim</command> with less.vim</para>
238 <indexterm zone="ch-system-vim less.sh">
239 <primary sortas="b-less.sh">less.sh</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="mve.awk">
245 <term><command>mve.awk</command></term>
246 <listitem>
247 <para>Processes <command>vim</command> errors</para>
248 <indexterm zone="ch-system-vim mve.awk">
249 <primary sortas="b-mve.awk">mve.awk</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="pltags.pl">
255 <term><command>pltags.pl</command></term>
256 <listitem>
257 <para>Creates a tags file for Perl code for use by
258 <command>vim</command></para>
259 <indexterm zone="ch-system-vim pltags.pl">
260 <primary sortas="b-pltags.pl">pltags.pl</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="ref">
266 <term><command>ref</command></term>
267 <listitem>
268 <para>Checks the spelling of arguments</para>
269 <indexterm zone="ch-system-vim ref">
270 <primary sortas="b-ref">ref</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="rview">
276 <term><command>rview</command></term>
277 <listitem>
278 <para>Is a restricted version of <command>view</command>; no shell
279 commands can be started and <command>view</command> cannot be
280 suspended</para>
281 <indexterm zone="ch-system-vim rview">
282 <primary sortas="b-rview">rview</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="rvim">
288 <term><command>rvim</command></term>
289 <listitem>
290 <para>Is a restricted version of <command>vim</command>; no shell
291 commands can be started and <command>vim</command> cannot be
292 suspended</para>
293 <indexterm zone="ch-system-vim rvim">
294 <primary sortas="b-rvim">rvim</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="shtags.pl">
300 <term><command>shtags.pl</command></term>
301 <listitem>
302 <para>Generates a tags file for Perl scripts</para>
303 <indexterm zone="ch-system-vim shtags.pl">
304 <primary sortas="b-shtags.pl">shtags.pl</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="tcltags">
310 <term><command>tcltags</command></term>
311 <listitem>
312 <para>Generates a tags file for TCL code</para>
313 <indexterm zone="ch-system-vim tcltags">
314 <primary sortas="b-tcltags">tcltags</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="view">
320 <term><command>view</command></term>
321 <listitem>
322 <para>Starts <command>vim</command> in read-only mode</para>
323 <indexterm zone="ch-system-vim view">
324 <primary sortas="b-view">view</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="vi">
330 <term><command>vi</command></term>
331 <listitem>
332 <para>Link to <command>vim</command></para>
333 <indexterm zone="ch-system-vim vi">
334 <primary sortas="b-vi">vi</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="vim">
340 <term><command>vim</command></term>
341 <listitem>
342 <para>Is the editor</para>
343 <indexterm zone="ch-system-vim vim">
344 <primary sortas="b-vim">vim</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="vim132">
350 <term><command>vim132</command></term>
351 <listitem>
352 <para>Starts <command>vim</command> with the terminal in 132-column
353 mode</para>
354 <indexterm zone="ch-system-vim vim132">
355 <primary sortas="b-vim132">vim132</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="vim2html.pl">
361 <term><command>vim2html.pl</command></term>
362 <listitem>
363 <para>Converts Vim documentation to HypterText Markup Language
364 (HTML)</para>
365 <indexterm zone="ch-system-vim vim2html.pl">
366 <primary sortas="b-vim2html.pl">vim2html.pl</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="vimdiff">
372 <term><command>vimdiff</command></term>
373 <listitem>
374 <para>Edits two or three versions of a file with <command>vim</command>
375 and show differences</para>
376 <indexterm zone="ch-system-vim vimdiff">
377 <primary sortas="b-vimdiff">vimdiff</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="vimm">
383 <term><command>vimm</command></term>
384 <listitem>
385 <para>Enables the DEC locator input model on a remote terminal</para>
386 <indexterm zone="ch-system-vim vimm">
387 <primary sortas="b-vimm">vimm</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="vimspell.sh">
393 <term><command>vimspell.sh</command></term>
394 <listitem>
395 <para>Spell checks a file and generates the syntax statements
396 necessary to highlight in <command>vim</command>. This script
397 requires the old Unix <command>spell</command> command, which
398 is provided neither in LFS nor in BLFS</para>
399 <indexterm zone="ch-system-vim vimspell.sh">
400 <primary sortas="b-vimspell.sh">vimspell.sh</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="vimtutor">
406 <term><command>vimtutor</command></term>
407 <listitem>
408 <para>Teaches the basic keys and commands of
409 <command>vim</command></para>
410 <indexterm zone="ch-system-vim vimtutor">
411 <primary sortas="b-vimtutor">vimtutor</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="xxd">
417 <term><command>xxd</command></term>
418 <listitem>
419 <para>Creates a hex dump of the given file; it can
420 also do the reverse, so it can be used for binary patching</para>
421 <indexterm zone="ch-system-vim xxd">
422 <primary sortas="b-xxd">xxd</primary>
423 </indexterm>
424 </listitem>
425 </varlistentry>
426
427 </variablelist>
428
429 </sect2>
430
431</sect1>
Note: See TracBrowser for help on using the repository browser.