1 |
@include macros.texi |
@include macros.texi |
2 |
|
@include auto.texi |
3 |
@ifset rawfile |
@ifset rawfile |
4 |
@node Top |
@node Top |
5 |
@top Installing @previewlatex{} |
@top Installing @previewlatex{} |
6 |
|
|
7 |
@end ifset |
@end ifset |
8 |
@c ----------------------- |
@c ----------------------- |
9 |
|
@ifset embedded |
10 |
|
This version of @previewlatex{} gets installed as part of @AUCTeX{}, so |
11 |
|
we'll just mention the installation options that happen to be specific |
12 |
|
to @previewlatex{}. |
13 |
|
@end ifset |
14 |
|
@ifclear embedded |
15 |
Installing @previewlatex{} should be simple: merely |
Installing @previewlatex{} should be simple: merely |
16 |
@command{./configure}, @command{make}, and @code{make install} for a |
@command{./configure}, @command{make}, and @code{make install} for a |
17 |
standard site-wide installation (most other installations can be done by |
standard site-wide installation (most other installations can be done by |
18 |
specifying a @option{--prefix=@dots{}} option). This does not yet |
specifying a @option{--prefix=@dots{}} option). This does not yet |
19 |
activate the package, but merely makes it available. See @ref{Loading |
activate the package, but merely makes it available. See @ref{Loading |
20 |
the package} for the activation. Note that unlike most emacs add-ins, |
the package} for the activation. |
21 |
|
@end ifclear |
22 |
|
Note that unlike most emacs add-ins, |
23 |
@previewlatex{} consists of a @TeX{} part and an Emacs part (that uses |
@previewlatex{} consists of a @TeX{} part and an Emacs part (that uses |
24 |
@AUCTeX{}). This makes configuration a bit trickier than normal. |
@AUCTeX{}). This makes configuration a bit trickier than normal. |
25 |
Please read through this document fully before installing anything. |
Please read through this document fully before installing anything. |
63 |
Since @previewlatex{} heavily exercises newer features, getting the |
Since @previewlatex{} heavily exercises newer features, getting the |
64 |
latest release is a good idea. Developer versions of @w{Emacs 22} are |
latest release is a good idea. Developer versions of @w{Emacs 22} are |
65 |
mostly preferable to the released versions of @w{Emacs 21} due to |
mostly preferable to the released versions of @w{Emacs 21} due to |
66 |
performance and handling reasons. XEmacs (21.4.15 or later, but not the |
performance and handling reasons, and are mandatory for any platform |
67 |
|
except basic X11 toolkits. XEmacs (21.4.15 or later, but not the |
68 |
withdrawn 21.4.16) is supported nominally, but is not particularly |
withdrawn 21.4.16) is supported nominally, but is not particularly |
69 |
recommended because of handling, image quality and stability reasons. |
recommended because of handling, image quality and stability reasons. |
70 |
|
|
75 |
@ifclear rawfile |
@ifclear rawfile |
76 |
@xref{Installation under MS Windows}. |
@xref{Installation under MS Windows}. |
77 |
@end ifclear |
@end ifclear |
78 |
|
@ifclear embedded |
79 |
@item A working @AUCTeX{} installation |
@item A working @AUCTeX{} installation |
80 |
|
|
81 |
@AUCTeX{} can be found at @uref{http://www.gnu.org/software/auctex}. |
@AUCTeX{} can be found at @uref{http://www.gnu.org/software/auctex}. |
82 |
This site now provides up-to-date tarballs as well as RPMs. At the time |
This site now provides up-to-date tarballs as well as RPMs. At the time |
83 |
of this writing, the latest version is 11.55. You need at least 11.51 |
of this writing, the latest version is 11.55. You need at least 11.51 |
84 |
to support PDF@LaTeX{} operation. |
to support PDF@LaTeX{} operation. Versions of 11.80 or later should |
85 |
|
already come with @previewlatex{} included, unless you have a |
86 |
|
precompiled package that explicitly disabled it. |
87 |
|
@end ifclear |
88 |
|
|
89 |
@item A working @LaTeX{} installation |
@item A working @LaTeX{} installation |
90 |
|
|
122 |
|
|
123 |
@node Configure |
@node Configure |
124 |
@section Configure |
@section Configure |
125 |
|
@ifset embedded |
126 |
|
The configuration is already described for @AUCTeX{}, so we'll just |
127 |
|
mention additionally available options to @command{configure}: |
128 |
|
@end ifset |
129 |
|
@ifclear embedded |
130 |
The first step is to configure the source code, telling it where |
The first step is to configure the source code, telling it where |
131 |
various files will be. To do so, run |
various files will be. To do so, run |
132 |
|
|
134 |
./configure @var{options} |
./configure @var{options} |
135 |
@end example |
@end example |
136 |
|
|
137 |
(Note: if you have fetched @previewlatex{} from @acronym{CVS} rather than |
(Note: if you have fetched @previewlatex{} from @acronym{CVS} rather |
138 |
a regular release, you will have to first generate @command{./configure} by |
than a regular release, you will have to first generate |
139 |
running @code{autogen.sh} in the @file{preview} directory.) |
@command{./configure} by running @code{autogen.sh} in the @file{preview} |
140 |
|
directory.) |
141 |
|
|
142 |
On many machines, you will not need to specify any options, but if |
On many machines, you will not need to specify any options, but if |
143 |
@code{configure} cannot determine something on its own, you'll need to |
@code{configure} cannot determine something on its own, you'll need to |
144 |
help it out with one of these options: |
help it out with one of these options: |
145 |
|
@end ifclear |
146 |
|
|
147 |
@table @code |
@table @code |
148 |
|
@ifclear embedded |
149 |
@item --prefix=@file{/usr/local} |
@item --prefix=@file{/usr/local} |
150 |
All automatic placements for package components will be chosen from |
All automatic placements for package components will be chosen from |
151 |
sensible existing hierarchies below this. Only if no workable |
sensible existing hierarchies below this. Only if no workable |
182 |
installed (the bulk will get installed in a subdirectory). |
installed (the bulk will get installed in a subdirectory). |
183 |
@file{./configure} should figure this out by itself. |
@file{./configure} should figure this out by itself. |
184 |
|
|
|
@item --with-preview-startfile=@file{preview-latex.el} |
|
|
This is the name of the startup file. If @var{lispdir} contains a |
|
|
subdirectory @file{site-start.d}, @var{startfile} defaults to |
|
|
@file{site-start.d/preview-latex.el}, and @file{site-start.el} should |
|
|
load it automatically. Please be aware that you must not move the |
|
|
@var{startfile} after installation since other files are found |
|
|
@emph{relative} to it. |
|
|
|
|
185 |
@item --with-packagelispdir=@file{preview} |
@item --with-packagelispdir=@file{preview} |
186 |
This is the directory where the bulk of the package gets located. The |
This is the directory where the bulk of the package gets located. The |
187 |
startfile adds this into @var{load-path}. |
startfile adds this into @var{load-path}. |
190 |
If @AUCTeX{} is installed in a non-standard location, use this option to |
If @AUCTeX{} is installed in a non-standard location, use this option to |
191 |
specify the location of its @file{tex-site.el} file so that it can be |
specify the location of its @file{tex-site.el} file so that it can be |
192 |
found during compilation. |
found during compilation. |
193 |
|
@end ifclear |
194 |
|
|
195 |
|
@item --with-preview-startfile=@file{preview-latex.el} |
196 |
|
This is the name of the startup file. If @var{lispdir} contains a |
197 |
|
subdirectory @file{site-start.d}, @var{startfile} defaults to |
198 |
|
@file{site-start.d/preview-latex.el}, and @file{site-start.el} should |
199 |
|
load it automatically. Please be aware that you must not move the |
200 |
|
@var{startfile} after installation since other files are found |
201 |
|
@emph{relative} to it. |
202 |
|
|
203 |
@item --with-texmf-dir=@var{/dir}@*--without-texmf-dir |
@item --with-texmf-dir=@var{/dir}@*--without-texmf-dir |
204 |
@cindex preview-install-styles |
@cindex preview-install-styles |
224 |
It is to be used when you are using @code{--with-tex-dir=@var{/dir}}, |
It is to be used when you are using @code{--with-tex-dir=@var{/dir}}, |
225 |
but is normally not necessary otherwise. |
but is normally not necessary otherwise. |
226 |
|
|
227 |
|
@ifset embedded |
228 |
|
@item --help=recursive |
229 |
|
@end ifset |
230 |
|
@ifclear embedded |
231 |
@item --help |
@item --help |
232 |
|
@end ifclear |
233 |
This is not an option specific to @previewlatex{}. A number of standard |
This is not an option specific to @previewlatex{}. A number of standard |
234 |
options to @file{configure} exist, and we do not have the room to |
options to @file{configure} exist, and we do not have the room to |
235 |
describe them here; a short description of each is available, using |
describe them here; a short description of each is available by using |
236 |
@code{--help}. |
this option. |
237 |
|
|
238 |
@end table |
@end table |
239 |
|
|
240 |
@node Build/install |
@node Build/install |
241 |
@section Build/install |
@section Build/install |
242 |
|
|
243 |
|
@ifset embedded |
244 |
|
There is nothing specific to @previewlatex{} you have to do here when |
245 |
|
installing @AUCTeX{}. |
246 |
|
@end ifset |
247 |
|
@ifclear embedded |
248 |
Once @file{configure} has been run, simply enter |
Once @file{configure} has been run, simply enter |
249 |
|
|
250 |
@example |
@example |
262 |
@noindent |
@noindent |
263 |
You may need special privileges to install, e.g., if you are installing |
You may need special privileges to install, e.g., if you are installing |
264 |
into system directories. |
into system directories. |
265 |
|
@end ifclear |
266 |
|
|
267 |
@node Loading the package |
@node Loading the package |
268 |
@section Loading the package |
@section Loading the package |
278 |
visible, and @kbd{C-c C-p C-d} should produce previews. |
visible, and @kbd{C-c C-p C-d} should produce previews. |
279 |
|
|
280 |
If you used @code{--with-packagedir}, you have to make sure that the |
If you used @code{--with-packagedir}, you have to make sure that the |
281 |
directory @file{lisp/preview} under the directory you specified is in |
directory |
282 |
XEmacs' @code{load-path} variable. The package system should normally |
@ifset embedded |
283 |
cater for that. |
@file{lisp/auctex} |
284 |
|
@end ifset |
285 |
|
@ifclear embedded |
286 |
|
@file{lisp/preview} |
287 |
|
@end ifclear |
288 |
|
under the directory you specified is in XEmacs' @code{load-path} |
289 |
|
variable. The package system should normally cater for that. |
290 |
|
|
291 |
With Emacs (or if you explicitly disabled use of the package system), |
With Emacs (or if you explicitly disabled use of the package system), |
292 |
the file @file{preview-latex.el} (which is generated during the |
the file @file{preview-latex.el} (which is generated during the |
324 |
@node Advice for package providers |
@node Advice for package providers |
325 |
@section Providing @previewlatex{} as a package |
@section Providing @previewlatex{} as a package |
326 |
|
|
|
As a package provider, you should make sure that your users will be |
|
|
served best according to their intentions, and keep in mind that a |
|
|
system might be used by more than one user, with different preferences. |
|
327 |
The use of packages should in general not impact performance negatively |
The use of packages should in general not impact performance negatively |
328 |
if a user chooses not to employ it, but should be as convenient as |
if a user chooses not to employ it, but should be as convenient as |
329 |
possible. |
possible. |
351 |
@file{site-start.el} file. For the XEmacs package system, the default |
@file{site-start.el} file. For the XEmacs package system, the default |
352 |
@previewlatex{} installation will do something equivalent. |
@previewlatex{} installation will do something equivalent. |
353 |
|
|
354 |
|
@ifclear embedded |
355 |
For @acronym{RPM} files we include a @file{preview-latex.spec} file in |
For @acronym{RPM} files we include a @file{preview-latex.spec} file in |
356 |
the tarball distribution, suitable for recent RedHat systems, that |
the tarball distribution, suitable for recent RedHat systems, that |
357 |
should do just that. |
should do just that. |
358 |
|
@end ifclear |
359 |
|
|
360 |
If your package is intended as an XEmacs package or to accompany a |
If your package is intended as an XEmacs package or to accompany a |
361 |
precompiled version of Emacs, you might not know which @TeX{} system |
precompiled version of Emacs, you might not know which @TeX{} system |
362 |
will be available when @previewlatex{} gets used. In this case you |
will be available when @previewlatex{} gets used. In this case you |
363 |
should build using the @code{--without-texmf-dir} option described |
should build using the @code{--without-texmf-dir} option described |
364 |
previously. |
previously. This can also be convenient for systems that are intended |
365 |
|
to support more than a single TeX distribution. Since more often than |
366 |
|
not @TeX{} packages for operating system distributions are either much |
367 |
|
more outdated or much less complete than separately provided systems |
368 |
|
like @TeX{}live, this method may be generally preferred as the more |
369 |
|
flexible one. |
370 |
|
|
371 |
@node Advice for non-privileged users |
@node Advice for non-privileged users |
372 |
@section Installation for non-privileged users |
@section Installation for non-privileged users |
373 |
|
|
374 |
|
@ifclear embedded |
375 |
Often people without system administration privileges want to install |
Often people without system administration privileges want to install |
376 |
software for their private use. In that case you need to specify more |
software for their private use. In that case you need to specify more |
377 |
options top the @file{configure} script. For XEmacs users, this is |
options top the @file{configure} script. For XEmacs users, this is |
451 |
visible. However, you might want to set @samp{INFOPATH} anyway, for the |
visible. However, you might want to set @samp{INFOPATH} anyway, for the |
452 |
sake of standalone readers outside of XEmacs. (The info files in XEmacs |
sake of standalone readers outside of XEmacs. (The info files in XEmacs |
453 |
are normally in @file{~/.xemacs/xemacs-packages/info}.) |
are normally in @file{~/.xemacs/xemacs-packages/info}.) |
454 |
|
@end ifclear |
455 |
|
|
456 |
@subheading Making the @LaTeX{} style available |
@subheading Making the @LaTeX{} style available |
457 |
|
|
458 |
Again, for yourself you want to manipulate the @samp{TEXINPUTS} |
If you configured the system @samp{--without-texmf-dir}, then it should |
459 |
|
just work for other users. |
460 |
|
|
461 |
|
If not: for yourself you want to manipulate the @samp{TEXINPUTS} |
462 |
environment variable or an appropriate setting of a personal |
environment variable or an appropriate setting of a personal |
463 |
@samp{texmf.cnf} file. It may well be that your site configuration |
@samp{texmf.cnf} file. It may well be that your site configuration |
464 |
already caters for a personal user's @file{texmf} tree, in |
already caters for a personal user's @file{texmf} tree, in which case |
465 |
which case having specified the appropriate tree to |
having specified the appropriate tree to @command{./configure} will have |
466 |
@command{./configure} will have set up everything for yourself. |
set up everything for yourself. If that personal tree is not located at |
467 |
If that personal tree is not located at the equivalent of |
the equivalent of @file{~myself/share/texmf}, it is a good idea to make |
468 |
@file{~myself/share/texmf}, it is a good idea to make this so with |
this so with the help of a symbolic link, so that the usual |
469 |
the help of a symbolic link, so that the usual @samp{--prefix} |
@samp{--prefix} invocation to @command{./configure} is everything that |
470 |
invocation to @command{./configure} is everything that is needed. |
is needed. |
471 |
|
|
472 |
For others, you want to add something like |
For others, you want to add something like |
473 |
|
|