annotate nsis/README.txt @ 35121:28f2e09012ac default tip

runtime(doc): Fix typos in help documents Commit: https://github.com/vim/vim/commit/53753f6a49253cdb3f98f6461d3de3b07ed67451 Author: h-east <h.east.727@gmail.com> Date: Sun May 5 18:42:31 2024 +0200 runtime(doc): Fix typos in help documents closes: https://github.com/vim/vim/issues/14720 Co-authored-by: Christian Clason <c.clason@uni-graz.at> Signed-off-by: h-east <h.east.727@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Sun, 05 May 2024 18:45:09 +0200
parents 879a61a9aa07
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
1 This builds a one-click install for Vim for MS Windows using the Nullsoft
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
2 Installation System (NSIS), available at http://nsis.sourceforge.net/
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
4 To build the installable .exe file:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 1. Unpack three archives:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 PC sources
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 PC runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 PC language files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 You can generate these from the Unix sources and runtime plus the extra
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 archive (see the Makefile in the top directory).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 2. Go to the src directory and build:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 gvim.exe (the OLE version),
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 vimrun.exe,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 install.exe,
18182
9b6bfce90778 patch 8.1.2086: missing a few changes for the renamed files
Bram Moolenaar <Bram@vim.org>
parents: 15410
diff changeset
17 uninstall.exe,
15095
803807ab19c5 patch 8.1.0558: some MS-Windows instructions are outdated
Bram Moolenaar <Bram@vim.org>
parents: 12626
diff changeset
18 tee/tee.exe,
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
19 xxd/xxd.exe
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
21 Then execute tools/rename.bat to rename the executables.
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
22
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 3. Go to the GvimExt directory and build gvimext.dll (or get it from a binary
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
24 archive). Both 64- and 32-bit versions are needed and should be placed
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
25 as follows:
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
26 64-bit: src/GvimExt/gvimext64.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
27 32-bit: src/GvimExt/gvimext.dll
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
30727
645722244c3f patch 9.0.0698: VisVim is outdated, does not work with current Visual Studio
Bram Moolenaar <Bram@vim.org>
parents: 25056
diff changeset
29 4. Get a "diff.exe" program. If you skip this the built-in diff will always
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
30 be used (which is fine for most users).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 You can find one in previous Vim versions or in this archive:
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
32 https://www.mediafire.com/file/9edk4g3xvfgzby0/diff4Vim.zip/file
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
33 When will you have "diff.exe" put it in the "../.." directory (above the
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
34 "vim91" directory, it's the same for all Vim versions). However, you can
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
35 specify another directory by passing /DVIMTOOLS=<dir> option to the
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
36 "makensis.exe" program via the command line.
15095
803807ab19c5 patch 8.1.0558: some MS-Windows instructions are outdated
Bram Moolenaar <Bram@vim.org>
parents: 12626
diff changeset
37
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
38 5. For the terminal window to work in Vim, the library winpty is required.
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
39 You can get it at the following url:
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
40 https://github.com/rprichard/winpty/releases/download/0.4.3/winpty-0.4.3-msvc2015.zip
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
41 For the 32-bit version, rename "winpty.dll" from ia32/bin to "winpty32.dll",
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
42 and for the 64-bit version — "winpty.dll" from x64/bin to "winpty64.dll".
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
43 Put the renamed file and "winpty-agent.exe" in "../.." (above the "vim91"
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
44 directory). However, you can specify another directory by passing
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
45 /DVIMTOOLS=<dir> option to the "makensis.exe" program via the command line.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
34598
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
47 6. To use stronger encryption, add the Sodium library. You can get it here:
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
48 https://github.com/jedisct1/libsodium/releases/download/1.0.19-RELEASE/libsodium-1.0.19-msvc.zip
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
49 Unpack the archive. Put the "libsodium.dll" from
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
50 path/to/libsodium/Win32/Release/v143/dynamic for the 32‐bit version or
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
51 path/to/libsodium/X64/Release/v143/dynamic for the 64‐bit version in the
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
52 "../.." directory (above the "vim91" directory, where "diff.exe" and
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
53 "winpty{32|64}.dll").
34598
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
54
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
55 7. On MS Windows do "nmake.exe -f Make_mvc.mak uganda.nsis.txt" in runtime/doc.
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
56 On Unix-like system do "make runtime/doc/uganda.nsis.txt" in top directory
34670
879a61a9aa07 NSIS: Possibility to include translated license and README.txt files (#14311)
Christian Brabandt <cb@256bit.org>
parents: 34630
diff changeset
57 or "make uganda.nsis.txt" in runtime/doc. The created files
879a61a9aa07 NSIS: Possibility to include translated license and README.txt files (#14311)
Christian Brabandt <cb@256bit.org>
parents: 34630
diff changeset
58 "uganda.nsis.???" will be automatically converted to DOS file format.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59
34598
d91ac228d7df patch 9.1.0191: Installer does not remove all files
Christian Brabandt <cb@256bit.org>
parents: 31628
diff changeset
60 8. Get gettext and iconv DLLs from the following site:
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
61 https://github.com/mlocati/gettext-iconv-windows/releases
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
62 Both 64- and 32-bit versions are needed.
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
63 Download the files gettextX.X.X.X-iconvX.XX-shared-{32,64}.zip, extract
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
64 DLLs and place them as follows:
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
65
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
66 <GETTEXT directory>
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
67 |
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
68 + gettext32/
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
69 | libintl-8.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
70 | libiconv-2.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
71 | libgcc_s_sjlj-1.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
72 |
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
73 + gettext64/
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
74 libintl-8.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
75 libiconv-2.dll
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
76
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
77 The default <GETTEXT directory> is "..", however, you can specify another
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
78 directory by passing /DGETTEXT=<dir> option to "makensis.exe" program via
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
79 the command line.
12626
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
80
aca41efd888c patch 8.0.1191: MS-Windows: missing 32 and 64 bit files in installer
Christian Brabandt <cb@256bit.org>
parents: 7
diff changeset
81
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 Install NSIS if you didn't do that already.
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
83 Download Unicode version the ShellExecAsUser plug-in for NSIS from:
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
84 https://nsis.sourceforge.io/ShellExecAsUser_plug-in
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
85 and put ShellExecAsUser.dll to path\to\NSIS\Plugins\x86-unicode
24565
138e9caf4a7a patch 8.2.2822: MS-Windows: unnessarily loading libraries when unregistering
Bram Moolenaar <Bram@vim.org>
parents: 19116
diff changeset
86
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
15410
cb1652e41314 patch 8.1.0713: images for NSIS take up too much space
Bram Moolenaar <Bram@vim.org>
parents: 15095
diff changeset
88 Unpack the images:
cb1652e41314 patch 8.1.0713: images for NSIS take up too much space
Bram Moolenaar <Bram@vim.org>
parents: 15095
diff changeset
89 cd nsis
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
90 unzip icons.zip or 7z x icons.zip (on Unix-like or MS Windows)
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
91 WinRar.exe x icons.zip (on MS Windows)
15410
cb1652e41314 patch 8.1.0713: images for NSIS take up too much space
Bram Moolenaar <Bram@vim.org>
parents: 15095
diff changeset
92
25056
43593a5d873f Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24565
diff changeset
93 Then build gvim.exe:
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
94 cd nsis
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
95 makensis.exe [options] gvim.nsi
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96
34630
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
97 Options (not mandatory):
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
98 /DVIMSRC=<dir> — directory where location of gvim_ole.exe, vimw32.exe,
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
99 GvimExt/*, etc.
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
100 /DVIMRT=<dir> — directory where location of runtime files
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
101 /DVIMTOOLS=<dir> — directory where location of extra tools: diff.exe,
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
102 winpty{32|64}.dll, winpty-agent.exe, libsodium.dll
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
103 /DGETTEXT=<dir> — directory where location of gettext libraries
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
104 /DHAVE_UPX=1 — additional compression of the installer. UPX program
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
105 must be installed.
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
106 /DHAVE_NLS=0 — do not add native language support
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
107 /DHAVE_MULTI_LANG=0 — to create an English-only the installer
250793f9b574 NSIS: Update nsis installer and nsis docs (#14256)
Christian Brabandt <cb@256bit.org>
parents: 34598
diff changeset
108 /DWIN64=1 — to create a 64-bit the installer