INSTALL

+-----------+
|   NOTE    |
+-----------+
从 6.3 版开始，Vim 加入了对翻译文档的支持。本文件所讲述的自动安装
程序仅适用于 Vim 6.3 及以后的版本。如果你使用的是 Vim 6.2 或以前
的版本，建议升级到 6.3 或更高版本。当然，所有翻译和未翻译的文件都
是纯文本文件，所以你也可以简单的覆盖原帮助文件。请参阅下面的
'vim 6.2'一节。


+-----------+
|  UPDATE   |
+-----------+

1.9.0：更新到 Vim 7.4，
1.8.0：更新到 Vim 7.3，
1.7.0：更新到 Vim 7.2，新增 vimcdoc.vim 插件。
1.6.0：更新到 Vim 7.1。
1.5.0：更新到 Vim 7.0。
1.0：  完成 Vim 6.4 全部文档。


+-----------+
|  INSTALL  |
+-----------+
Linux：
下载的 tar.gz 包括所有翻译过的 vim 文档 (.cnx 文件)。
先将其解压缩：
    tar zxvf vimcdoc-<version>.tar.gz
然后进入 vimcdoc-<version> 目录并执行
    ./vimcdoc.sh -i
就可以了。该安装程序会自动识别 Vim 的安装路径，将中文的文档拷贝
到相应的地方。原有的英文文档不受影响。

这种方法对 root 和非 root 用户都适用。但建议以 root 身份安装。
当以 root 身份安装时，文件会被拷贝至 /usr/share/vim/vimfiles/doc
下。因此所有系统的用户都可以使用中文文档。如果你的 vim 是安装
在 /usr/local 下的话，你需要这样设定 vim 的 runtimepath 选项：
	:set rtp+=/usr/share/vim/vimfiles
你可以将上面的设定加入到你的 vimrc 文件中以便每次启动 vim 都生效。
当以普通用户安装时，所有文件会被拷贝至 ~/.vim/doc 下，所以仅对该用
户有效。

Win32：
建议使用已经做好的自动安装程序。该程序不写注册表，不建立程序组，
不覆盖任何 Vim 原有文件。所以可以放心使用。

你也可以自己动手来安装：只要把所有的中文文档以及 tags-cn 文件拷贝
到 runtimepath 之一的 doc 子目录下就行了。runtimepath 可用在 vim
内用 :set rtp? 命令来得到。比如在 vimcdoc-<version> 目录中，可以
执行以下命令：
	cp -R doc /usr/share/vim/vimfiles/doc
这种方法对 Linux 和 Win32 都有效。

现在启动 vim/gvim, 键入 :help 看看吧！


+-----------+
|    TIPS   |
+-----------+
缺省同时安装 vimcdoc.vim 全局插件，该插件设置缺省编码为 utf-8，并使得每次使用
:help 命令时都优先使用中文的帮助文档，

有些用户不愿意缺省使用 utf-8 编码，为此可以在安装时跳过 vimcdoc.vim 插件。
Linux 可用以下的安装命令代替：
    ./vimcdoc.sh -I

Win32 的安装程序也有选项来关闭该插件的安装。

如果不安装 vimcdoc.vim 插件：
为了每次使用 :help 命令时都优先使用中文的帮助文档，可以将下面这样几行加入到你
的 vimrc 文件中：
	if version >= 603
		set helplang=cn
	endif

也需要注意的是，你的 'encoding' 设置及字体必须支持中文显示。对于使用非 utf-8
中文环境的用户，在浏览某些帮助文件的时候可能会遇到麻烦。这是因为那些文件包含
无法在 gbk, gb2312 等编码方式下显示的字符。遇到这种情况，有以下几种解决方案：

1. 使用 utf-8 中文环境。例如，将 LC_ALL 设定为 zh_CN.UTF-8
2. 强制 vim 使用 utf-8 编码。做法是 :set enc=utf-8
3. 如果你的系统有 GB18030 支持，可以让 vim 使用 GB18030 编码，因为
   GB18030 对非中文字符也能进行适当的处理。方法是
   :set enc=2byte-gb18030
   这时，Vim 会正确地进行转换。注意这里不能通过设置 LC_ALL 来完成。

如果使用 2 或 3，建议把 vim 设置写入你的个人 .vimrc 设置文件，避免每
次都要输入命令的麻烦。

备注：如果 set enc=utf-8 时，使用的中文消息出现乱码，可以同时设置
  :language message zh_CN.UTF-8


+------------+
|  UNINSTALL  |
+------------+
Linux：
如果你是使用的自动安装脚本安装的话，只要运行：
    ./vimcdoc.sh -u
即可。但必须用与安装时同样的用户名 (root 用户安装程序会在
/usr/share/doc/vimcdoc 下安装该文件)。

Win32：
假定你的 Vim 安装在 c:\vim 下，在 c:\vim\vimfiles\doc\ 目录内会
有一个 vimcdoc-Uninst.exe，只要执行它就可以了。


+---------+
| Vim 6.2 |
+---------+
对于 Vim 6.2 及以前版本的可以这样手动安装中文文档：
1. 下载 vimcdoc-<version>.tar.gz。Win32 的自动安装程序无效。
2. 解压缩
3. 将 vimcdoc-<version>/data/doc 下的所有 .cnx 文件改名为 .txt。
4. 将所有改名后的 .txt 文件拷贝并覆盖原有的英文文档。建议先备分
   原文件。


+---------+
|   CVS   |
+---------+
不建议用户直接使用 CVS 来安装 vim 中文文档。因此，这里也不
提供任何提示。