source: postlfs/editors/vim.xml@ be2215e

10.0 10.1 11.0 8.4 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since be2215e was be2215e, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Tag packages in postlfs part

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

  • Property mode set to 100644
File size: 12.6 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.vim.org/vim/unix/vim-&vim-version;.tar.bz2">
8 <!ENTITY vim-download-ftp " ">
9 <!ENTITY vim-md5sum "1739a1df312305155285f0cfa6118294">
10 <!ENTITY vim-size "10.7 MB">
11 <!ENTITY vim-buildsize "92 MB (Add 57 MB for tests)">
12 <!ENTITY vim-time "0.3 SBU (Using parallelism=4; add 1.5 SBU for tests)">
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 &lfs84_checked;
45
46 <bridgehead renderas="sect3">Package Information</bridgehead>
47 <itemizedlist spacing="compact">
48 <listitem>
49 <para>Download (HTTP): <ulink url="&vim-download-http;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download (FTP): <ulink url="&vim-download-ftp;"/></para>
53 </listitem>
54 <listitem>
55 <para>Download MD5 sum: &vim-md5sum;</para>
56 </listitem>
57 <listitem>
58 <para>Download size: &vim-size;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated disk space required: &vim-buildsize;</para>
62 </listitem>
63 <listitem>
64 <para>Estimated build time: &vim-time;</para>
65 </listitem>
66 </itemizedlist>
67
68 <bridgehead renderas="sect3">Vim Dependencies</bridgehead>
69
70 <bridgehead renderas="sect4">Recommended</bridgehead>
71 <para role="recommended">
72 <xref linkend="x-window-system"/> and
73 <xref linkend="gtk2"/>
74 </para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref linkend="gpm"/>,
79 <xref linkend="lua"/>,
80 <xref linkend="python2"/>,
81 <xref linkend="ruby"/>, and
82 <xref linkend="tcl"/>
83 </para>
84
85 <para condition="html" role="usernotes">User Notes:
86 <ulink url="&blfs-wiki;/vim"/></para>
87
88 </sect2>
89
90 <sect2 role="installation">
91 <title>Installation of Vim</title>
92
93 <note>
94 <para>If you recompile <application>Vim</application> to link against
95 <application>X</application> and your <application>X</application>
96 libraries are not on the root partition, you will no longer have an
97 editor for use in emergencies. You may choose to install an additional
98 editor, not link <application>Vim</application> against
99 <application>X</application>, or move the current <command>vim</command>
100 executable to the <filename class="directory">/bin</filename> directory
101 under a different name such as <filename>vi</filename>.</para>
102 </note>
103
104 <para>Install <application>Vim</application> by running the following
105 commands:</para>
106
107<screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h &amp;&amp;
108echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' &gt;&gt; src/feature.h &amp;&amp;
109
110./configure --prefix=/usr \
111 --with-features=huge \
112 --with-tlib=ncursesw &amp;&amp;
113make</userinput></screen>
114
115 <para>To test the results, issue: <command>make test</command>.
116 The <application>vim</application> test suite outputs a lot of binary
117 data to the screen, which can cause issues with the settings of the
118 current terminal. This can be resolved by redirecting the output to a
119 log file. Even if one of the tests fails to produce the file
120 <filename>test.out</filename> in <filename
121 class="directory">src/testdir</filename>, the remaining tests will still
122 be executed. If all goes well,the final message in the log file will be
123 <literal>ALL DONE</literal>. <emphasis>Note</emphasis>: Some color tests
124 expect to be executed under the <command>xterm</command> terminal
125 emulator. Three tests are known to fail occasionally and can be ignored.</para>
126
127 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
128
129<screen role="root"><userinput>make install</userinput></screen>
130
131 <para>By default, Vim's documentation is installed in <filename
132 class="directory">/usr/share/vim</filename>. The following symlink allows
133 the documentation to be accessed via <filename
134 class="directory">/usr/share/doc/vim-&vim-version;</filename>, making it
135 consistent with the location of documentation for other packages:</para>
136
137<!-- When updating, be sure to change the vim-majmin entity for the
138 proper 'vimxx' unpacked directory -->
139
140<screen role="root"><userinput>ln -snfv ../vim/vim&vim-majmin;/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
141
142 <para>If you wish to update the runtime files, issue the
143 following command (requires <xref linkend="rsync"/>):</para>
144
145<screen><userinput>rsync -avzcP --exclude="/dos/" --exclude="/spell/" \
146 ftp.nluug.nl::Vim/runtime/ ./runtime/</userinput></screen>
147
148 <para>To install the runtime files and regenerate the
149 <filename>tags</filename> file, as the
150 <systemitem class="username">root</systemitem> user issue:</para>
151
152<screen role="root"><userinput>make -C src installruntime &amp;&amp;
153vim -c ":helptags /usr/share/doc/vim-&vim-version;" -c ":q"</userinput></screen>
154
155 </sect2>
156
157 <sect2 role="commands">
158 <title>Command Explanations</title>
159
160 <para><parameter>--with-features=huge</parameter>: This switch enables all
161 the additional features available in <application>Vim</application>,
162 including support for multibyte characters.</para>
163
164 <para>
165 <parameter>--with-tlib=ncursesw</parameter>: This switch forces Vim to
166 link against the <filename class="libraryfile">libncursesw</filename>
167 library.
168 </para>
169
170 <para><option>--enable-gui=no</option>: This will prevent compilation of the
171 GUI. <application>Vim</application> will still link against
172 <application>X</application>, so that some features such as the client-server
173 model or the x11-selection (clipboard) are still available.</para>
174
175 <para><option>--without-x</option>: If you prefer not to link
176 <application>Vim</application> against <application>X</application>, use
177 this switch.</para>
178
179 <para><option>--enable-perlinterp</option>, <option>--enable-pythoninterp</option>,
180 <option>--enable-tclinterp</option>, <option>--enable-rubyinterp</option>:
181 These options include the Perl, Python, Tcl, or Ruby interpreters that allow
182 using other application code in <application>vim</application> scripts.</para>
183
184 </sect2>
185
186 <sect2 role="configuration">
187 <title>Configuring Vim</title>
188
189 <sect3 id='vim-config'>
190 <title>Config Files</title>
191
192 <para><filename>/etc/vimrc</filename> and
193 <filename>~/.vimrc</filename></para>
194
195 <indexterm zone="vim vim-config">
196 <primary sortas="e-etc-vimrc">/etc/vimrc</primary>
197 </indexterm>
198
199 <indexterm zone="vim vim-config">
200 <primary sortas="e-AA.vimrc">~/.vimrc</primary>
201 </indexterm>
202
203 </sect3>
204
205 <sect3 id='vim-desktop'>
206 <title>Desktop File</title>
207
208 <para>
209 If desired, create a menu entry for graphical vim,
210 <filename>gvim.desktop</filename>, as the <systemitem
211 class="username">root</systemitem> user
212 </para>
213
214<screen role="root"><userinput>cat &gt; /usr/share/applications/gvim.desktop &lt;&lt; "EOF"
215<literal>[Desktop Entry]
216Name=GVim Text Editor
217Comment=Edit text files
218Comment[pt_BR]=Edite arquivos de texto
219TryExec=gvim
220Exec=gvim -f %F
221Terminal=false
222Type=Application
223Icon=gvim.png
224Categories=Utility;TextEditor;
225StartupNotify=true
226MimeType=text/plain;</literal>
227EOF</userinput></screen>
228
229 </sect3>
230
231 <sect3 id='vim-init'>
232 <title>Configuration Information</title>
233
234 <para><application>Vim</application> has an integrated spell checker
235 which you can enable it if you issue the following in a vim window:
236 </para>
237
238<screen><literal>:setlocal spell spelllang=ru</literal></screen>
239
240 <para>This setting will enable spell checking for the Russian
241 language for the current session.</para>
242
243 <para>By default, <application>Vim</application> only installs spell
244 files for the English language. If a spell file is not available for
245 a language, then <application>Vim</application> will call the
246 <filename>$VIMRUNTIME/plugin/spellfile.vim</filename> plugin and will try
247 to obtain the *.spl and optionally *.sug from the vim ftp server,
248 by using the <filename>$VIMRUNTIME/plugin/netrwPlugin.vim</filename>
249 plugin.</para>
250
251<!-- When updating, be sure to change the line below for the proper 'vimxx' unpacked
252 directory -->
253 <para>Alternatively you can manually download the *.spl and *.sug files
254 from: <ulink url="ftp://ftp.vim.org/pub/vim/runtime/spell/"/> and save
255 them to <filename class="directory"> ~/.vim/spell </filename> or in
256 <filename class="directory">/usr/share/vim/vim&vim-majmin;/spell/</filename>.</para>
257
258 <para>To find out what's new in <application>Vim-&vim-version;</application>
259 issue the following command:</para>
260
261<screen><literal>:help version-&vim-version;</literal></screen>
262
263 <para>For additional information on setting up
264 <application>Vim</application> configuration files, see <xref
265 linkend="postlfs-config-vimrc"/> and <ulink
266 url='http://vim.wikia.com/wiki/Example_vimrc'/>.</para>
267
268 </sect3>
269
270 </sect2>
271
272 <sect2 role="content">
273 <title>Contents</title>
274
275 <para>A list of the reinstalled files, along with their short
276 descriptions can be found in the <ulink
277 url="&lfs-root;/chapter06/vim.html#contents-vim">LFS Vim Installation
278 Instructions</ulink></para>
279
280 <segmentedlist>
281 <segtitle>Installed Programs</segtitle>
282 <segtitle>Installed Libraries</segtitle>
283 <segtitle>Installed Directory</segtitle>
284
285 <seglistitem>
286 <seg>gview, gvim, gvimdiff, rgview, and rgvim</seg>
287 <seg>None</seg>
288 <seg>/usr/share/vim</seg>
289 </seglistitem>
290 </segmentedlist>
291
292 <variablelist>
293 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
294 <?dbfo list-presentation="list"?>
295 <?dbhtml list-presentation="table"?>
296
297 <varlistentry id="gview">
298 <term><command>gview</command></term>
299 <listitem>
300 <para>starts <command>gvim</command> in read-only mode.</para>
301 <indexterm zone="vim gview">
302 <primary sortas="b-gview">gview</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="gvim">
308 <term><command>gvim</command></term>
309 <listitem>
310 <para>is the editor that runs under <application>X</application>
311 and includes a GUI.</para>
312 <indexterm zone="vim gvim">
313 <primary sortas="b-gvim">gvim</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="gvimdiff">
319 <term><command>gvimdiff</command></term>
320 <listitem>
321 <para>edits two or three versions of a file with
322 <command>gvim</command> and shows the differences.</para>
323 <indexterm zone="vim gvimdiff">
324 <primary sortas="b-gvimdiff">gvimdiff</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="rgview">
330 <term><command>rgview</command></term>
331 <listitem>
332 <para>is a restricted version of <command>gview</command>.</para>
333 <indexterm zone="vim rgview">
334 <primary sortas="b-rgview">rgview</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="rgvim">
340 <term><command>rgvim</command></term>
341 <listitem>
342 <para>is a restricted version of <command>gvim</command>. </para>
343 <indexterm zone="vim gvim">
344 <primary sortas="b-gvim">gvim</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 </variablelist>
350
351 </sect2>
352
353</sect1>
Note: See TracBrowser for help on using the repository browser.