mirror of
https://git.linuxfromscratch.org/lfs.git
synced 2025-01-21 06:28:02 +00:00
df8334f924
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@3646 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
303 lines
10 KiB
XML
303 lines
10 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../general.ent">
|
|
%general-entities;
|
|
]>
|
|
<sect1 id="ch-system-vim" xreflabel="Vim" role="wrap">
|
|
<title>Vim-&vim-version;</title>
|
|
<?dbhtml filename="vim.html"?>
|
|
|
|
<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>0.4 SBU</seg><seg>34 MB</seg></seglistitem>
|
|
</segmentedlist>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Vim installation depends on</segtitle>
|
|
<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
|
|
GCC, Glibc, Grep, Make, Ncurses, Sed</seg></seglistitem>
|
|
</segmentedlist>
|
|
|
|
<tip>
|
|
<title>Alternatives to Vim</title>
|
|
<para>If you prefer another editor -- like Emacs, Joe, or Nano -- to Vim,
|
|
have a look at <ulink url="&blfs-root;view/stable/postlfs/editors.html"/> for
|
|
suggested installation instructions.</para>
|
|
</tip>
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of Vim</title>
|
|
|
|
<para>First change the default locations of the <filename>vimrc</filename> and
|
|
<filename>gvimrc</filename> configuration files to <filename class="directory">/etc</filename>.</para>
|
|
|
|
<screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' >> src/feature.h
|
|
echo '#define SYS_GVIMRC_FILE "/etc/gvimrc"' >> src/feature.h</userinput></screen>
|
|
|
|
<para>Now prepare Vim for compilation:</para>
|
|
|
|
<screen><userinput>./configure --prefix=/usr --enable-multibyte</userinput></screen>
|
|
|
|
<para>The optional <userinput>--enable-multibyte</userinput> switch
|
|
includes multibyte editing support into
|
|
vim. It is only needed for those people who ignore our recommendation not to
|
|
use LFS in locales with multibyte character sets, but it does not hurt
|
|
others.</para>
|
|
|
|
<para>Compile the package:</para>
|
|
|
|
<screen><userinput>make</userinput></screen>
|
|
|
|
<para>To test the results, you can issue:
|
|
<userinput>make test</userinput>. However, this test suite outputs a lot of
|
|
seemingly garbage characters to the screen, and this can wreak havoc with the
|
|
settings of the current terminal. Therefore the running of the test suite here
|
|
is strictly optional.</para>
|
|
|
|
<para>Now install the package:</para>
|
|
|
|
<screen><userinput>make install</userinput></screen>
|
|
|
|
<para>Many users are used to using <command>vi</command>, instead of
|
|
<command>vim</command>. To let them execute <command>vim</command> when
|
|
they habitually enter <command>vi</command>, create a symlink:</para>
|
|
|
|
<screen><userinput>ln -s vim /usr/bin/vi</userinput></screen>
|
|
|
|
<para>If you are going to install the X Window system on your LFS system, you
|
|
may want to re-compile Vim after having installed X. Vim comes with a nice GUI
|
|
version of the editor that requires X and a few other libraries to be
|
|
installed. For more information read the Vim documentation.</para>
|
|
|
|
</sect2>
|
|
|
|
|
|
<sect2 id="conf-vim" role="configuration"><title>Configuring Vim</title>
|
|
<indexterm zone="conf-vim"><primary sortas="e-/etc/vim">/etc/vim</primary></indexterm>
|
|
|
|
<para>By default, <command>vim</command> runs in vi-incompatible mode. Some
|
|
people might not like this, but we prefer to run <command>vim</command> in its
|
|
own mode (else we wouldn't have included it in this book, but the original
|
|
<command>vi</command>). We've included the setting of "nocompatible"
|
|
below to high-light the fact that the new behavior is being used. It
|
|
also reminds those who would change to "compatible" mode that it should
|
|
appear first because it changes other settings and overrides must come
|
|
after this setting. Create a default vim configuration file by running
|
|
the following:</para>
|
|
|
|
<screen><userinput>cat > /etc/vimrc << "EOF"</userinput>
|
|
" Begin /etc/vimrc
|
|
|
|
set nocompatible
|
|
set backspace=2
|
|
syntax on
|
|
|
|
" End /etc/vimrc
|
|
<userinput>EOF</userinput></screen>
|
|
|
|
<para>The <emphasis>set nocompatible</emphasis> makes
|
|
<command>vim</command> behave in a more useful way (the default) than the
|
|
vi-compatible manner. Remove the "no" if you want the old <command>vi</command>
|
|
behavior. The <emphasis>set backspace=2</emphasis> allows
|
|
backspacing over line breaks, autoindents and the start of insert. The
|
|
<emphasis>syntax on</emphasis> enables <command>vim</command>'s
|
|
semantic coloring.</para>
|
|
|
|
<para>Documentation for other available options can be obtained by running
|
|
the following command:</para>
|
|
|
|
<screen><userinput>vim -c ':options'</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
|
|
<sect2 id="contents-vim" role="content"><title>Contents of Vim</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed programs</segtitle>
|
|
<seglistitem><seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
|
|
pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl, tcltags, vi (link to vim),
|
|
view (link to vim), vim, vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh,
|
|
vimtutor and xxd</seg></seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist><title>Short descriptions</title>
|
|
|
|
<varlistentry>
|
|
<term id="efm_filter.pl"><command>efm_filter.pl</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim efm_filter.pl"><primary sortas="b-efm_filter.pl">efm_filter.pl</primary></indexterm>
|
|
<para>is a filter for creating an error file that can be read by vim.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="efm_perl.pl"><command>efm_perl.pl</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim efm_perl.pl"><primary sortas="b-efm_perl.pl">efm_perl.pl</primary></indexterm>
|
|
<para>reformats the error messages of the
|
|
Perl interpreter for use with the <quote>quickfix</quote> mode of vim.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="ex"><command>ex</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim ex"><primary sortas="b-ex">ex</primary></indexterm>
|
|
<para>starts vim in ex mode.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="less.sh"><command>less.sh</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim less.sh"><primary sortas="b-less.sh">less.sh</primary></indexterm>
|
|
<para>is a script that starts vim with less.vim.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="mve.awk"><command>mve.awk</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim mve.awk"><primary sortas="b-mve.awk">mve.awk</primary></indexterm>
|
|
<para>processes vim errors.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="pltags.pl"><command>pltags.pl</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim pltags.pl"><primary sortas="b-pltags.pl">pltags.pl</primary></indexterm>
|
|
<para>creates a tags file for perl code, for use by vim.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="ref"><command>ref</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim ref"><primary sortas="b-ref">ref</primary></indexterm>
|
|
<para>checks the spelling of arguments.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="rview"><command>rview</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim rview"><primary sortas="b-rview">rview</primary></indexterm>
|
|
<para>is a restricted version of view: no shell
|
|
commands can be started and view can't be suspended.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="rvim"><command>rvim</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim rvim"><primary sortas="b-rvim">rvim</primary></indexterm>
|
|
<para>is a restricted version of vim: no shell
|
|
commands can be started and vim can't be suspended.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="shtags.pl"><command>shtags.pl</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim shtags.pl"><primary sortas="b-shtags.pl">shtags.pl</primary></indexterm>
|
|
<para>generates a tag file for perl scripts.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="tcltags"><command>tcltags</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim tcltags"><primary sortas="b-tcltags">tcltags</primary></indexterm>
|
|
<para>generates a tag file for TCL code.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="view"><command>view</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim view"><primary sortas="b-view">view</primary></indexterm>
|
|
<para>starts vim in read-only mode.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vim"><command>vim</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vim"><primary sortas="b-vim">vim</primary></indexterm>
|
|
<para>is the editor.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vim132"><command>vim132</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vim132"><primary sortas="b-vim132">vim132</primary></indexterm>
|
|
<para>starts vim with the terminal in 132-column mode.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vim2html.pl"><command>vim2html.pl</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vim2html.pl"><primary sortas="b-vim2html.pl">vim2html.pl</primary></indexterm>
|
|
<para>converts vim documentation to HTML.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vimdiff"><command>vimdiff</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vimdiff"><primary sortas="b-vimdiff">vimdiff</primary></indexterm>
|
|
<para>edits two or three versions of a file with vim and show differences.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vimm"><command>vimm</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vimm"><primary sortas="b-vimm">vimm</primary></indexterm>
|
|
<para>enables the DEC locator input model on a remote terminal.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vimspell.sh"><command>vimspell.sh</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vimspell.sh"><primary sortas="b-vimspell.sh">vimspell.sh</primary></indexterm>
|
|
<para>is a script which spells a file and generates the syntax statements necessary
|
|
to highlight in vim. This script requires the old Unix <command>spell</command>
|
|
command, which is provided neither in LFS nor in BLFS.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="vimtutor"><command>vimtutor</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim vimtutor"><primary sortas="b-vimtutor">vimtutor</primary></indexterm>
|
|
<para>teaches you the basic keys and commands of vim.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term id="xxd"><command>xxd</command></term>
|
|
<listitem>
|
|
<indexterm zone="ch-system-vim xxd"><primary sortas="b-xxd">xxd</primary></indexterm>
|
|
<para>makes a hex dump of the given file. It can
|
|
also do the reverse, so it can be used for binary patching.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|