source: postlfs/editors/vim.xml@ 6732c094

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 6732c094 was 6732c094, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated all the XML files (and the one stylesheet) to use the 4.5 version of DocBook XML DTD

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6716 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 11.9 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 <!ENTITY vim-download-http "http://ftp.at.vim.org/pub/vim/unix/vim-&vim-version;.tar.bz2">
8 <!ENTITY vim-download-ftp "ftp://ftp.vim.org/pub/vim/unix/vim-&vim-version;.tar.bz2">
9 <!ENTITY vim-md5sum "4ca69757678272f718b1041c810d82d8">
10 <!ENTITY vim-size "6.3 MB">
11 <!ENTITY vim-buildsize "73 MB">
12 <!ENTITY vim-time "0.8 SBU">
13]>
14
15<sect1 id="vim" xreflabel="Vim-&vim-version;">
16 <?dbhtml filename="vim.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Vim-&vim-version;</title>
24
25 <indexterm zone="vim">
26 <primary sortas="a-Vim">Vim</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Vim</title>
31
32 <para>The <application>Vim</application> package, which is an
33 abbreviation for VI IMproved, contains a <command>vi</command>
34 clone with extra features as compared to the original
35 <command>vi</command>.</para>
36
37 <para>The default LFS instructions install <application>vim</application>
38 as a part of the base system. If you would prefer to link
39 <application>vim</application> against <application>X</application>,
40 you should recompile <application>vim</application> to enable GUI mode.
41 There is no need for special instructions since
42 <application>X</application> support is automatically detected.</para>
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>Download (HTTP): <ulink url="&vim-download-http;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download (FTP): <ulink url="&vim-download-ftp;"/></para>
51 </listitem>
52 <listitem>
53 <para>Download MD5 sum: &vim-md5sum;</para>
54 </listitem>
55 <listitem>
56 <para>Download size: &vim-size;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated disk space required: &vim-buildsize;</para>
60 </listitem>
61 <listitem>
62 <para>Estimated build time: &vim-time;</para>
63 </listitem>
64 </itemizedlist>
65
66 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
67 <itemizedlist spacing='compact'>
68 <listitem>
69 <para>Recommended Patch: <ulink
70 url="&patch-root;/vim-&vim-version;-fixes-14.patch"/></para>
71 </listitem>
72 <listitem>
73 <para>Recommended Patch: <ulink
74 url="&patch-root;/vim-&vim-version;-mandir-1.patch"/></para>
75 </listitem>
76 <listitem>
77 <para>Translated Vim messages: <ulink
78 url="http://ftp.at.vim.org/pub/vim/extra/vim-&vim-version;-lang.tar.gz"/>
79 </para>
80 </listitem>
81 </itemizedlist>
82
83 <bridgehead renderas="sect3">Vim Dependencies</bridgehead>
84
85 <bridgehead renderas="sect4">Recommended</bridgehead>
86 <para role="recommended"><xref linkend="x-window-system"/></para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional"><xref linkend="gtk2"/> OR
90 <xref linkend="lesstif"/> OR
91 <xref linkend="GTK"/>,
92 <xref linkend="python"/>,
93 <xref linkend="tcl"/>,
94 <xref linkend="ruby"/>, and
95 <xref linkend="gpm"/></para>
96
97 <para condition="html" role="usernotes">User Notes:
98 <ulink url="&blfs-wiki;/vim"/></para>
99
100 </sect2>
101
102 <sect2 role="installation">
103 <title>Installation of Vim</title>
104
105 <note>
106 <para>If you recompile <application>Vim</application> to link against
107 <application>X</application>, and your <application>X</application>
108 libraries are not on the root partition, you will no longer have an editor
109 for use in emergencies. You may choose to install an additional editor,
110 not link <application>Vim</application> against
111 <application>X</application>, or move the current <command>vim</command>
112 executable to the <filename class="directory">/bin</filename> directory
113 under a different name such as <filename>vi</filename>.</para>
114 </note>
115
116 <para>If desired, unpack the translated messages archive:</para>
117
118<screen><userinput>tar -xf ../vim-&vim-version;-lang.tar.gz --strip-components=1</userinput></screen>
119
120 <para>Install <application>Vim</application> by running the following
121 commands:</para>
122
123<screen><userinput>patch -Np1 -i ../vim-&vim-version;-fixes-14.patch &amp;&amp;
124patch -Np1 -i ../vim-&vim-version;-mandir-1.patch &amp;&amp;
125echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h &amp;&amp;
126echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' &gt;&gt; src/feature.h &amp;&amp;
127./configure --prefix=/usr --with-features=huge &amp;&amp;
128make</userinput></screen>
129
130 <para>To test the results, issue: <command>make test</command>.
131 The <application>vim</application> test suite outputs a lot of binary
132 data to the screen, which can cause issues with the settings of the
133 current terminal. This can be resolved by redirecting the output to a
134 log file. Even if one of the tests fails to produce the file
135 <filename>test.out</filename> in <filename
136 class="directory">src/testdir</filename>, the remaining tests will still
137 be executed. If all goes well,the final message in the log file will be
138 <literal>ALL DONE</literal>. <emphasis>Note</emphasis>: Some color tests
139 expect to be executed under the <command>xterm</command> terminal
140 emulator.</para>
141
142 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
143
144<screen role="root"><userinput>make install</userinput></screen>
145
146 <para>By default, Vim's documentation is installed in <filename
147 class="directory">/usr/share/vim</filename>. The following symlink allows
148 the documentation to be accessed via <filename
149 class="directory">/usr/share/doc/vim-7.0</filename>, making it consistent
150 with the location of documentation for other packages:</para>
151
152<screen role="root"><userinput>ln -snfv ../vim/vim70/doc /usr/share/doc/vim-7.0</userinput></screen>
153
154 </sect2>
155
156 <sect2 role="commands">
157 <title>Command Explanations</title>
158
159 <para><command>patch &hellip;</command>: These patches are the same as LFS
160 and update the package with upstream patches and ensure the man pages
161 are placed in the proper locations.</para>
162
163 <para><parameter>--with-features=huge</parameter>: This switch enables all
164 the additional features available in <application>Vim</application>.</para>
165
166 <para><option>--enable-gui=no</option>: This will prevent compilation of the
167 GUI. <application>Vim</application> will still link against
168 <application>X</application> so that some nice eye-candy such as updating the
169 title bar of an <application>Xterm</application> window are available.</para>
170
171 <para><option>--without-x</option>: If you prefer not to link
172 <application>Vim</application> against <application>X</application>, use
173 this switch.</para>
174
175 <para><option>--enable-perlinterp</option>, <option>--enable-pythoninterp</option>,
176 <option>--enable-tclinterp</option>, <option>--enable-rubyinterp</option>:
177 These options include the Perl, Python, Tcl, or Ruby interpreters that allow
178 using other application code in <application>vim</application> scripts.</para>
179
180 </sect2>
181
182 <sect2 role="configuration">
183 <title>Configuring Vim</title>
184
185 <sect3 id='vim-config'>
186 <title>Config Files</title>
187
188 <para><filename>/etc/vimrc</filename> and
189 <filename>~/.vimrc</filename></para>
190
191 <indexterm zone="vim vim-config">
192 <primary sortas="e-etc-vimrc">/etc/vimrc</primary>
193 </indexterm>
194
195 <indexterm zone="vim vim-config">
196 <primary sortas="e-AA.vimrc">~/.vimrc</primary>
197 </indexterm>
198
199 </sect3>
200
201 <sect3 id='vim-init'>
202 <title>Configuration Information</title>
203
204 <para><application>Vim-7.0</application> introduced an
205 integrated spell checker that doesn't requires additional libraries to be
206 installed. To enable the spell checker you can set the following in
207 one of the configuration files: </para>
208
209<screen><literal>set spell
210spelllang=en,ru</literal></screen>
211
212 <para>By default, <application>Vim</application> only installs spell
213 files for the English language. If a spell file is not available for
214 your language, then <application>Vim</application> will call
215 <filename>$VIMRUNTIME/plugin/spellfile.vim</filename> and will try to
216 obtain the *.spl and optionally *.sug from the vim ftp server, using the
217 <filename>$VIMRUNTIME/plugin/netrw</filename> plugin.</para>
218
219 <para>Alternatively you can manually download the *.spl and *.sug files
220 from: <ulink url="ftp://ftp.vim.org/pub/vim/runtime/spell/"/> and save
221 them to <filename class="directory"> ~/.vim/spell </filename> or in
222 <filename class="directory">
223 /usr/share/vim/vim70/spell/</filename>.</para>
224
225 <para>For more information about the spell checker and some other
226 features in <application>Vim-&vim-version;</application> (such us
227 vimgrep, tab-pages, and omni-completion), issue the following command inside
228 <application>Vim</application>:</para>
229
230<screen><literal>:help version7</literal></screen>
231
232 <para>For additional information on setting up
233 <application>Vim</application> configuration files, see <xref
234 linkend="postlfs-config-vimrc"/> and <ulink
235 url='http://www.vi-improved.org/vimrc.php'/>. </para>
236
237 </sect3>
238
239 </sect2>
240
241 <sect2 role="content">
242 <title>Contents</title>
243
244 <para>A list of the reinstalled files, along with their short
245 descriptions can be found in the <ulink
246 url="&lfs-root;/chapter06/vim.html#contents-vim">LFS Vim Installation
247 Instrutions</ulink></para>
248
249 <segmentedlist>
250 <segtitle>Installed Programs</segtitle>
251 <segtitle>Installed Libraries</segtitle>
252 <segtitle>Installed Directory</segtitle>
253
254 <seglistitem>
255 <seg>gview, gvim, gvimdiff, rgview, and rgvim</seg>
256 <seg>None</seg>
257 <seg>/usr/share/vim</seg>
258 </seglistitem>
259 </segmentedlist>
260
261 <variablelist>
262 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
263 <?dbfo list-presentation="list"?>
264 <?dbhtml list-presentation="table"?>
265
266 <varlistentry id="gview">
267 <term><command>gview</command></term>
268 <listitem>
269 <para>starts <command>gvim</command> in read-only mode.</para>
270 <indexterm zone="vim gview">
271 <primary sortas="b-gview">gview</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="gvim">
277 <term><command>gvim</command></term>
278 <listitem>
279 <para>is the editor that runs under <application>X</application>
280 and includes a GUI.</para>
281 <indexterm zone="vim gvim">
282 <primary sortas="b-gvim">gvim</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="gvimdiff">
288 <term><command>gvimdiff</command></term>
289 <listitem>
290 <para>edits two or three versions of a file with
291 <command>gvim</command> and shows the differences.</para>
292 <indexterm zone="vim gvimdiff">
293 <primary sortas="b-gvimdiff">gvimdiff</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="rgview">
299 <term><command>rgview</command></term>
300 <listitem>
301 <para>is a restricted version of <command>gview</command>.</para>
302 <indexterm zone="vim rgview">
303 <primary sortas="b-rgview">rgview</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="rgvim">
309 <term><command>rgvim</command></term>
310 <listitem>
311 <para>is a restricted version of <command>gvim</command>. </para>
312 <indexterm zone="vim gvim">
313 <primary sortas="b-gvim">gvim</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 </variablelist>
319
320 </sect2>
321
322</sect1>
Note: See TracBrowser for help on using the repository browser.