Mercurial > hg > xemacs-beta

comparison man/auctex/install.texi @ 24:4103f0995bd7 r19-15b95

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