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