~ubuntu-branches/ubuntu/natty/auctex/natty

« back to all changes in this revision

Viewing changes to doc/intro.texi

  • Committer: Bazaar Package Importer
  • Author(s): Davide G. M. Salvetti
  • Date: 2007-03-14 00:43:56 UTC
  • mfrom: (2.1.8 feisty)
  • Revision ID: james.westby@ubuntu.com-20070314004356-xtqoxu6ousd1ldn6
Tags: 11.83-6
* Rebuild with clean source.
* rules.in (build-package): Added dependency on the "clean" target.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
@include macros.texi
2
 
@node Introduction
 
2
@ifset rawfile
 
3
@chapheading Introduction to @AUCTeX{}
 
4
@raisesections
 
5
@end ifset
 
6
 
 
7
@ifclear rawfile
 
8
@node Introduction, Installation, Copying, top
3
9
@chapter Introduction to @AUCTeX{}
4
 
 
5
 
This section of the @AUCTeX{} manual gives a brief overview of what
6
 
@AUCTeX{} is, and the section is also available as a @file{README} file.
7
 
It is @strong{not} an attempt to document @AUCTeX{}.  Real documentation
8
 
for @AUCTeX{} is available in the rest of the manual, which you can find
9
 
in the @file{doc} directory.
10
 
 
11
 
Read the @file{INSTALL} or @file{INSTALL.windows} file respectively for
12
 
information about how to install @AUCTeX{}.  The files comprise the same
13
 
information as the Installation chapter in the @AUCTeX{} manual.
14
 
 
15
 
If you are upgrading from the previous version of @AUCTeX{}, the latest
16
 
changes can be found in the @file{CHANGES} file.  If you are upgrading
17
 
from an older version, read the History chapter in the @AUCTeX{} manual.
 
10
@end ifclear
 
11
 
 
12
@ifset rawfile
 
13
This file
 
14
@end ifset
 
15
@ifclear rawfile
 
16
This section of the @AUCTeX{} manual
 
17
@end ifclear
 
18
gives a brief overview of what @AUCTeX{} is.  It is @strong{not} an
 
19
attempt to document @AUCTeX{}.  Real documentation for @AUCTeX{} is
 
20
available in the
 
21
@ifset rawfile
 
22
manual, which should be available as an info file after installation.
 
23
@end ifset
 
24
@ifclear rawfile
 
25
rest of the manual.
 
26
@end ifclear
 
27
 
 
28
@section Installation
 
29
 
 
30
Read the
 
31
@ifset rawfile
 
32
@file{INSTALL} or @file{INSTALL.windows} file
 
33
@end ifset
 
34
@ifclear rawfile
 
35
section @ref{Installation}, or @ref{Installation under MS Windows},
 
36
@end ifclear
 
37
respectively for comprehensive information about how to install
 
38
@AUCTeX{}.
 
39
 
 
40
The installation routine tries to make the modes provided by @AUCTeX{}
 
41
the default for all supported file types.  If this does not happen in
 
42
your case, add
 
43
@lisp
 
44
(load "auctex.el" nil t t)
 
45
@end lisp
 
46
to your init file and consult the section
 
47
@ifset rawfile
 
48
about loading the package in the @file{INSTALL} file.
 
49
@end ifset
 
50
@ifclear rawfile
 
51
@ref{Loading the package}.
 
52
@end ifclear
 
53
 
 
54
If you want to change the modes for which it is operative instead of the
 
55
default, use
 
56
@example
 
57
@kbd{M-x customize-variable RET TeX-modes RET}
 
58
@end example
 
59
 
 
60
If you want to remove a preinstalled @AUCTeX{} completely before any of
 
61
its modes have been used,
 
62
@example
 
63
(unload-feature 'tex-site)
 
64
@end example
 
65
should accomplish that.
 
66
 
 
67
If you are considering upgrading @AUCTeX{}, the recent changes are
 
68
described in
 
69
@ifset rawfile
 
70
the @file{CHANGES} file.
 
71
@end ifset
 
72
@ifclear rawfile
 
73
@ref{Changes}.
 
74
@end ifclear
 
75
 
 
76
@section Features
18
77
 
19
78
@AUCTeX{} is a comprehensive customizable integrated environment for
20
 
writing input files for @TeX{}/@LaTeX{}/@ConTeXt{} using GNU Emacs.
21
 
 
22
 
@AUCTeX{} lets you run @TeX{}/@LaTeX{}/@ConTeXt{} and
23
 
@LaTeX{}/@ConTeXt{}-related tools, such as a output filters or post
24
 
processor from inside Emacs.  Especially `running @LaTeX{}' is
25
 
interesting, as @AUCTeX{} lets you browse through the errors @TeX{}
26
 
reported, while it moves the cursor directly to the reported error, and
27
 
displays some documentation for that particular error.  This will even
28
 
work when the document is spread over several files.
 
79
writing input files for @TeX{}/@LaTeX{}/@ConTeXt{}/Texinfo using Emacs
 
80
or XEmacs.
 
81
 
 
82
It lets you process your source files by running @TeX{} and related
 
83
tools (such as output filters, post processors for generating indices
 
84
and bibliographies, and viewers) from inside Emacs.  @AUCTeX{} lets you
 
85
browse through the errors @TeX{} reported, while it moves the cursor
 
86
directly to the reported error, and displays some documentation for that
 
87
particular error.  This will even work when the document is spread over
 
88
several files.
 
89
 
 
90
One component of @AUCTeX{} that @LaTeX{} users will find attractive is
 
91
@previewlatex{}, a combination of folding and in-source previewing
 
92
that provides true ``What You See Is What You Get'' experience in your
 
93
sourcebuffer, while letting you retain full control.  @previewlatex{}
 
94
comes with its own manual, see @ref{Top, , preview-latex,
 
95
preview-latex, The @previewlatex{} Manual}.
 
96
@ifset rawfile
 
97
For more information, see further below.
 
98
@end ifset
29
99
 
30
100
@AUCTeX{} automatically indents your `@LaTeX{}-source', not only as you
31
101
write it --- you can also let it indent and format an entire document.
34
104
 
35
105
Apart from these special features, @AUCTeX{} provides a large range of
36
106
handy Emacs macros, which in several different ways can help you write
37
 
your @LaTeX{}/@ConTeXt{} documents fast and painlessly.
 
107
your documents fast and painlessly.
38
108
 
39
109
All features of @AUCTeX{} are documented using the GNU Emacs online
40
110
documentation system.  That is, documentation for any command is just
41
111
a key click away!
42
112
 
43
113
@AUCTeX{} is written entirely in Emacs-Lisp, and hence you can easily
44
 
add new features for your own needs.  It was not made as part of any
45
 
particular employment or project (apart from the @AUCTeX{} project
46
 
itself).  @AUCTeX{} is distributed under the `GNU Emacs General Public
47
 
License' and may therefore almost freely be copied and redistributed.
48
 
 
49
 
The next sections are a short introduction to some `actual' features.
50
 
For further information, refer to the built-in online documentation of
51
 
@AUCTeX{}.
 
114
add new features for your own needs.  It has become recently a GNU
 
115
project.  @AUCTeX{} is distributed under the `GNU General Public License
 
116
Version 2'.
52
117
 
53
118
@section Availability
54
119
 
66
131
 
67
132
@section Contacts
68
133
 
69
 
There has been established a mailing list for help, bug reports, feature
70
 
requests and general discussion about @AUCTeX{}.  You're very welcome
71
 
to join.  Traffic average at an article by day, but they come in bursts.
72
 
If you are only interested in information on updates, you could refer to
73
 
the newsgroups @samp{comp.text.tex} and @samp{gnu.emacs.sources}.
74
 
 
75
 
If you want to contact the @AUCTeX{} mailing list, send mail to
76
 
@email{auc-tex-subscribe@@sunsite.dk} in order to join.  Articles should
77
 
be sent to @email{auc-tex@@sunsite.dk}.
78
 
 
79
 
To contact the current maintainers of @AUCTeX{} directly, email
80
 
@email{auc-tex_mgr@@sunsite.dk}.
 
134
Various mailing lists exist.
 
135
 
 
136
Send a mail with the subject ``subscribe'' to
 
137
@email{auctex-request@@gnu.org} in order to join the general discussion
 
138
list for @AUCTeX{}.  Articles should be sent to @email{auctex@@gnu.org}.
 
139
In a similar way, you can subscribe to the @email{info-auctex@@gnu.org}
 
140
list for just getting important announcements about @AUCTeX{}.  The list
 
141
@email{bug-auctex@@gnu.org} is for bug reports which you should usually
 
142
file with the @kbd{M-x TeX-submit-bug-report RET} command.
 
143
 
 
144
If you want to address the developers of @AUCTeX{} themselves with
 
145
technical issues, they can be found on the discussion list
 
146
@email{auctex-devel@@gnu.org}.