USER MANUAL FOR VIM INSTALLER

------------------------------------------------------------------------------

                             Command Line Summary

This section is a short summary of Vim installer command line for quick
reference.  You should probably skip this when you read the manual for the
first time.

Vim installer command line syntax:

    gvim73.exe [/LANG=<lang>] [/TYPE={FULL|TYPICAL|MIN}]
               [/<OPTION>[{+|-}]] [/S] [/NCRC] [/D=<dir>]

The /LANG=<lang> switch sets UI language of the installer.  <lang> can be set
to one of the following value (you can use either locale name or LCID):
    en    : English, LCID=1033
    nl    : Nederlands, LCID=1043
    de    : Deutsch, LCID=1031
    it    : Italiano, LCID=1040
    zh_CN : Chinese (Simplified), LCID=2052
    zh_TW : Chinese (Traditional), LCID=1028

General purpose options are listed below:
    ?
    DD
    HELP
    RMEXE
    RMOLD

All supported component selection options are listed below:
    CONSOLE
    BATCH
    DESKTOP
    STARTMENU
    QLAUNCH
    SHEXT32
    SHEXT64
    VIMRC
    PLUGINHOME
    PLUGINCOM
    VISVIM
    NLS

------------------------------------------------------------------------------

                                 User Manual

Vim self-installing executable gvim73.exe is a Windows installer created
using NSIS.  It installs the following components of Vim:
    - GUI version of Vim with many features and OLE support;
    - A console version of Vim;
    - All the runtime files;
    - File explorer integration;
    - Native language support files etc.

It works well on MS-Windows 95/98/ME/NT/2000/XP/Vista/7.  Use this if you have
enough disk space and memory.  It's the simplest way to start using Vim on the
PC.  The installer allows you to skip the components you don't want.

The installer (and the associated uninstaller) has two modes:
    - Normal mode.  The installer runs in this mode by default.  It behaves as
      a normal Windows GUI installer.  A wizard like interface is used to let
      user set install options.
    - Silent mode.  Silent mode can be invoked with "/S" command line switch
      (case-sensitive).  When running in such mode, no user intervention is
      required and no user interface will be shown, all parameters can be
      specified on command line.  This is useful for unattended
      installation/uninstallation over large number of computers.  It is also
      useful for embedding Vim installer in another installer.  You can check
      NSIS document for detail:
        http://nsis.sourceforge.net/Docs/Chapter4.html#4.12

In the remaining part of this manual, we'll describe silent mode of the Vim
installer/uninstaller in detail.

1.  Exit Code and Install Log File

    Once started in silent mode, the installer will not produce any output
    (neither GUI nor console).  This is expected behavior of the NSIS
    installer.  You must check exit code of the installer to know whether the
    installation has succeeded or not.  A zero exit code means the
    installation went well; Non-zero exit code means some errors has occurred.

    A install log file will be created under Windows temporary directory (as
    specified by the TEMP environment string) by the installer:
        %TEMP%\vim-install.log
    The log file contains detailed log for all actions taken by the installer.
    If installation failed, the log file will be left under the temporary
    directory.  You can inspect that file for detailed error message.

    If installation succeeded, that log file will be moved into the binary
    subdirectory under Vim installation directory:
        <vim>\vim73

    Exit code for uninstaller is a little bit complex as the uninstaller will
    make a copy of itself and run that copy automatically if it is started in
    default mode.  You can find detailed information here:
        http://nsis.sourceforge.net/Docs/AppendixD.html#D.1

    Uninstaller will also create a log file with the same name under the
    temporary directory.  The log file will be left in that directory if
    uninstaller is invoked directly.

2.  Uninstall Existing Vim Automatically

    It does not make too much sense for end user to install multiple versions
    of Vim on the same system.  The installer has to make system wide change
    for file explorer integration.  However, the installer does not prohibit
    such use.

    Once started, the installer will detect existing Vim versions on the
    system, and let user decide whether to keep them or not.  The installer
    can invoke appropriate uninstaller automatically once user decide to
    remove a version.  There is one exception: if the same version as the one
    to be installed is detected on the system, it must be removed.

    However, automatic uninstallation could be complex in silent mode.  It's
    not easy to let user specify which version to keep since existing versions
    are detected dynamically.  Therefore, the installer will simply abort if
    any existing Vim found on the system, unless user specifies all old
    version should be removed with the /RMOLD command line switch.

    Another catch is: all uninstaller invoked by a silent installer should
    also run in silent mode.  Therefore, the installer also checks whether all
    involved uninstallers support silent mode or not.  If not, the installer
    will simply abort even if user allow uninstallation of those versions.  If
    you really want to use silent mode, those Vim versions have to be removed
    manually (for example, using GUI uninstaller) first.

    Some command line switches, like /RMEXE, can be used to tune the behavior
    of those invoked uninstallers.

3.  Automatic Install Path Detection

    The installer determines install path with the following steps:
    - Install path specified on the command line with "/D=<dir>" has the
      highest priority.
    - If no install path specifies on command line, or the specified path is
      invalid, the parent directory of the last installed Vim version, if any,
      will be used as the root directory to construct the install path;
    - If that failed, the VIMRUNTIME environment string will be considered.
      The parent directory of the specified directory will be taken as root
      directory to construct install path if valid.
    - If that failed, the VIM environment string will be checked next, and the
      specified directory will be used as install path directly if valid.
    - If all of the above failed, the default install path <program-files>\Vim
      will be used.

    In silent mode, automatic install path detection is disabled by default.
    The installer assumes user will specify a install path on the command
    line.  It will abort unless user specifies install path explicitly or
    enables automatic install path detection with the "/DD" command line
    switch.  The reason is NSIS will silently ignore the specified install
    path if it's invalid.  That could easily and silently land Vim in a
    different directory if automatic install path detection has been enabled.

4.  Components Selection from Command Line

    You can select components to install from command line.  Two types of
    command line switches can be used for such purpose:
    - /TYPE={FULL|TYPICAL|MIN} command line switch can be used to specify the
      installation type as "full", "typical" or "minimum", with "typical" as
      the default.
    - Command line switches like /CONSOLE, /BATCH can be used to select each
      component individually.

    The order of those command line switches is not important.  The installer
    will process install type switch first, and then component selection
    switches.

5.  Installer Command Line Switches

    All command line switches supported by the Vim installer are listed below:

        gvim73.exe [/LANG=<lang>] [/TYPE={FULL|TYPICAL|MIN}]
                   [/<OPTION>[{+|-}]] [/S] [/NCRC] [/D=<dir>]

    Please note all command line switches can only be specified once,
    duplicated command line switches are considered as syntax error.

    The following command line switches are supported by NSIS natively, all of
    them are case-sensitive.  You can check NSIS document for detail:
        http://nsis.sourceforge.net/Docs/Chapter3.html#3.2

        /NCRC    Disables the CRC check, unless CRCCheck force was used in the
                 script.
        /S       Runs the installer silently.
        /D=<dir> Sets the default installation directory.  If specified, it must
                 be the last parameter used in the command line and must not
                 contain any quotes, even if the path contains spaces.  Only
                 absolute paths are supported.  Invalid path name will be ignored
                 silently!

    UI language of the installer can be specified with the following command
    line switch:
        /LANG=<lang>
    where <lang> can be locale name or LCID of the selected language.  Please
    refer to the summary section above for a list of supported languages.  The
    default language is determined by the current UI language of the system.
    If that language is not supported by the installer, English will be used.

    Install type can be selected with the following command line switch:
        /TYPE={FULL|TYPICAL|MIN}
                 Sets install type as full/typical/minimum.  The default is
                 typical.

    The remaining command line switches are used to fine tune install options,
    all of them are case-insensitive and follow the same syntax:
        /<OPTION>[{+|-}]
    It can be used like this:
        /<OPTION>+ or /<OPTION> to enable an option.
        /<OPTION>- to disable an option.

    The following general purpose options are used to tune installer behavior:
        ?          Dump user manual for Vim installer in the current working
                   directory.  File name of the manual is:
                     vim##_install_manual.txt
        HELP       Same as ?.
        DD         Allow automatic install directory detection under silent
                   mode.
        RMOLD      Allow uninstallation of existing Vim under silent mode.
        RMEXE      Remove executables when uninstall existing Vim.  This
                   option is enabled by default.

    The following options are used to fine tune which component should be
    installed, after applying user specified installation type.  Please note
    the installer you're using might not support all of the following
    components (some of them might not be compiled in), please refer to the
    command line summary at the beginning of this file for an accurate list of
    supported components.
        CONSOLE    Install console version.
        BATCH      Install batch wrappers for Vim.
        DESKTOP    Add Vim shortcuts on the desktop.
        STARTMENU  Add Vim shortcuts in the start menu.
        QLAUNCH    Add Vim shortcut in the quick launch bar.
        SHEXT32    Add Vim to the "Open With..." context menu list for 32-bit
                   applications.
        SHEXT64    Add Vim to the "Open With..." context menu list for 64-bit
                   applications.
        VIMRC      Create a default config file (_vimrc) if one does not
                   already exist.
        PLUGINHOME Create plugin directories in HOME (if defined) or Vim
                   install directory.
        PLUGINCOM  Create plugin directories in Vim install directory, it is
                   used for everybody on the system.
        VISVIM     Install VisVim extension for Microsoft Visual Studio
                   integration.  Available only if the extension has been
                   included in the installer.
        NLS        Install files for native language support.  Available only
                   if the extension has been included in the installer.

6.  Uninstaller Command Line Switches

    Here's the list of all command line switches supported by the associated
    Vim uninstaller:

        uninstall-gui.exe [/<OPTION>[{+|-}]] [/S] [/NCRC] [/D=<dir>]

    Options /S, /NCRC and /D=<dir> is the same as the installer.  All of the
    command line switches specific to Vim un-installer follows the same syntax
    as the install options:
        /<OPTION>[{+|-}]

    The following options are supported:
        RMEXE Remove executables when uninstall Vim.  This option is enabled
              by default.

7.  Caveats

    When specifies command line switches with arguments, like:
        /D=<dir>
    You should better avoid white spaces around the equal sign.  If you must
    add some white spaces, add them after the equal sign, never before it.
    Otherwise the command line parser can not recognize the switch.

8.  Examples

    The following are some examples for silent mode.  Please note the "/S"
    switch must be specified if you need the installer run in silent.

    - Typical install of Vim, detect install path automatically.  This command
      will succeed only if no Vim has been installed on the system:
        gvim73.exe /S /DD

    - Typical install of Vim under "C"\Vim", uninstall all existing versions.
      Please note install path must be specified as the last command line
      switch.
        gvim73.exe /S /RMOLD /D=C:\Vim

    - Full install of Vim under "C"\Vim", uninstall all existing versions:
        gvim73.exe /S /RMOLD /TYPE=FULL /D=C:\Vim

    - Full install of Vim under "C"\Vim", sans console version, and uninstall
      all existing versions:
        gvim73.exe /S /RMOLD /CONSOLE- /TYPE=FULL /D=C:\Vim

    - Typical install of Vim, don't care where it installed, and uninstall all
      existing versions:
        gvim73.exe /S /RMOLD /DD