source: chapter06/vim.xml@ cd2f7f0

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 cd2f7f0 was cd2f7f0, checked in by Dan Nichilson <dnicholson@…>, 18 years ago

Provide vi to vim man page symlinks for all languages. Closes #1811.

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