diff options
| author | Eli Zaretskii | 2016-11-05 10:07:30 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2016-11-05 10:07:30 +0200 |
| commit | de51d59802b33555fb23a924a49bb782e6caa2b8 (patch) | |
| tree | 72fa13c4ba6ac48b3f9abcfc136ec7c7805fedbb | |
| parent | db436e93cae16b34b951c2f210705fbd30ad2922 (diff) | |
| download | emacs-de51d59802b33555fb23a924a49bb782e6caa2b8.tar.gz emacs-de51d59802b33555fb23a924a49bb782e6caa2b8.zip | |
; * nt/README.W32: Minor copyedits.
| -rw-r--r-- | nt/README.W32 | 171 |
1 files changed, 121 insertions, 50 deletions
diff --git a/nt/README.W32 b/nt/README.W32 index d866d9fc7a6..7ffeb0aadba 100644 --- a/nt/README.W32 +++ b/nt/README.W32 | |||
| @@ -1,11 +1,11 @@ | |||
| 1 | Copyright (C) 2001-2016 Free Software Foundation, Inc. | 1 | Copyright (C) 2001-2016 Free Software Foundation, Inc. |
| 2 | See the end of the file for license conditions. | 2 | See the end of the file for license conditions. |
| 3 | 3 | ||
| 4 | Emacs for Windows | 4 | Emacs for MS-Windows |
| 5 | 5 | ||
| 6 | This README file describes how to set up and run a precompiled | 6 | This README file describes how to set up and run a precompiled |
| 7 | distribution of GNU Emacs for Windows. You can find the precompiled | 7 | distribution of GNU Emacs for MS-Windows. You can find the |
| 8 | distribution on the ftp.gnu.org server and its mirrors: | 8 | precompiled distribution on the ftp.gnu.org server and its mirrors: |
| 9 | 9 | ||
| 10 | ftp://ftp.gnu.org/gnu/emacs/windows/ | 10 | ftp://ftp.gnu.org/gnu/emacs/windows/ |
| 11 | 11 | ||
| @@ -15,19 +15,23 @@ See the end of the file for license conditions. | |||
| 15 | Information on how to compile Emacs from sources on Windows is in | 15 | Information on how to compile Emacs from sources on Windows is in |
| 16 | the files README and INSTALL in the nt/ sub-directory of the | 16 | the files README and INSTALL in the nt/ sub-directory of the |
| 17 | top-level Emacs directory in the source distribution, as is this | 17 | top-level Emacs directory in the source distribution, as is this |
| 18 | file as README.precompiled. If you received this file as part of | 18 | file under the name README.W32. If you received this file as part |
| 19 | the Emacs source distribution, and are looking for information on | 19 | of the Emacs source distribution, and are looking for information on |
| 20 | how to build Emacs on MS-Windows, please read those 2 files and not | 20 | how to build Emacs on MS-Windows, please read those 2 files and not |
| 21 | this one. | 21 | this one. |
| 22 | 22 | ||
| 23 | * Preliminaries | 23 | * Preliminaries |
| 24 | 24 | ||
| 25 | There are two binary distributions named | 25 | There are two binary distributions named |
| 26 | emacs-n-x86_64-w64-mingw32.zip and | 26 | emacs-VER-x86_64-w64-mingw32.zip and emacs-VER-i686-w64-mingw32.zip, |
| 27 | emacs-n-i686-w64-mingw32.zip. These are for 64-bit and 32-bit | 27 | where VER is the Emacs version. These are 64-bit and 32-bit builds, |
| 28 | machines respectively. | 28 | respectively. If you are running a 32-bit version of MS-Windows, |
| 29 | you need to install the 32-bit build; users of 64-bit Windows can | ||
| 30 | use either build, but we recommend to install the 64-bit one, as it | ||
| 31 | will be able to edit larger buffers and will generally run faster. | ||
| 29 | 32 | ||
| 30 | The binary distribution has these top-level directories: | 33 | The binary distribution has these top-level directories: |
| 34 | |||
| 31 | + bin | 35 | + bin |
| 32 | + libexec | 36 | + libexec |
| 33 | + share | 37 | + share |
| @@ -36,23 +40,42 @@ See the end of the file for license conditions. | |||
| 36 | * Setting up Emacs | 40 | * Setting up Emacs |
| 37 | 41 | ||
| 38 | To install Emacs, simply unpack the binary package into a directory | 42 | To install Emacs, simply unpack the binary package into a directory |
| 39 | of your choice. If you use File Explorer and "Extract" by default | 43 | of your choice. If you use the Windows Explorer and its "Extract" |
| 40 | this will be in a top-level directory with the same name as the zip | 44 | action, by default this will be in a top-level directory with the |
| 41 | file. | 45 | same name as the zip file. |
| 42 | 46 | ||
| 43 | We also provide a set of optional dependencies, in | 47 | We also provide a set of optional dependencies, in |
| 44 | emacs-25-x86_64-deps.zip or emacs-25-i686-deps.zip respectively, | 48 | emacs-MVER-x86_64-deps.zip or emacs-MVER-i686-deps.zip respectively, |
| 45 | which provide Emacs with an number of additional capabilities. To | 49 | where MVER is the major Emacs version that should use these |
| 46 | add these, unpack them directly over the emacs directory structure. | 50 | libraries. These provide Emacs with a number of additional optional |
| 51 | capabilities, described in detail below. To use these, unpack them | ||
| 52 | directly over the emacs directory structure. Note that, if | ||
| 53 | extracting with the Windows Explorer, you will have to override the | ||
| 54 | directory where it wants to put the file with the same directory | ||
| 55 | where you extracted the Emacs binary package. | ||
| 47 | 56 | ||
| 48 | Finally, and also optionally, you can run the program addpm.exe in | 57 | Finally, and also optionally, you can run the program addpm.exe in |
| 49 | the bin subdirectory which will place an icon for Emacs on the start | 58 | the bin subdirectory which will place an icon for Emacs on the start |
| 50 | page. | 59 | page. (This is no longer needed in latest versions of Emacs, so we |
| 51 | 60 | recommend you not do that, as running addpm.exe will insert entries | |
| 52 | Emacs is completely portable. You can create your own shortcut to | 61 | into the Registry which might get in the way if you upgrade to later |
| 53 | runemacs.exe and place this wherever you find it convenient, or | 62 | versions without updating those entries, or would like to uninstall |
| 54 | run it from a USB or network drive without copying or installing | 63 | Emacs.) |
| 55 | anything on the machine itself. | 64 | |
| 65 | Emacs is completely portable. You can create your own shortcut to | ||
| 66 | runemacs.exe and place this wherever you find it convenient (the | ||
| 67 | desktop and/or the Taskbar), or run it from a USB or network drive | ||
| 68 | without copying or installing anything on the machine itself. | ||
| 69 | |||
| 70 | * Prerequisites for Windows 9X | ||
| 71 | |||
| 72 | The 32-bit build supports MS-Windows 9X (Windows 95/98/Me). To run | ||
| 73 | Emacs on these versions of Windows, you will need to have the | ||
| 74 | Microsoft Layer for Unicode (MSLU) installed. It can be downloaded | ||
| 75 | from the Microsoft site, and comes in a form of a single dynamic | ||
| 76 | library called UNICOWS.DLL. If this library is not accessible to | ||
| 77 | Emacs on Windows 9X, it will pop up a dialog saying that it cannot | ||
| 78 | find the UNICOWS library, and will refuse to start up. | ||
| 56 | 79 | ||
| 57 | * Starting Emacs | 80 | * Starting Emacs |
| 58 | 81 | ||
| @@ -66,7 +89,7 @@ See the end of the file for license conditions. | |||
| 66 | If you want to use Emacs in tty or character mode within a command | 89 | If you want to use Emacs in tty or character mode within a command |
| 67 | window, you can start it by typing "emacs -nw" at the command prompt. | 90 | window, you can start it by typing "emacs -nw" at the command prompt. |
| 68 | (Obviously, you need to ensure that the Emacs bin subdirectory is in | 91 | (Obviously, you need to ensure that the Emacs bin subdirectory is in |
| 69 | your PATH first, or specify the path to emacs.exe.) The -nw | 92 | your Path first, or specify the path to emacs.exe.) The -nw |
| 70 | (non-windowed) mode of operation is most useful if you have a telnet | 93 | (non-windowed) mode of operation is most useful if you have a telnet |
| 71 | server on your machine, allowing you to run Emacs remotely. | 94 | server on your machine, allowing you to run Emacs remotely. |
| 72 | 95 | ||
| @@ -90,7 +113,8 @@ See the end of the file for license conditions. | |||
| 90 | + emacsclientw.exe - A version of emacsclient that does not open | 113 | + emacsclientw.exe - A version of emacsclient that does not open |
| 91 | a command-line window. | 114 | a command-line window. |
| 92 | 115 | ||
| 93 | + addpm.exe - The installer that adds Emacs to "Start". | 116 | + addpm.exe - A basic installer that adds Emacs to "Start" menus and |
| 117 | adds Emacs-related entries to the Windows Registry. | ||
| 94 | 118 | ||
| 95 | + ctags.exe, etags.exe - Tools for generating tag files. See the | 119 | + ctags.exe, etags.exe - Tools for generating tag files. See the |
| 96 | `Tags' node of the Emacs manual. | 120 | `Tags' node of the Emacs manual. |
| @@ -124,26 +148,56 @@ See the end of the file for license conditions. | |||
| 124 | + update-game-score.exe - A utility for updating the score files of | 148 | + update-game-score.exe - A utility for updating the score files of |
| 125 | Emacs games. | 149 | Emacs games. |
| 126 | 150 | ||
| 127 | * Optional Dependencies | 151 | * Optional dependency libraries |
| 128 | 152 | ||
| 129 | Emacs has built in support for XBM and PPM/PGM/PBM images, and the | 153 | Emacs has built in support for XBM and PPM/PGM/PBM images, and the |
| 130 | libXpm library is bundled, providing XPM support (required for color | 154 | libXpm library is bundled, providing XPM support (required for color |
| 131 | toolbar icons and splash screen). Source for libXpm should be | 155 | toolbar icons and splash screen). Source for libXpm should be |
| 132 | available from the same place from which you got this binary | 156 | available from the same place from which you got this binary |
| 133 | distribution. | 157 | distribution. |
| 134 | 158 | ||
| 135 | In addition, as described, there is a separate dependency bundle | 159 | Emacs has a number of optional features which need additional |
| 136 | providing support for many images formats, TLS, XML parsing and | 160 | libraries. These are provided in a separate bundle of dependencies, |
| 137 | compression. | 161 | as described above, and enable support for the following: |
| 162 | |||
| 163 | - displaying inline images of many types (PNG, JPEG, GIF, TIFF, SVG) | ||
| 164 | - SSL/TLS secure network communications (HTTPS, IMAPS, etc.) | ||
| 165 | - HTML and XML parsing (necessary for the built-in EWW browser) | ||
| 166 | - built-in decompression of compressed text | ||
| 167 | |||
| 168 | The optional dependency libraries are in emacs-MVER-x86_64-deps.zip | ||
| 169 | (64-bit) and emacs-MVER-i686-deps.zip (32-bit), and their sources | ||
| 170 | are in emacs-MVER-deps-mingw-w64-src.zip, where MVER is the major | ||
| 171 | version of Emacs that should use these dependencies. Note that a | ||
| 172 | 64-bit Emacs will only work with the 64-bit dependencies, and the | ||
| 173 | 32-bit Emacs only with the 32-bit dependencies. | ||
| 174 | |||
| 175 | Newer/updated builds for these optional libraries are available at | ||
| 176 | http://msys2.github.io/ and | ||
| 177 | http://sourceforge.net/projects/ezwinports/files/ (but you shouldn't | ||
| 178 | need these except in emergencies). | ||
| 179 | |||
| 180 | If you install the libraries in a directory different from where you | ||
| 181 | have the Emacs executable programs, we recommend to add the | ||
| 182 | directory with DLLs to your Path, so that Emacs will be able to find | ||
| 183 | those DLLs when needed. | ||
| 138 | 184 | ||
| 139 | * Installing with an existing MSYS2 installation. | 185 | * Installing Emacs with an existing MSYS2 installation |
| 140 | 186 | ||
| 141 | You may also use Emacs with an existing MSYS2 installation by simply | 187 | You may also use Emacs with an existing MSYS2 installation by simply |
| 142 | unpacking the Emacs distribution over MSYS2. You can then use the | 188 | unpacking the Emacs distribution over MSYS2. You can then use the |
| 143 | 'pacman' utility to install dependencies. You should not use the | 189 | 'pacman' utility to install dependencies. You should not use the |
| 144 | optional dependencies bundle, as this will overwrite MSYS2 files | 190 | optional dependencies bundle from this site, as this will overwrite |
| 145 | (the dependency bundle derives from MSYS2, but may be a different | 191 | MSYS2 files (the dependency bundle derives from MSYS2, but may be a |
| 146 | version). | 192 | different version). |
| 193 | |||
| 194 | Some of the optional libraries need to be of certain versions to | ||
| 195 | work with your Emacs binary. Make sure you install those versions | ||
| 196 | of dependencies, and no others. Emacs variables such as | ||
| 197 | libpng-version and libjpeg-version tell what versions of the | ||
| 198 | corresponding libraries are expected by Emacs. (We recommend that | ||
| 199 | you use the dependency bundle, where these issues are always | ||
| 200 | resolved.) | ||
| 147 | 201 | ||
| 148 | To install the optional libraries, start the MSYS2 Bash window and | 202 | To install the optional libraries, start the MSYS2 Bash window and |
| 149 | type the following command: | 203 | type the following command: |
| @@ -153,17 +207,25 @@ See the end of the file for license conditions. | |||
| 153 | where PACKAGES is the list of packages you want to install. The | 207 | where PACKAGES is the list of packages you want to install. The |
| 154 | full list is as follows: | 208 | full list is as follows: |
| 155 | 209 | ||
| 156 | mingw-w64-x86_64-giflib | 210 | mingw-w64-x86_64-giflib |
| 157 | mingw-w64-x86_64-gnutls | 211 | mingw-w64-x86_64-gnutls |
| 158 | mingw-w64-x86_64-libjpeg-turbo | 212 | mingw-w64-x86_64-libjpeg-turbo |
| 159 | mingw-w64-x86_64-libpng | 213 | mingw-w64-x86_64-libpng |
| 160 | mingw-w64-x86_64-librsvg | 214 | mingw-w64-x86_64-librsvg |
| 161 | mingw-w64-x86_64-libtiff | 215 | mingw-w64-x86_64-libtiff |
| 162 | mingw-w64-x86_64-libxml2 | 216 | mingw-w64-x86_64-libxml2 |
| 163 | mingw-w64-x86_64-xpm-nox | 217 | mingw-w64-x86_64-xpm-nox |
| 164 | 218 | ||
| 165 | You can type any subset of this list. Once again, when asked | 219 | You can type any subset of this list. When asked whether to proceed |
| 166 | whether to proceed with installation, answer Y. | 220 | with installation, answer Y. |
| 221 | |||
| 222 | Alternatively, you could install the packages manually from this | ||
| 223 | page: | ||
| 224 | |||
| 225 | https://sourceforge.net/projects/msys2/files/REPOS/MINGW/x86_64/ | ||
| 226 | |||
| 227 | However, the packages there are not self-contained, so you will need | ||
| 228 | to manually download all their dependencies as well. | ||
| 167 | 229 | ||
| 168 | * Uninstalling Emacs | 230 | * Uninstalling Emacs |
| 169 | 231 | ||
| @@ -184,6 +246,9 @@ See the end of the file for license conditions. | |||
| 184 | 246 | ||
| 185 | * Troubleshooting | 247 | * Troubleshooting |
| 186 | 248 | ||
| 249 | Some known problems and their solutions can be found in the file | ||
| 250 | etc\PROBLEMS in the unpacked Emacs distribution. | ||
| 251 | |||
| 187 | Virus scanners | 252 | Virus scanners |
| 188 | 253 | ||
| 189 | Some virus scanners interfere with Emacs' use of subprocesses. If you | 254 | Some virus scanners interfere with Emacs' use of subprocesses. If you |
| @@ -191,6 +256,12 @@ See the end of the file for license conditions. | |||
| 191 | McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector | 256 | McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector |
| 192 | scanning" (McAfee exclusion properties). | 257 | scanning" (McAfee exclusion properties). |
| 193 | 258 | ||
| 259 | Windows 9X | ||
| 260 | |||
| 261 | On Windows 9X, make sure you have the UNICOWS.DLL library either in | ||
| 262 | the same directory where you have emacs.exe or in the directory | ||
| 263 | where system-wide DLLs are kept. | ||
| 264 | |||
| 194 | * Further information | 265 | * Further information |
| 195 | 266 | ||
| 196 | The Emacs User manual describes Windows-specific issues in the | 267 | The Emacs User manual describes Windows-specific issues in the |
| @@ -206,17 +277,17 @@ See the end of the file for license conditions. | |||
| 206 | In addition to the manual, there is a mailing list for help with | 277 | In addition to the manual, there is a mailing list for help with |
| 207 | Emacs here: | 278 | Emacs here: |
| 208 | 279 | ||
| 209 | https://lists.gnu.org/mailman/listinfo/help-gnu-emacs | 280 | http://lists.gnu.org/mailman/listinfo/help-gnu-emacs |
| 210 | 281 | ||
| 211 | To ask questions on the mailing list, send email to | 282 | To ask questions on this mailing list, send email to |
| 212 | help-gnu-emacs@gnu.org. | 283 | help-gnu-emacs@gnu.org. |
| 213 | 284 | ||
| 214 | And a more specific one for issues related to the Windows port of | 285 | A mailing list for issuesspecifically related to the MS-Windows port |
| 215 | Emacs. For information about the list, see this Web page: | 286 | of Emacs is here: |
| 216 | 287 | ||
| 217 | http://lists.gnu.org/mailman/listinfo/help-emacs-windows | 288 | http://lists.gnu.org/mailman/listinfo/help-emacs-windows |
| 218 | 289 | ||
| 219 | To ask questions on the mailing list, send email to | 290 | To ask questions on this mailing list, send email to |
| 220 | help-emacs-windows@gnu.org. | 291 | help-emacs-windows@gnu.org. |
| 221 | 292 | ||
| 222 | * Reporting bugs | 293 | * Reporting bugs |
| @@ -224,11 +295,11 @@ See the end of the file for license conditions. | |||
| 224 | If you encounter a bug in this port of Emacs, we would like to hear | 295 | If you encounter a bug in this port of Emacs, we would like to hear |
| 225 | about it. First check the FAQ on the web page above to see if the bug | 296 | about it. First check the FAQ on the web page above to see if the bug |
| 226 | is already known and if there are any workarounds. Then check whether | 297 | is already known and if there are any workarounds. Then check whether |
| 227 | the bug has something to do with code in your .emacs file, e.g. by | 298 | the bug has something to do with code in your `.emacs' file, e.g. by |
| 228 | invoking Emacs with the "-Q" option. | 299 | invoking Emacs with the "-Q" option. |
| 229 | 300 | ||
| 230 | If you decide that it is a bug in Emacs, use the built in bug | 301 | If you decide that it is a bug in Emacs, use the built in bug |
| 231 | reporting facility to report it (from the menu; Help -> Send Bug Report). | 302 | reporting facility to report it (from the menu: Help -> Send Bug Report). |
| 232 | If you have not yet configured Emacs for mail, then when you press | 303 | If you have not yet configured Emacs for mail, then when you press |
| 233 | C-c C-c to send the report, it will ask you to paste the text of the | 304 | C-c C-c to send the report, it will ask you to paste the text of the |
| 234 | report into your mail client. If the bug is related to subprocesses, | 305 | report into your mail client. If the bug is related to subprocesses, |