source: chapter06/vim.xml@ efca30a

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 8.3 8.3-rc1 8.3-rc2 8.4 8.4-rc1 9.0 9.0-rc1 9.1 9.1-rc1 cross-chap5 ml-11.0 multilib old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since efca30a was efca30a, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to glibc-2.28.
Update to gdbm-1.17.
Update to linux-4.17.11.
Update to man-db-2.8.4.

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

  • Property mode set to 100644
File size: 11.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/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 <sect1info condition="script">
12 <productname>vim</productname>
13 <productnumber>&vim-version;</productnumber>
14 <address>&vim-url;</address>
15 </sect1info>
16
17 <title>Vim-&vim-version;</title>
18
19 <indexterm zone="ch-system-vim">
20 <primary sortas="a-Vim">Vim</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Vim package contains a powerful text editor.</para>
27
28 <segmentedlist>
29 <segtitle>&buildtime;</segtitle>
30 <segtitle>&diskspace;</segtitle>
31
32 <seglistitem>
33 <seg>&vim-ch6-sbu;</seg>
34 <seg>&vim-ch6-du;</seg>
35 </seglistitem>
36 </segmentedlist>
37
38 <tip>
39 <title>Alternatives to Vim</title>
40
41 <para>If you prefer another editor&mdash;such as Emacs, Joe, or
42 Nano&mdash;please refer to <ulink
43 url="&blfs-book;postlfs/editors.html"/> for suggested
44 installation instructions.</para>
45 </tip>
46
47 </sect2>
48
49 <sect2 role="installation">
50 <title>Installation of Vim</title>
51
52 <para>First, change the default location of the <filename>vimrc</filename>
53 configuration file to <filename class="directory">/etc</filename>:</para>
54
55<screen><userinput remap="pre">echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h</userinput></screen>
56
57<!-- <para>Disable a test that fails:</para>
58
59<screen><userinput remap="pre">sed -i '/call/{s/split/xsplit/;s/303/492/}' src/testdir/test_recover.vim</userinput></screen>
60-->
61 <para>Prepare Vim for compilation:</para>
62
63<screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
64
65 <para>Compile the package:</para>
66
67<screen><userinput remap="make">make</userinput></screen>
68
69 <para>To test the results, issue:</para>
70
71<screen><userinput remap="test">make -j1 test &amp;&gt; vim-test.log</userinput></screen>
72
73 <para>The test suite outputs a lot of binary data to the screen. This can
74 cause issues with the settings of the current terminal. The problem can be
75 avoided by redirecting the output to a log file as shown above. A
76 successful test will result in the words "ALL DONE" in the log file
77 at completion.</para>
78
79 <para>One test, Test_terminal_composing_unicode, is known to fail.</para>
80
81 <para>Install the package:</para>
82
83<screen><userinput remap="install">make install</userinput></screen>
84
85 <para>Many users are used to using <command>vi</command> instead of
86 <command>vim</command>. To allow execution of <command>vim</command>
87 when users habitually enter <command>vi</command>, create a
88 symlink for both the binary and the man page in the provided
89 languages:</para>
90
91<screen><userinput remap="install">ln -sv vim /usr/bin/vi
92for L in /usr/share/man/{,*/}man1/vim.1; do
93 ln -sv vim.1 $(dirname $L)/vi.1
94done</userinput></screen>
95
96 <para>By default, Vim's documentation is installed in <filename
97 class="directory">/usr/share/vim</filename>. The following symlink
98 allows the documentation to be accessed via <filename
99 class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
100 it consistent with the location of documentation for other packages:</para>
101
102<screen><userinput remap="install">ln -sv ../&vim-docdir;/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
103
104 <para>If an X Window System is going to be installed on the LFS
105 system, it may be necessary to recompile Vim after installing X. Vim
106 comes with a GUI version of the editor that requires X and some
107 additional libraries to be installed. For more information on this
108 process, refer to the Vim documentation and the Vim installation page
109 in the BLFS book at <ulink
110 url="&blfs-book;postlfs/vim.html"/>.</para>
111
112 </sect2>
113
114 <sect2 id="conf-vim" role="configuration">
115 <title>Configuring Vim</title>
116
117 <indexterm zone="conf-vim">
118 <primary sortas="e-/etc/vimrc">/etc/vimrc</primary>
119 </indexterm>
120
121 <para>By default, <command>vim</command> runs in vi-incompatible mode.
122 This may be new to users who have used other editors in the past. The
123 <quote>nocompatible</quote> setting is included below to highlight the
124 fact that a new behavior is being used. It also reminds those who would
125 change to <quote>compatible</quote> mode that it should be the first
126 setting in the configuration file. This is necessary because it changes
127 other settings, and overrides must come after this setting. Create a default
128 <command>vim</command> configuration file by running the following:</para>
129
130<screen><userinput>cat &gt; /etc/vimrc &lt;&lt; "EOF"
131<literal>" Begin /etc/vimrc
132
133" Ensure defaults are set before customizing settings, not after
134source $VIMRUNTIME/defaults.vim
135let skip_defaults_vim=1
136
137set nocompatible
138set backspace=2
139set mouse=
140syntax on
141if (&amp;term == "xterm") || (&amp;term == "putty")
142 set background=dark
143endif
144
145" End /etc/vimrc</literal>
146EOF</userinput></screen>
147
148 <para>The <parameter>set nocompatible</parameter> setting makes
149 <command>vim</command> behave in a more useful way (the default) than the
150 vi-compatible manner. Remove the <quote>no</quote> to keep the old
151 <command>vi</command> behavior. The <parameter>set backspace=2</parameter>
152 setting allows backspacing over line breaks, autoindents, and the start of
153 insert. The <parameter>syntax on</parameter> parameter enables vim's syntax
154 highlighting. The <parameter>set mouse=</parameter> setting enables
155 proper pasting of text with the mouse when working in chroot or over a
156 remote connection. Finally, the <emphasis>if</emphasis> statement with the
157 <parameter>set background=dark</parameter> setting corrects
158 <command>vim</command>'s guess about the background color of some terminal
159 emulators. This gives the highlighting a better color scheme for use on the
160 black background of these programs.</para>
161<!--
162 <para>Creating an empty <filename>~/.vimrc</filename> prevents vim from
163 overriding settings in <filename>/etc/vimrc</filename> by using
164 <filename>/usr/share/vim/vim80/defaults.vim</filename>.</para>
165-->
166 <para>Documentation for other available options can be obtained by
167 running the following command:</para>
168
169<screen role="nodump"><userinput>vim -c ':options'</userinput></screen>
170
171 <note>
172 <para>By default, Vim only installs spell files for the English language.
173 To install spell files for your preferred language, download the
174 <filename>*.spl</filename> and optionally, the <filename>*.sug</filename>
175 files for your language and character encoding from <ulink
176 url="ftp://ftp.vim.org/pub/vim/runtime/spell/"/> and save them to
177 <filename class='directory'>/usr/share/&vim-docdir;/spell/</filename>.</para>
178
179 <para>To use these spell files, some configuration in
180 <filename>/etc/vimrc</filename> is needed, e.g.:</para>
181
182<screen><literal>set spelllang=en,ru
183set spell</literal></screen>
184
185 <para>For more information, see the appropriate README file located
186 at the URL above.</para>
187 </note>
188
189 </sect2>
190
191 <sect2 id="contents-vim" role="content">
192 <title>Contents of Vim</title>
193
194 <segmentedlist>
195 <segtitle>Installed programs</segtitle>
196 <segtitle>Installed directory</segtitle>
197
198 <seglistitem>
199 <seg> ex (link to vim), rview (link to vim), rvim (link to vim), vi
200 (link to vim), view (link to vim), vim, vimdiff (link to vim), vimtutor,
201 and xxd</seg>
202 <seg>/usr/share/vim</seg>
203 </seglistitem>
204 </segmentedlist>
205
206 <variablelist>
207 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
208 <?dbfo list-presentation="list"?>
209 <?dbhtml list-presentation="table"?>
210
211 <varlistentry id="ex">
212 <term><command>ex</command></term>
213 <listitem>
214 <para>Starts <command>vim</command> in ex mode</para>
215 <indexterm zone="ch-system-vim ex">
216 <primary sortas="b-ex">ex</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="rview">
222 <term><command>rview</command></term>
223 <listitem>
224 <para>Is a restricted version of <command>view</command>; no shell
225 commands can be started and <command>view</command> cannot be
226 suspended</para>
227 <indexterm zone="ch-system-vim rview">
228 <primary sortas="b-rview">rview</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="rvim">
234 <term><command>rvim</command></term>
235 <listitem>
236 <para>Is a restricted version of <command>vim</command>; no shell
237 commands can be started and <command>vim</command> cannot be
238 suspended</para>
239 <indexterm zone="ch-system-vim rvim">
240 <primary sortas="b-rvim">rvim</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="vi">
246 <term><command>vi</command></term>
247 <listitem>
248 <para>Link to <command>vim</command></para>
249 <indexterm zone="ch-system-vim vi">
250 <primary sortas="b-vi">vi</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="view">
256 <term><command>view</command></term>
257 <listitem>
258 <para>Starts <command>vim</command> in read-only mode</para>
259 <indexterm zone="ch-system-vim view">
260 <primary sortas="b-view">view</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="vim">
266 <term><command>vim</command></term>
267 <listitem>
268 <para>Is the editor</para>
269 <indexterm zone="ch-system-vim vim">
270 <primary sortas="b-vim">vim</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="vimdiff">
276 <term><command>vimdiff</command></term>
277 <listitem>
278 <para>Edits two or three versions of a file with <command>vim</command>
279 and shows differences</para>
280 <indexterm zone="ch-system-vim vimdiff">
281 <primary sortas="b-vimdiff">vimdiff</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="vimtutor">
287 <term><command>vimtutor</command></term>
288 <listitem>
289 <para>Teaches the basic keys and commands of
290 <command>vim</command></para>
291 <indexterm zone="ch-system-vim vimtutor">
292 <primary sortas="b-vimtutor">vimtutor</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="xxd">
298 <term><command>xxd</command></term>
299 <listitem>
300 <para>Creates a hex dump of the given file; it can
301 also do the reverse, so it can be used for binary patching</para>
302 <indexterm zone="ch-system-vim xxd">
303 <primary sortas="b-xxd">xxd</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 </variablelist>
309
310 </sect2>
311
312</sect1>
Note: See TracBrowser for help on using the repository browser.