123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309 |
- <?xml version="1.0" encoding="ISO-8859-1"?>
- <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
- <!ENTITY % general-entities SYSTEM "../general.ent">
- %general-entities;
- ]>
- <sect1 id="ch-system-vim" role="wrap">
- <?dbhtml filename="vim.html"?>
- <sect1info condition="script">
- <productname>vim</productname>
- <productnumber>&vim-version;</productnumber>
- <address>&vim-url;</address>
- </sect1info>
- <title>Vim-&vim-version;</title>
- <indexterm zone="ch-system-vim">
- <primary sortas="a-Vim">Vim</primary>
- </indexterm>
- <sect2 role="package">
- <title/>
- <para>The Vim package contains a powerful text editor.</para>
- <segmentedlist>
- <segtitle>&buildtime;</segtitle>
- <segtitle>&diskspace;</segtitle>
- <seglistitem>
- <seg>&vim-fin-sbu;</seg>
- <seg>&vim-fin-du;</seg>
- </seglistitem>
- </segmentedlist>
- <tip>
- <title>Alternatives to Vim</title>
- <para>If you prefer another editor—such as Emacs, Joe, or
- Nano—please refer to <ulink
- url="&blfs-book;postlfs/editors.html"/> for suggested
- installation instructions.</para>
- </tip>
- </sect2>
- <sect2 role="installation">
- <title>Installation of Vim</title>
- <para>First, change the default location of the <filename>vimrc</filename>
- configuration file to <filename class="directory">/etc</filename>:</para>
- <screen><userinput remap="pre">echo '#define SYS_VIMRC_FILE "/etc/vimrc"' >> src/feature.h</userinput></screen>
- <para>Prepare vim for compilation:</para>
- <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
- <para>Compile the package:</para>
- <screen><userinput remap="make">make</userinput></screen>
- <para>To prepare the tests, ensure that user
- <systemitem class="username">tester</systemitem> can write
- to the source tree:</para>
- <screen><userinput remap="test">chown -Rv tester .</userinput></screen>
- <para>Now run the tests as user <systemitem
- class="username">tester</systemitem>:</para>
- <screen><userinput remap="test">su tester -c "LANG=en_US.UTF-8 make -j1 test" &> vim-test.log</userinput></screen>
- <para>The test suite outputs a lot of binary data to the screen. This can
- cause issues with the settings of the current terminal. The problem can be
- avoided by redirecting the output to a log file as shown above. A
- successful test will result in the words "ALL DONE" in the log file
- at completion.</para>
- <para>Install the package:</para>
- <screen><userinput remap="install">make install</userinput></screen>
- <para>Many users are used to using <command>vi</command> instead of
- <command>vim</command>. To allow execution of <command>vim</command>
- when users habitually enter <command>vi</command>, create a
- symlink for both the binary and the man page in the provided
- languages:</para>
- <screen><userinput remap="install">ln -sv vim /usr/bin/vi
- for L in /usr/share/man/{,*/}man1/vim.1; do
- ln -sv vim.1 $(dirname $L)/vi.1
- done</userinput></screen>
- <para>By default, vim's documentation is installed in <filename
- class="directory">/usr/share/vim</filename>. The following symlink
- allows the documentation to be accessed via <filename
- class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
- it consistent with the location of documentation for other packages:</para>
- <screen><userinput remap="install">ln -sv ../&vim-docdir;/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
- <para>If an X Window System is going to be installed on the LFS
- system, it may be necessary to recompile vim after installing X. Vim
- comes with a GUI version of the editor that requires X and some
- additional libraries to be installed. For more information on this
- process, refer to the vim documentation and the vim installation page
- in the BLFS book at <ulink
- url="&blfs-book;postlfs/vim.html"/>.</para>
- </sect2>
- <sect2 id="conf-vim" role="configuration">
- <title>Configuring Vim</title>
- <indexterm zone="conf-vim">
- <primary sortas="e-/etc/vimrc">/etc/vimrc</primary>
- </indexterm>
- <para>By default, <command>vim</command> runs in vi-incompatible mode.
- This may be new to users who have used other editors in the past. The
- <quote>nocompatible</quote> setting is included below to highlight the
- fact that a new behavior is being used. It also reminds those who would
- change to <quote>compatible</quote> mode that it should be the first
- setting in the configuration file. This is necessary because it changes
- other settings, and overrides must come after this setting. Create a default
- <command>vim</command> configuration file by running the following:</para>
- <screen><userinput>cat > /etc/vimrc << "EOF"
- <literal>" Begin /etc/vimrc
- " Ensure defaults are set before customizing settings, not after
- source $VIMRUNTIME/defaults.vim
- let skip_defaults_vim=1
- set nocompatible
- set backspace=2
- set mouse=
- syntax on
- if (&term == "xterm") || (&term == "putty")
- set background=dark
- endif
- " End /etc/vimrc</literal>
- EOF</userinput></screen>
- <para>The <parameter>set nocompatible</parameter> setting makes
- <command>vim</command> behave in a more useful way (the default) than the
- vi-compatible manner. Remove the <quote>no</quote> to keep the old
- <command>vi</command> behavior. The <parameter>set backspace=2</parameter>
- setting allows backspacing over line breaks, autoindents, and the start of
- an insert. The <parameter>syntax on</parameter> parameter enables vim's syntax
- highlighting. The <parameter>set mouse=</parameter> setting enables
- proper pasting of text with the mouse when working in chroot or over a
- remote connection. Finally, the <emphasis>if</emphasis> statement with the
- <parameter>set background=dark</parameter> setting corrects
- <command>vim</command>'s guess about the background color of some terminal
- emulators. This gives the highlighting a better color scheme for use on the
- black background of these programs.</para>
- <para>Documentation for other available options can be obtained by
- running the following command:</para>
- <screen role="nodump"><userinput>vim -c ':options'</userinput></screen>
- <note>
- <para>By default, vim only installs spell files for the English language.
- To install spell files for your preferred language, download the
- <filename>*.spl</filename> and optionally, the <filename>*.sug</filename>
- files for your language and character encoding from <ulink
- url="ftp://ftp.vim.org/pub/vim/runtime/spell/"/> and save them to
- <filename class='directory'>/usr/share/&vim-docdir;/spell/</filename>.</para>
- <para>To use these spell files, some configuration in
- <filename>/etc/vimrc</filename> is needed, e.g.:</para>
- <screen><literal>set spelllang=en,ru
- set spell</literal></screen>
- <para>For more information, see the appropriate README file located
- at the URL above.</para>
- </note>
- </sect2>
- <sect2 id="contents-vim" role="content">
- <title>Contents of Vim</title>
- <segmentedlist>
- <segtitle>Installed programs</segtitle>
- <segtitle>Installed directory</segtitle>
- <seglistitem>
- <seg> ex (link to vim), rview (link to vim), rvim (link to vim), vi
- (link to vim), view (link to vim), vim, vimdiff (link to vim), vimtutor,
- and xxd</seg>
- <seg>/usr/share/vim</seg>
- </seglistitem>
- </segmentedlist>
- <variablelist>
- <bridgehead renderas="sect3">Short Descriptions</bridgehead>
- <?dbfo list-presentation="list"?>
- <?dbhtml list-presentation="table"?>
- <varlistentry id="ex">
- <term><command>ex</command></term>
- <listitem>
- <para>Starts <command>vim</command> in ex mode</para>
- <indexterm zone="ch-system-vim ex">
- <primary sortas="b-ex">ex</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="rview">
- <term><command>rview</command></term>
- <listitem>
- <para>Is a restricted version of <command>view</command>; no shell
- commands can be started and <command>view</command> cannot be
- suspended</para>
- <indexterm zone="ch-system-vim rview">
- <primary sortas="b-rview">rview</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="rvim">
- <term><command>rvim</command></term>
- <listitem>
- <para>Is a restricted version of <command>vim</command>; no shell
- commands can be started and <command>vim</command> cannot be
- suspended</para>
- <indexterm zone="ch-system-vim rvim">
- <primary sortas="b-rvim">rvim</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="vi">
- <term><command>vi</command></term>
- <listitem>
- <para>Link to <command>vim</command></para>
- <indexterm zone="ch-system-vim vi">
- <primary sortas="b-vi">vi</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="view">
- <term><command>view</command></term>
- <listitem>
- <para>Starts <command>vim</command> in read-only mode</para>
- <indexterm zone="ch-system-vim view">
- <primary sortas="b-view">view</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="vim">
- <term><command>vim</command></term>
- <listitem>
- <para>Is the editor</para>
- <indexterm zone="ch-system-vim vim">
- <primary sortas="b-vim">vim</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="vimdiff">
- <term><command>vimdiff</command></term>
- <listitem>
- <para>Edits two or three versions of a file with <command>vim</command>
- and shows differences</para>
- <indexterm zone="ch-system-vim vimdiff">
- <primary sortas="b-vimdiff">vimdiff</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="vimtutor">
- <term><command>vimtutor</command></term>
- <listitem>
- <para>Teaches the basic keys and commands of
- <command>vim</command></para>
- <indexterm zone="ch-system-vim vimtutor">
- <primary sortas="b-vimtutor">vimtutor</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="xxd">
- <term><command>xxd</command></term>
- <listitem>
- <para>Creates a hex dump of the given file; it can
- also do the reverse, so it can be used for binary patching</para>
- <indexterm zone="ch-system-vim xxd">
- <primary sortas="b-xxd">xxd</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- </sect1>
|