Changeset 81fd230 for chapter06/vim.xml


Ignore:
Timestamp:
02/19/2005 10:16:42 PM (19 years ago)
Author:
Gerard Beekmans <gerard@…>
Branches:
10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 6.1, 6.1.1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
Children:
3d31fc4
Parents:
2f9131f
Message:

Trunk is now identical to Testing

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@4648 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

File:
1 edited

Legend:

Unmodified
Added
Removed

  • chapter06/vim.xml

    r2f9131f r81fd230  
    44  %general-entities;
    55]>
    6 <sect1 id="ch-system-vim" xreflabel="Vim" role="wrap">
     6<sect1 id="ch-system-vim" role="wrap">
    77<title>Vim-&vim-version;</title>
    88<?dbhtml filename="vim.html"?>
    … …  
    1111
    1212<sect2 role="package"><title/>
     13<para>The Vim package contains a powerful text editor.</para>
    1314
    1415<segmentedlist>
    … …  
    1819</segmentedlist>
    1920
     21<segmentedlist>
     22<segtitle>Vim installation depends on</segtitle>
     23<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
     24GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
     25</segmentedlist>
     26
     27<tip>
     28<title>Alternatives to Vim</title>
     29<para>If you prefer another editor&mdash;such as Emacs, Joe, or
     30Nano&mdash;please refer to <ulink url="&blfs-root;view/svn/postlfs/editors.html"/>
     31for suggested installation instructions.</para>
     32</tip>
    2033</sect2>
    2134
    … …  
    2336<title>Installation of Vim</title>
    2437
    25 <para>Change the default locations of the configuration files:</para>
     38<para>First, unpack both
     39<filename>vim-&vim-version;.tar.bz2</filename> and (optionally)
     40<filename>vim-&vim-version;-lang.tar.gz</filename> archives into the
     41same directory. Then, change the default locations of the
     42<filename>vimrc</filename> and <filename>gvimrc</filename>
     43configuration files to <filename
     44class="directory">/etc</filename>:</para>
    2645
    2746<screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h
    … …  
    3756<screen><userinput>./configure --prefix=/usr --enable-multibyte</userinput></screen>
    3857
     58<para>The optional but highly recommended
     59<parameter>--enable-multibyte</parameter> switch includes support for
     60editing files in multibyte character encodings into
     61<command>vim</command>.  This is needed if using a locale with
     62a multibyte character set. This switch is also helpful to be able to
     63edit text files initially created in Linux distributions like Fedora
     64Core that use UTF-8 as a default character set.</para>
     65
    3966<para>Compile the package:</para>
    4067
    … …  
    4269
    4370<para>To test the results, issue:
    44 <userinput>make test</userinput></para>
    45 
    46 <para>Now install the package:</para>
     71<userinput>make test</userinput>. However, this test suite outputs a
     72lot of chaotic characters to the screen, which can cause issues with
     73the settings of the current terminal. Therefore, running the test
     74suite here is optional.</para>
     75
     76<para>Install the package:</para>
    4777
    4878<screen><userinput>make install</userinput></screen>
    4979
    50 <para>Create a symlink:</para>
     80<para>Many users are used to using <command>vi</command> instead of
     81<command>vim</command>. To allow execution of <command>vim</command>
     82when users habitually enter <command>vi</command>, create a
     83symlink:</para>
    5184
    5285<screen><userinput>ln -s vim /usr/bin/vi</userinput></screen>
    5386
     87<para>If the X Window System is going to be installed on the LFS
     88system, it may be necessary to recompile Vim after installing X. Vim
     89comes with a GUI version of the editor that requires X and some
     90additional libraries to be installed. For more information on this
     91process, refer to the Vim documentation and the Vim installation page
     92in the BLFS book at <ulink
     93url="&blfs-root;view/svn/postlfs/editors.html#postlfs-editors-vim"/>.</para>
     94
    5495</sect2>
    5596
    56 
    5797<sect2 id="conf-vim" role="configuration"><title>Configuring Vim</title>
    58 
    59 <para>Create a default vim configuration file by running
    60 the following:</para>
     98<indexterm zone="conf-vim"><primary sortas="e-/etc/vim">/etc/vim</primary></indexterm>
     99
     100<para>By default, <command>vim</command> runs in vi-incompatible mode.
     101This may be new to users who have used other editors in the past. The
     102<quote>nocompatible</quote> setting is included below to highlight the
     103fact that a new behavior is being used. It also reminds those who
     104would change to <quote>compatible</quote> mode that it should appear
     105first.  This is necessary because it changes other settings, and
     106overrides must come after this setting.  Create a default <command>vim</command>
     107configuration file by running the following:</para>
    61108
    62109<screen><userinput>cat &gt; /etc/vimrc &lt;&lt; "EOF"
    … …  
    66113set backspace=2
    67114syntax on
    68 <!-- set fileencodings=ucs-bom,utf-8,<replaceable>[your-8-bit-charset]</replaceable> -->
    69115if (&amp;term == "iterm") || (&amp;term == "putty")
    70116  set background=dark
    … …  
    74120EOF</userinput></screen>
    75121
    76 <!-- XXX: the ascii-only files are considered to be in utf-8 - that's not what
    77 one expects . That's why fileencodings stuff is commented out for now
    78 
    79 The <parameter>set fileencodings=...</parameter> makes
    80 <command>vim</command> capable of automatically detecting the character
    81 set of the file being edited (replace
    82 "<replaceable>[your-8-bit-charset]</replaceable>"
    83 with the value appropriate for your country, e.g. iso-8859-15 in Italy).
    84 This line is useful because bleeding-edge distributions
    85 like Fedora Core use UTF-8, and conservative ones like Debian
    86 use traditional 8-bit encodings for text files. If you have not
    87 passed the <parameter>- -enable-multibyte</parameter> switch to the
    88 <command>./configure</command> command above, this line will not work. -->
    89 
    90 <para>Documentation for other available options can be obtained by running
    91 the following command:</para>
     122<para>The <parameter>set nocompatible</parameter> makes
     123<command>vim</command> behave in a more useful way (the default) than
     124the vi-compatible manner. Remove the <quote>no</quote> to keep the
     125old <command>vi</command> behavior. The <parameter>set
     126backspace=2</parameter> allows backspacing over line breaks,
     127autoindents, and the start of insert. The <parameter>syntax
     128on</parameter> enables vim's syntax highlighting. Finally, the
     129<emphasis>if</emphasis> statement with the <parameter>set
     130background=dark</parameter> corrects <command>vim</command>'s guess
     131about the background color of some terminal emulators. This gives the
     132highlighting a better color scheme for use on the black background of
     133these programs.</para>
     134
     135<para>Documentation for other available options can be obtained by
     136running the following command:</para>
    92137
    93138<screen><userinput>vim -c ':options'</userinput></screen>
    … …  
    95140</sect2>
    96141
    97 
    98142<sect2 id="contents-vim" role="content"><title>Contents of Vim</title>
    99143
    100 <para>See testing</para>
     144<segmentedlist>
     145<segtitle>Installed programs</segtitle>
     146<seglistitem><seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
     147pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl, tcltags, vi (link to vim),
     148view (link to vim), vim, vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh,
     149vimtutor, and xxd</seg></seglistitem>
     150</segmentedlist>
     151
     152<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
     153<?dbfo list-presentation="list"?>
     154
     155<varlistentry id="efm_filter.pl">
     156<term><command>efm_filter.pl</command></term>
     157<listitem>
     158<para>A filter for creating an error file that can be read by <command>vim</command></para>
     159<indexterm zone="ch-system-vim efm_filter.pl"><primary sortas="b-efm_filter.pl">efm_filter.pl</primary></indexterm>
     160</listitem>
     161</varlistentry>
     162
     163<varlistentry id="efm_perl.pl">
     164<term><command>efm_perl.pl</command></term>
     165<listitem>
     166<para>Reformats the error messages of the
     167Perl interpreter for use with the <quote>quickfix</quote> mode of <command>vim</command></para>
     168<indexterm zone="ch-system-vim efm_perl.pl"><primary sortas="b-efm_perl.pl">efm_perl.pl</primary></indexterm>
     169</listitem>
     170</varlistentry>
     171
     172<varlistentry id="ex">
     173<term><command>ex</command></term>
     174<listitem>
     175<para>Starts <command>vim</command> in ex mode</para>
     176<indexterm zone="ch-system-vim ex"><primary sortas="b-ex">ex</primary></indexterm>
     177</listitem>
     178</varlistentry>
     179
     180<varlistentry id="less.sh">
     181<term><command>less.sh</command></term>
     182<listitem>
     183<para>A script that starts <command>vim</command> with less.vim</para>
     184<indexterm zone="ch-system-vim less.sh"><primary sortas="b-less.sh">less.sh</primary></indexterm>
     185</listitem>
     186</varlistentry>
     187
     188<varlistentry id="mve.awk">
     189<term><command>mve.awk</command></term>
     190<listitem>
     191<para>Processes <command>vim</command> errors</para>
     192<indexterm zone="ch-system-vim mve.awk"><primary sortas="b-mve.awk">mve.awk</primary></indexterm>
     193</listitem>
     194</varlistentry>
     195
     196<varlistentry id="pltags.pl">
     197<term><command>pltags.pl</command></term>
     198<listitem>
     199<para>Creates a tags file for Perl code for use by <command>vim</command></para>
     200<indexterm zone="ch-system-vim pltags.pl"><primary sortas="b-pltags.pl">pltags.pl</primary></indexterm>
     201</listitem>
     202</varlistentry>
     203
     204<varlistentry id="ref">
     205<term><command>ref</command></term>
     206<listitem>
     207<para>Checks the spelling of arguments</para>
     208<indexterm zone="ch-system-vim ref"><primary sortas="b-ref">ref</primary></indexterm>
     209</listitem>
     210</varlistentry>
     211
     212<varlistentry id="rview">
     213<term><command>rview</command></term>
     214<listitem>
     215<para>Is a restricted version of <command>view</command>; no shell
     216commands can be started and <command>view</command> cannot be suspended</para>
     217<indexterm zone="ch-system-vim rview"><primary sortas="b-rview">rview</primary></indexterm>
     218</listitem>
     219</varlistentry>
     220
     221<varlistentry id="rvim">
     222<term><command>rvim</command></term>
     223<listitem>
     224<para>Is a restricted version of <command>vim</command>; no shell
     225commands can be started and <command>vim</command> cannot be suspended</para>
     226<indexterm zone="ch-system-vim rvim"><primary sortas="b-rvim">rvim</primary></indexterm>
     227</listitem>
     228</varlistentry>
     229
     230<varlistentry id="shtags.pl">
     231<term><command>shtags.pl</command></term>
     232<listitem>
     233<para>Generates a tag file for Perl scripts</para>
     234<indexterm zone="ch-system-vim shtags.pl"><primary sortas="b-shtags.pl">shtags.pl</primary></indexterm>
     235</listitem>
     236</varlistentry>
     237
     238<varlistentry id="tcltags">
     239<term><command>tcltags</command></term>
     240<listitem>
     241<para>Generates a tag file for TCL code</para>
     242<indexterm zone="ch-system-vim tcltags"><primary sortas="b-tcltags">tcltags</primary></indexterm>
     243</listitem>
     244</varlistentry>
     245
     246<varlistentry id="view">
     247<term><command>view</command></term>
     248<listitem>
     249<para>Starts <command>vim</command> in read-only mode</para>
     250<indexterm zone="ch-system-vim view"><primary sortas="b-view">view</primary></indexterm>
     251</listitem>
     252</varlistentry>
     253
     254<varlistentry id="vi">
     255<term><command>vi</command></term>
     256<listitem>
     257<para>Is the editor</para>
     258<indexterm zone="ch-system-vim vi"><primary sortas="b-vi">vi</primary></indexterm>
     259</listitem>
     260</varlistentry>
     261
     262<varlistentry id="vim">
     263<term><command>vim</command></term>
     264<listitem>
     265<para>Is the editor</para>
     266<indexterm zone="ch-system-vim vim"><primary sortas="b-vim">vim</primary></indexterm>
     267</listitem>
     268</varlistentry>
     269
     270<varlistentry id="vim132">
     271<term><command>vim132</command></term>
     272<listitem>
     273<para>Starts <command>vim</command> with the terminal in 132-column mode</para>
     274<indexterm zone="ch-system-vim vim132"><primary sortas="b-vim132">vim132</primary></indexterm>
     275</listitem>
     276</varlistentry>
     277
     278<varlistentry id="vim2html.pl">
     279<term><command>vim2html.pl</command></term>
     280<listitem>
     281<para>Converts Vim documentation to HypterText Markup Language (HTML)</para>
     282<indexterm zone="ch-system-vim vim2html.pl"><primary sortas="b-vim2html.pl">vim2html.pl</primary></indexterm>
     283</listitem>
     284</varlistentry>
     285
     286<varlistentry id="vimdiff">
     287<term><command>vimdiff</command></term>
     288<listitem>
     289<para>Edits two or three versions of a file with <command>vim</command> and show differences</para>
     290<indexterm zone="ch-system-vim vimdiff"><primary sortas="b-vimdiff">vimdiff</primary></indexterm>
     291</listitem>
     292</varlistentry>
     293
     294<varlistentry id="vimm">
     295<term><command>vimm</command></term>
     296<listitem>
     297<para>Enables the DEC locator input model on a remote terminal</para>
     298<indexterm zone="ch-system-vim vimm"><primary sortas="b-vimm">vimm</primary></indexterm>
     299</listitem>
     300</varlistentry>
     301
     302<varlistentry id="vimspell.sh">
     303<term><command>vimspell.sh</command></term>
     304<listitem>
     305<para>Spells a file and generates the syntax statements necessary
     306to highlight in <command>vim</command>. This script requires the old Unix <command>spell</command>
     307command, which is provided neither in LFS nor in BLFS</para>
     308<indexterm zone="ch-system-vim vimspell.sh"><primary sortas="b-vimspell.sh">vimspell.sh</primary></indexterm>
     309</listitem>
     310</varlistentry>
     311
     312<varlistentry id="vimtutor">
     313<term><command>vimtutor</command></term>
     314<listitem>
     315<para>Teaches the basic keys and commands of <command>vim</command></para>
     316<indexterm zone="ch-system-vim vimtutor"><primary sortas="b-vimtutor">vimtutor</primary></indexterm>
     317</listitem>
     318</varlistentry>
     319
     320<varlistentry id="xxd">
     321<term><command>xxd</command></term>
     322<listitem>
     323<para>Creates a hex dump of the given file; it can
     324also do the reverse, so it can be used for binary patching</para>
     325<indexterm zone="ch-system-vim xxd"><primary sortas="b-xxd">xxd</primary></indexterm>
     326</listitem>
     327</varlistentry>
     328</variablelist>
    101329
    102330</sect2>
    103331
    104332</sect1>
     333
Note: See TracChangeset for help on using the changeset viewer.