source: postlfs/editors/vim.xml@ 95799899

10.0 10.1 11.0 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 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 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 95799899 was 95799899, checked in by Bruce Dubbs <bdubbs@…>, 15 years ago

Added additional text to vim

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6403 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.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 <!-- Inserted as a reminder to do this. The mention of a test suite
8 is usually right before the root user installation commands. Please
9 delete these 12 (including one blank) lines after you are done.-->
10
11 <!-- Use one of the two mentions below about a test suite,
12 delete the line that is not applicable. Of course, if the
13 test suite uses syntax other than "make check", revise the
14 line to reflect the actual syntax to run the test suite -->
15
16 <!-- <para>This package does not come with a test suite.</para> -->
17 <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
18
19 <!ENTITY vim-download-http "http://ftp.at.vim.org/pub/vim/unix/vim-&vim-version;.tar.bz2">
20 <!ENTITY vim-download-ftp "ftp://ftp.vim.org/pub/vim/unix/vim-&vim-version;.tar.bz2">
21 <!ENTITY vim-md5sum "4ca69757678272f718b1041c810d82d8">
22 <!ENTITY vim-size "6.3 MB">
23 <!ENTITY vim-buildsize "73 MB">
24 <!ENTITY vim-time "0.8 SBU">
25]>
26
27<sect1 id="vim" xreflabel="Vim-&vim-version;">
28 <?dbhtml filename="vim.html"?>
29
30 <sect1info>
31 <othername>$LastChangedBy$</othername>
32 <date>$Date$</date>
33 </sect1info>
34
35 <title>Vim-&vim-version;</title>
36
37 <indexterm zone="vim">
38 <primary sortas="a-Vim">Vim</primary>
39 </indexterm>
40
41 <sect2 role="package">
42 <title>Introduction to Vim</title>
43
44 <para>The <application>Vim</application> package, which is an
45 abbreviation for VI IMproved, contains a <command>vi</command>
46 clone with extra features as compared to the original
47 <command>vi</command>.</para>
48
49 <para>The default LFS instructions install <application>vim</application>
50 as a part of the base system. If you would prefer to link
51 <application>vim</application> against <application>X</application>,
52 you should recompile <application>vim</application> to enable GUI mode.
53 There is no need for special instructions since
54 <application>X</application> support is automatically detected.</para>
55
56 <bridgehead renderas="sect3">Package Information</bridgehead>
57 <itemizedlist spacing="compact">
58 <listitem>
59 <para>Download (HTTP): <ulink url="&vim-download-http;"/></para>
60 </listitem>
61 <listitem>
62 <para>Download (FTP): <ulink url="&vim-download-ftp;"/></para>
63 </listitem>
64 <listitem>
65 <para>Download MD5 sum: &vim-md5sum;</para>
66 </listitem>
67 <listitem>
68 <para>Download size: &vim-size;</para>
69 </listitem>
70 <listitem>
71 <para>Estimated disk space required: &vim-buildsize;</para>
72 </listitem>
73 <listitem>
74 <para>Estimated build time: &vim-time;</para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
79 <itemizedlist spacing='compact'>
80 <listitem>
81 <para>Recommended Patch: <ulink
82 url="&patch-root;/vim-&vim-version;-fixes-14.patch"/></para>
83 </listitem>
84 <listitem>
85 <para>Recommended Patch: <ulink
86 url="&patch-root;/vim-&vim-version;-mandir-1.patch"/></para>
87 </listitem>
88 <listitem>
89 <para>Translated Vim messages: <ulink
90 url="http://ftp.at.vim.org/pub/vim/extra/vim-&vim-version;-lang.tar.gz"/>
91 </para>
92 </listitem>
93 </itemizedlist>
94
95 <bridgehead renderas="sect3">Vim Dependencies</bridgehead>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended"><xref linkend="x-window-system"/></para>
99
100 <bridgehead renderas="sect4">Optional</bridgehead>
101 <para role="optional"><xref linkend="gtk2"/> OR
102 <xref linkend="lesstif"/> OR
103 <xref linkend="GTK"/>,
104 <xref linkend="python"/>,
105 <xref linkend="tcl"/>,
106 <xref linkend="ruby"/>, and
107 <xref linkend="gpm"/></para>
108
109 <para condition="html" role="usernotes">User Notes:
110 <ulink url="&blfs-wiki;/vim"/></para>
111
112 </sect2>
113
114 <sect2 role="installation">
115 <title>Installation of Vim</title>
116
117 <note>
118 <para>If you recompile <application>Vim</application> to link against
119 <application>X</application>, and your <application>X</application>
120 libraries are not on the root partition, you will no longer have an editor
121 for use in emergencies. You may choose to install an additional editor,
122 not link <application>Vim</application> against
123 <application>X</application>, or move the current <command>vim</command>
124 executable to the <filename class="directory">/bin</filename> directory
125 under a different name such as <filename>vi</filename>.</para>
126 </note>
127
128 <para>If desired, unpack the translated messages archive:</para>
129
130<screen><userinput>tar -xf ../vim-&vim-version;-lang.tar.gz --strip-components=1</userinput></screen>
131
132 <para>Install <application>Vim</application> by running the following
133 commands:</para>
134
135<screen><userinput>patch -Np1 -i ../vim-&vim-version;-fixes-14.patch &amp;&amp;
136patch -Np1 -i ../vim-&vim-version;-mandir-1.patch &amp;&amp;
137echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h &amp;&amp;
138echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' &gt;&gt; src/feature.h &amp;&amp;
139./configure --prefix=/usr --with-features=huge &amp;&amp;
140make</userinput></screen>
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 Thses 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.