2 |
@include macros.texi |
@include macros.texi |
3 |
@end ifset |
@end ifset |
4 |
|
|
5 |
Installation of @AUCTeX{} under Windows is a bit more complicated, but |
Installation of @AUCTeX{} under Windows is in itself not more |
6 |
we are working to resolve the issues involved. Please report |
complicated than on other platforms. However, meeting the prerequisites |
7 |
success/failure to us at @email{auctex-devel@@gnu.org}. Here are the |
might require more work than on some other platforms, and feel less |
8 |
steps to perform: |
natural. |
9 |
|
|
10 |
|
If you are experiencing any problems, even if you think they are of your |
11 |
|
own making, be sure to report them to @email{auctex-devel@@gnu.org} so |
12 |
|
that we can explain things better in future. |
13 |
|
|
14 |
|
Windows is a problematic platform for installation scripts. The main |
15 |
|
problem is that the installation procedure requires consistent file |
16 |
|
names in order to find its way in the directory hierarchy, and Windows |
17 |
|
path names are a mess. |
18 |
|
|
19 |
|
The installation procedure tries finding stuff in system search paths |
20 |
|
and in Emacs paths. For that to succeed, you have to use the same |
21 |
|
syntax and spelling and case of paths everywhere: in your system search |
22 |
|
paths, in Emacs' @code{load-path} variable, as argument to the scripts. |
23 |
|
If your path names contain spaces or other `shell-unfriendly' |
24 |
|
characters, most notably backslashes for directory separators, place the |
25 |
|
whole path in @samp{"double quote marks"} whenever you specify it on a |
26 |
|
command line. |
27 |
|
|
28 |
|
Avoid `helpful' file names like @samp{/cygdrive/c} and |
29 |
|
@samp{C:\PROGRA~1\} like the plague. It is quite unlikely that the |
30 |
|
scripts will be able to identify the actual file names involved. Use |
31 |
|
the full paths, making use of normal Windows drive letters like |
32 |
|
@samp{C:} where required, and using the same combination of upper- and |
33 |
|
lowercase letters as in the actual files. |
34 |
|
|
35 |
|
Ok, now here are the steps to perform: |
36 |
|
|
37 |
@enumerate |
@enumerate |
38 |
@item |
@item |
39 |
If you unpacked the distribution using Winzip or similar, you better |
You need to unpack the @AUCTeX{} distribution (which you seemingly have |
40 |
restart using infozip on the @samp{.zip} file, or standard Unix tools |
done since you are reading this). It must be unpacked in a separate |
41 |
(see the next point) on the @samp{.tar.gz} file: tools that make the |
installation directory outside of your Emacs file hierarchy: the |
42 |
mistake of turning Unix line endings into MSDOS line endings will cause |
installation will later copy all necessary files to their final |
43 |
trouble later in installation and operation. |
destination, and you can ultimately remove the directory where you |
44 |
|
unpacked the files. |
45 |
|
|
46 |
|
The distribution contains only text files, and their line endings have |
47 |
|
to be proper for Windows, or you'll likely run into problems later on. |
48 |
|
Your unpacking tool probably has options for achieving this effect. |
49 |
|
Your chances might be better if you are using the @samp{.zip} archive |
50 |
|
rather than the @samp{.tar.gz} file. If you are loading files from the |
51 |
|
distribution into Emacs, its mode line should show the @samp{(DOS)} |
52 |
|
indicator. |
53 |
|
|
54 |
|
If you don't have a suitable unpacking tool, skip to the next step: this |
55 |
|
should provide you with a working @samp{unzip} command. |
56 |
|
|
57 |
@item |
@item |
58 |
The installation of @AUCTeX{} will require the MSYS tool set from |
The installation of @AUCTeX{} will require the MSYS tool set from |
59 |
@uref{http://www.mingw.org}. If you have the Cygwin tool set from |
@uref{http://www.mingw.org} or the Cygwin tool set from |
60 |
@uref{http://cygwin.com} installed, that should do just fine as well, |
@uref{http://cygwin.com}. The latter is slower and larger (the download |
61 |
but it is quite larger and slower. |
size of the base system is about 15 MB) but comes with a package manager |
62 |
|
that allows for updating the tool set and installing additional packages |
63 |
If you are installing @AUCTeX{} with one of those sets for an Emacs |
like, for example, the spell checker @w{aspell}. |
64 |
compiled in a different one, you should try to avoid tool-specific path |
|
65 |
names like @file{/cygwin/c}. Instead, use the @file{c:} syntax. It |
If Cygwin specific paths like @samp{/cygdrive/c} crop up in the course |
66 |
might also help to use forward slashes instead of the backward slashes |
of the installation, using a non-Cygwin Emacs could conceivably cause |
67 |
more typical for @w{MS Windows}: while backward slashes are supposed to |
trouble. Using Cygwin either for everything or nothing might save |
68 |
work if properly escaped in the shell, this is one area easily |
headaches, @emph{if} things don't work out. |
|
overlooked by the developers. The same holds for file or directory |
|
|
names with spaces in them. Another noteworthy problem is that you |
|
|
should be consistent with regard to using upper and lower case |
|
|
characters for directory names: while Windows ignores any differences in |
|
|
that area, the configuration scripts don't. |
|
|
|
|
|
It is appreciated if you report any problems you experienced when |
|
|
installing @AUCTeX{}, as we are trying our best to make it work |
|
|
even for platforms that we don't use ourselves. |
|
|
|
|
|
Compiling Emacs is outside of the scope of this manual. @AUCTeX{} |
|
|
itself does not require a @w{C compiler} for installation. |
|
69 |
|
|
70 |
@item |
@item |
71 |
Install a current version of XEmacs (such as 21.4.10) from |
Install a current version of XEmacs (such as 21.4.10) from |
72 |
@uref{http://www.xemacs.org} or try getting and compiling an |
@uref{http://www.xemacs.org} or try getting and compiling an developer |
73 |
@acronym{CVS} version of @w{GNU Emacs} from |
version of @w{Emacs 22} from |
74 |
@uref{http://savannah.gnu.org/cvs/?group=emacs,Savannah}. Precompiled |
@uref{http://savannah.gnu.org/cvs/?group=emacs,Savannah}. Compiling |
75 |
versions happen to be available at @uref{http://www.crasseux.com/emacs/} |
Emacs is outside of the scope of this manual. Precompiled versions |
76 |
and @uref{http://nqmacs.sf.net/}. |
currently happen to be available at |
77 |
|
@uref{http://www.crasseux.com/emacs/} and @uref{http://nqmacs.sf.net/}. |
78 |
If you disable the installation of @previewlatex{}, you might also use |
|
79 |
an @w{Emacs 21} binary from from |
If you don't want to use a developer version and @w{Emacs 22} has not |
80 |
@uref{http://ftp.gnu.org/pub/gnu/windows/emacs/}. |
yet been released, it is also possible to use an @w{Emacs 21} binary |
81 |
|
from from @uref{http://ftp.gnu.org/pub/gnu/windows/emacs/}, but then you |
82 |
|
should disable the installation of @previewlatex{} (it will not work). |
83 |
|
Since the developer version has seen quite a few improvements relevant |
84 |
|
also for other features of @AUCTeX{}, we really recommend you give it a |
85 |
|
try. |
86 |
|
|
87 |
@item |
@item |
88 |
You need a working @TeX{} installation. One popular installation under |
You need a working @TeX{} installation. One popular installation under |
91 |
which is rather close to its Unix cousins. |
which is rather close to its Unix cousins. |
92 |
|
|
93 |
@item |
@item |
94 |
|
A working copy of @uref{http://www.cs.wisc.edu/~ghost,Ghostscript} is |
95 |
|
required for @previewlatex{} operation. Examining the output from |
96 |
|
@example |
97 |
|
gswin32c -h |
98 |
|
@end example |
99 |
|
on a Windows command line should tell you whether your Ghostscript |
100 |
|
supports the @code{png16m} device needed for @acronym{PNG} support. |
101 |
|
MikTeX apparently comes with its own Ghostscript called @samp{mgs.exe}. |
102 |
|
|
103 |
|
@item |
104 |
@uref{http://www.perl.org,Perl} is needed for rebuilding the |
@uref{http://www.perl.org,Perl} is needed for rebuilding the |
105 |
documentation if you are working with a copy from @acronym{CVS} or have |
documentation if you are working with a copy from @acronym{CVS} or have |
106 |
touched documentation source files. This is needed for @previewlatex{} |
touched documentation source files in the @previewlatex{} part. If the |
107 |
documentation, strictly speaking. |
line endings of the file @file{preview/latex/preview.dtx} don't |
108 |
|
correspond with what Perl calls @code{\n} when reading text files, |
109 |
|
you'll run into trouble. |
110 |
|
|
111 |
@item |
@item |
112 |
Now the fun stuff starts. Unpack the @AUCTeX{} distribution into some |
Now the fun stuff starts. If you have not yet done so, unpack the |
113 |
installation directory. @strong{Do not} unpack it right into your Emacs' |
@AUCTeX{} distribution into a separate directory after rereading the |
114 |
own directories: the installation will copy the material that needs to |
instructions for unpacking above. |
|
be placed there. Keep the installation directory separate: you can |
|
|
remove its contents after installation completes. Since you are reading |
|
|
this, you probably have already unpacked @AUCTeX{}, but it should still |
|
|
be easy to move it elsewhere now. |
|
115 |
|
|
116 |
@item |
@item |
117 |
Ready for takeoff. Start some shell (typically @command{bash}) capable of |
Ready for takeoff. Start some shell (typically @command{bash}) capable of |
121 |
Typical options you'll want to specify will be |
Typical options you'll want to specify will be |
122 |
@table @code |
@table @code |
123 |
@item --prefix=@var{drive:/path/to/emacs-directory} |
@item --prefix=@var{drive:/path/to/emacs-directory} |
124 |
which makes sure that (1) the AUCTeX manual will be installed in the |
which tells @file{configure} where to perform the installation. It may |
125 |
@file{info/} directory of your Emacs installation and (2) the |
also make @file{configure} find Emacs or XEmacs automatically; if this |
126 |
automatically generated global style hooks will be installed in the |
doesn't happen, try one of @samp{--with-emacs} or @samp{--with-xemacs} |
127 |
@file{var/} directory of your Emacs installation. If you are collecting |
as described below. All automatic detection of files and directories |
128 |
stuff like that in a central directory hierarchy (not untypical with |
restricts itself to directories below the @var{prefix} or in the same |
129 |
Cygwin), you might want to specify that here instead. You stand a good |
hierarchy as the program accessing the files. |
130 |
chance that this will be the only option you need to supply, as long as |
|
131 |
your @TeX{}-related executables are in your system path, which they |
This option also affects the defaults for placing the Texinfo |
132 |
better be for @AUCTeX{}'s operation, anyway. |
documentation files and automatically generated style hooks. |
133 |
|
|
134 |
|
If you have a central directory hierarchy (not untypical with Cygwin) |
135 |
|
for such stuff, you might want to specify its root here. You stand a |
136 |
|
good chance that this will be the only option you need to supply, as |
137 |
|
long as your @TeX{}-related executables are in your system path, which |
138 |
|
they better be for @AUCTeX{}'s operation, anyway. |
139 |
|
|
140 |
@item --with-emacs |
@item --with-emacs |
141 |
if you are installing for a version of Emacs. You can use |
if you are installing for a version of Emacs. You can use |
142 |
@samp{--with-emacs=@var{/path/to/emacs}} to specify the name of the |
@samp{--with-emacs=@var{/path/to/emacs}} to specify the name of the |
143 |
installed Emacs executable, complete with its path if necessary (if |
installed Emacs executable, complete with its path if necessary (if |
144 |
Emacs is not within a directory specified in your @var{PATH} environment |
Emacs is not within a directory specified in your @env{PATH} environment |
145 |
setting). |
setting). |
146 |
|
|
147 |
@item --with-xemacs |
@item --with-xemacs |
149 |
@samp{--with-xemacs=@var{/path/to/xemacs}} to specify the name of the |
@samp{--with-xemacs=@var{/path/to/xemacs}} to specify the name of the |
150 |
installed XEmacs executable complete with its path if necessary. It may |
installed XEmacs executable complete with its path if necessary. It may |
151 |
also be necessary to specify this option if a copy of Emacs is found in |
also be necessary to specify this option if a copy of Emacs is found in |
152 |
your @var{PATH} environment setting, but you still would like to install |
your @env{PATH} environment setting, but you still would like to install |
153 |
a copy of @AUCTeX{} for XEmacs. |
a copy of @AUCTeX{} for XEmacs. |
154 |
|
|
|
@item --with-lispdir=@var{/dir} |
|
|
This may be needed for GNU Emacs installation, but hopefully |
|
|
@command{configure} should figure this out by itself. Don't use this for |
|
|
XEmacs, rather use |
|
|
|
|
155 |
@item --with-packagedir=@var{/dir} |
@item --with-packagedir=@var{/dir} |
156 |
which gives the location of the package directory for XEmacs where stuff |
is an XEmacs-only option giving the location of the package directory. |
157 |
should be installed. Again, hopefully this is not necessary to specify. |
This will install and activate the package. Emacs uses a different |
158 |
|
installation scheme: |
159 |
|
|
160 |
|
@item --with-lispdir=@var{/path/to/site-lisp} |
161 |
|
This Emacs-only option tells a place in @code{load-path} below which the |
162 |
|
files are situated. The startup files @file{auctex.el} and |
163 |
|
@file{preview-latex.el} will get installed here unless a subdirectory |
164 |
|
@file{site-start.d} exists which will then be used instead. The other |
165 |
|
files from @AUCTeX{} will be installed in a subdirectory called |
166 |
|
@file{auctex}. |
167 |
|
|
168 |
|
If you think that you need a different setup, please refer to the full |
169 |
|
installation instructions in |
170 |
|
@ifset rawfile |
171 |
|
the @file{INSTALL} file. |
172 |
|
@end ifset |
173 |
|
@ifclear rawfile |
174 |
|
@ref{Configure}. |
175 |
|
@end ifclear |
176 |
|
|
177 |
@item --with-auto-dir=@var{/dir} |
@item --with-auto-dir=@var{/dir} |
178 |
Directory containing automatically generated information. You should |
Directory containing automatically generated information. You should |
179 |
not normally need to set this, as @samp{--prefix} should take care of |
not normally need to set this, as @samp{--prefix} should take care of |
180 |
this. |
this. |
181 |
|
|
182 |
|
@item --disable-preview |
183 |
|
Use this option if your Emacs version is unable to support image |
184 |
|
display. This will be the case if you are using a native variant of |
185 |
|
@w{Emacs 21}. |
186 |
|
|
187 |
|
@item --with-texmf-dir=@var{dir} |
188 |
|
This will specify the directory where your @TeX{} installation sits. If |
189 |
|
your @TeX{} installation does not conform to the TDS (@TeX{} directory |
190 |
|
standard), you may need to specify more options to get everything in |
191 |
|
place: |
192 |
@end table |
@end table |
193 |
|
|
194 |
Some additional information about the above options may be found in |
For more information about any of the above and additional options, see |
195 |
@ifset rawfile |
@ifset rawfile |
196 |
the `Configure' section in the @file{INSTALL} file. |
the `Configure' section in the @file{INSTALL} file. |
197 |
@end ifset |
@end ifset |
199 |
@ref{Configure}. |
@ref{Configure}. |
200 |
@end ifclear |
@end ifclear |
201 |
|
|
202 |
|
Calling |
203 |
|
@file{./configure --help=recursive} |
204 |
|
will tell about other options, but those are almost never required. |
205 |
|
|
206 |
|
Some executables might not be found in your path. That is not a good |
207 |
|
idea, but you can get around by specifying environment variables to |
208 |
|
@file{configure}: |
209 |
|
@example |
210 |
|
GS="@var{/path/to/gswin32c.exe}" ./configure @dots{} |
211 |
|
@end example |
212 |
|
should work for this purpose. @file{gswin32c.exe} is the usual name for |
213 |
|
the required @emph{command line} executable under Windows; in contrast, |
214 |
|
@file{gswin32.exe} is likely to fail. |
215 |
|
|
216 |
@item |
@item |
217 |
Run @command{make} in the installation directory. |
Run @command{make} in the installation directory. |
218 |
|
|
220 |
Run @code{make install} in the installation directory. |
Run @code{make install} in the installation directory. |
221 |
|
|
222 |
@item |
@item |
223 |
For GNU Emacs, the recommended way to activate @AUCTeX{} is to add the |
With XEmacs, @AUCTeX{} and @previewlatex{} should now be active by |
224 |
following line to your @file{.emacs} file: |
default. With Emacs, acticavation depends on a working |
225 |
|
@file{site-start.d} directory or similar setup, since then the startup |
226 |
|
files @file{auctex.el} and @file{preview-latex.el} will have been placed |
227 |
|
there. If this has not been done, you should be able to load the |
228 |
|
startup files manually with |
229 |
|
@example |
230 |
|
(load "auctex.el" nil t t) |
231 |
|
(load "preview-latex.el" nil t t) |
232 |
|
@end example |
233 |
|
in either a site-wide @file{site-start.el} or your personal startup file |
234 |
|
(usually accessible as @file{~/.emacs} from within Emacs and |
235 |
|
@file{~/.xemacs/init.el} from within XEmacs). |
236 |
|
|
237 |
|
The default configuration of @AUCTeX{} is probably not the best fit for |
238 |
|
Windows systems. You might want to additionally use |
239 |
|
@example |
240 |
|
(require 'tex-mik) |
241 |
|
@end example |
242 |
|
or |
243 |
@example |
@example |
244 |
(require 'tex-site) |
(require 'tex-fptex) |
245 |
@end example |
@end example |
246 |
|
in order to get more appropriate values for Mik@TeX{} and fp@TeX{}, |
247 |
|
respectively. |
248 |
|
|
249 |
The configuration for Windows systems is probably not quite fitting. |
You can always use |
|
Instead of loading @file{tex-site.el} in that manner, you might want to |
|
|
load @file{tex-mik.el} (for Mik@TeX{}) or @file{tex-fptex} (for |
|
|
fp@TeX{}) instead. Those will lead to somewhat more appropriate values |
|
|
for your system. You can always use |
|
250 |
|
|
251 |
@example |
@example |
252 |
@kbd{M-x customize-group @key{RET} AUCTeX @key{RET}} |
@kbd{M-x customize-group @key{RET} AUCTeX @key{RET}} |
255 |
in order to customize more stuff, or use the @samp{Customize} menu. |
in order to customize more stuff, or use the @samp{Customize} menu. |
256 |
|
|
257 |
@item |
@item |
258 |
Load a @file{.tex} file Emacs or XEmacs and see if you get the |
Load @file{preview/circ.tex} into Emacs or XEmacs and see if you get the |
259 |
@samp{Command} menu. Try using that to @LaTeX{} the file. |
@samp{Command} menu. Try using it to @LaTeX{} the file. |
260 |
|
|
261 |
|
@item |
262 |
|
Check whether the @samp{Preview} menu is available in this file. Use it |
263 |
|
to generate previews for the document. |
264 |
|
|
265 |
|
If this barfs and tells you that image type @samp{png} is not |
266 |
|
supported, try adding the line |
267 |
|
|
268 |
|
@example |
269 |
|
(setq preview-image-type 'pnm) |
270 |
|
@end example |
271 |
|
|
272 |
|
at the end of your installed version of @file{preview-latex.el}. If |
273 |
|
this helps, complain to wherever you got your Emacs: all current |
274 |
|
Emacs/XEmacs versions capable of running @previewlatex{} by now can be |
275 |
|
compiled to support @acronym{PNG} images. Which is important, because |
276 |
|
@acronym{PNM} files take away @strong{vast} amount of disk space, and |
277 |
|
thus also of load/save time. |
278 |
|
|
279 |
@end enumerate |
@end enumerate |
280 |
Well, that about is all. Have fun! |
Well, that about is all. Have fun! |