|
24
|
1 Installation of AUC TeX
|
|
|
2 ***********************
|
|
|
3
|
|
|
4 Compiling
|
|
|
5 =========
|
|
|
6
|
|
|
7 The following describes how to install AUC TeX under Unix. You may
|
|
|
8 also be able to do use these instructions under some other operating
|
|
|
9 systems, if you have already installed the proper GNU tools, such as
|
|
|
10 `make'.
|
|
|
11
|
|
|
12 To install AUC TeX for an entire site (which may just be your own
|
|
|
13 personal Linux box), issue the following two commands as root:
|
|
|
14
|
|
|
15 make
|
|
|
16 make lispdir=/usr/local/share/emacs/site-lisp install
|
|
|
17
|
|
|
18 except that instead of /usr/local/... you should use the location of
|
|
|
19 your sites emacs installation. AUC TeX will then be installed in a
|
|
|
20 subdirectory named `auctex' of the `site-lisp' directory, and the file
|
|
|
21 `tex-site.el' will be stored directly in the `site-lisp'. You can now
|
|
|
22 tell your users to enable AUC TeX by adding
|
|
|
23
|
|
|
24 (require 'tex-site)
|
|
|
25
|
|
|
26 to their `.emacs' file.
|
|
|
27
|
|
|
28 If you use xemacs instead, or if your emacs binary is named something
|
|
|
29 else than `emacs', specify this by using the commands
|
|
|
30
|
|
|
31 make EMACS=xemacs
|
|
|
32 make lispdir=/usr/local/share/emacs/site-lisp install
|
|
|
33
|
|
|
34 to install.
|
|
|
35
|
|
|
36 If you want to install AUC TeX in your personal account, you should
|
|
|
37 chose a directory for all your emacs add-ons, for example an `elisp'
|
|
|
38 subdirectory in your home directory. You can then install AUC TeX with
|
|
|
39 the commands
|
|
|
40
|
|
|
41 make
|
|
|
42 make lispdir=$HOME/elisp install
|
|
|
43
|
|
|
44 You will then need to add the following lines to your `.emacs' file:
|
|
|
45
|
|
|
46 (setq load-path (cons "~/elisp" load-path))
|
|
|
47 (require 'tex-site)
|
|
|
48
|
|
|
49 Customizing
|
|
|
50 ===========
|
|
|
51
|
|
|
52 Next, you should edit the file `tex-site.el' to fit your local site.
|
|
|
53 You do this by looking at the customization section in the beginning
|
|
|
54 of `tex.el' and copy the definitions that are wrong for your site to
|
|
|
55 `tex-site.el'. Do *not* edit `tex.el' directly, or you will have to do
|
|
|
56 all the work over again when you upgrade AUC TeX. AUC TeX will not
|
|
|
57 overwrite your old `tex-site.el' file next time you install, so you
|
|
|
58 will be able to keep all your customizations.
|
|
|
59
|
|
|
60 There are two variables with a special significance.
|
|
|
61
|
|
|
62 - User Option: TeX-lisp-directory
|
|
|
63 The directory where you want to install the AUC TeX lisp files.
|
|
|
64
|
|
|
65 This variable is set automatically by the `make install' command.
|
|
|
66 If you don't issue a `make install', for example if you don't want to
|
|
|
67 install AUC TeX in a different place, you will have to set this
|
|
|
68 variable manually to the location of the compiled files.
|
|
|
69
|
|
|
70 - User Option: TeX-macro-global
|
|
|
71 Directories containing the site's TeX style files.
|
|
|
72
|
|
|
73 Normally, AUC TeX will only allow you to complete a short list of
|
|
|
74 build-in macros and environments and on the macros you define yourself.
|
|
|
75 If you issue the `M-x TeX-auto-generate-global' command after loading
|
|
|
76 AUC TeX, you will be able to complete on all macros available in the
|
|
|
77 standard style files used by your document. To do this, you must set
|
|
|
78 this variable to a list of directories where the standard style files
|
|
|
79 are located. The directories will be searched recursively, so there is
|
|
|
80 no reason to list subsirectories explicitly.
|
|
|
81
|
|
|
82 You probably also need to change `TeX-command-list' to make sure
|
|
|
83 that the commands used for starting TeX, printing, etc. work on your
|
|
|
84 system. Copy the definition from `tex.el' to `tex-site.el' and edit
|
|
|
85 the command names appropriately.
|
|
|
86
|
|
|
87 Finally, copy and edit `TeX-printer-list' to contain the printers
|
|
|
88 available at your site.
|
|
|
89
|
|
|
90 To extract information from your sites TeX macros, type `M-x
|
|
|
91 TeX-auto-generate-global' in your emacs. This will only work if you
|
|
|
92 have set `TeX-macro-global' correctly in `tex-site.el'.
|
|
|
93
|
|
|
94 Contributed files
|
|
|
95 =================
|
|
|
96
|
|
|
97 There are several files that are not part of AUC TeX proper, but
|
|
|
98 included in the distribution in case they are useful.
|
|
|
99
|
|
|
100 `hilit-LaTeX.el'
|
|
|
101 Better highlighting for the obsolete `hilit19' package.
|
|
|
102
|
|
|
103 `font-latex.el'
|
|
|
104 Better highlighting for the FONT-LOCK package.
|
|
|
105
|
|
|
106 `bib-cite.el'
|
|
|
107 Better support for bibliographies and much more.
|
|
|
108
|
|
|
109 `tex-jp.el'
|
|
|
110 Support for Japanese.
|
|
|
111
|
|
|
112 `func-doc.el'
|
|
|
113 Support for context sensitive online help for various languages.
|
|
|
114
|
|
|
115 Read the comments in the start of each file for more information
|
|
|
116 about how to install, what they do, and who wrote and maintains them.
|
|
|
117
|
