~ubuntu-branches/ubuntu/saucy/ecb/saucy

« back to all changes in this revision

Viewing changes to html-help/ecb.html

  • Committer: Bazaar Package Importer
  • Author(s): Joerg Jaspert
  • Date: 2004-09-01 22:15:18 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040901221518-0jfdt2apb2rj69ey
Tags: 2.27-1
And include latest Upstream too...

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
Up:<a rel=up accesskey=u href="../ecb.html#dir">(dir)</a>
16
16
<hr><br>
17
17
 
18
 
<p>This is the user manual for ECB version 2.21.
19
 
 
20
 
<p>ECB stands for "Emacs Code Browser" and is a source-code-browser for
21
 
(X)Emacs. It is a global minor-mode which offers a
22
 
language-independent and complete IDE (Integrated Development
23
 
Environment) within one Emacs-frame. It displays a couple of windows
24
 
that can be used to browse directories, files and file-contents like
25
 
methods and variables. It supports source-code parsing for
26
 
semantic-supported languages like Java, C, C++, Elisp and Scheme as
27
 
well as for source-types supported "only" by imenu or etags (e.g. 
28
 
perl, TeX, LaTeX etc.). In addition it offers (optional) a durable
29
 
"compile-window" at the bottom of the frame which is used to display
30
 
all help-, grep-, compile- and etc.-output. The rest of the frame is
31
 
called the "edit-area" which can be divided in several (no limit)
32
 
edit-windows which are used for editing of sources. Deleting some of
33
 
the edit-windows does neither destroy the compile-window nor the
34
 
browsing-windows.
 
18
<p>This is the user manual for ECB version 2.27.
 
19
 
 
20
<p>ECB stands for "Emacs Code Browser". While (X)Emacs already has good
 
21
<strong>editing</strong> support for many modes, its <strong>browsing</strong> support
 
22
is somewhat lacking. That's where ECB comes in: it displays a number
 
23
of informational windows that allow for easy source code navigation
 
24
and overview.
 
25
 
 
26
<p>The informational windows can contain:
 
27
 
 
28
<ul>
 
29
<li>A directory tree,
 
30
<li>a list of source files in the current directory,
 
31
<li>a list of functions/classes/methods/... in the current file,
 
32
(ECB uses the Semantic Bovinator, or Imenu, or etags, for getting this
 
33
list so all languages supported by any of these tools are
 
34
automatically supported by ECB too)
 
35
<li>a history of recently visited files,
 
36
<li>the Speedbar and
 
37
<li>output from compilation (the "*compilation*" window) and other
 
38
modes like help, grep etc. or whatever a user defines to be displayed
 
39
in this window. 
 
40
</ul>
 
41
 
 
42
<p>As an added bonus, ECB makes sure to keep these informational windows
 
43
visible, even when you use <kbd>C-x 1</kbd> and similar commands.
 
44
 
 
45
<p>It goes without saying that you can configure the layout, ie which
 
46
informational windows should be displayed where. ECB comes with a
 
47
number of ready-made window layouts to choose from.
35
48
 
36
49
<p><strong>Please note</strong>: Experienced ECB users find a complete
37
50
alphabetical list of all commands and user-options in <a href="Interactive-ECB-commands.html#Interactive%20ECB%20commands">Interactive ECB commands</a> and <a href="Customizable-options.html#Customizable%20options">Customizable options</a>.
43
56
mailing list <a href="mailto:ecb-list@lists.sourceforge.net">ecb-list@lists.sourceforge.net</a> via
44
57
<a href="http://lists.sourceforge.net/lists/listinfo/ecb-list">http://lists.sourceforge.net/lists/listinfo/ecb-list</a>
45
58
 
 
59
<p><strong>IMPORTANT</strong>: Cause of extra appearance of SPAM in the
 
60
mailing-lists, SourceForge has changed its policy: Now it is only
 
61
possible to post to the mailing-list for users who have subscribed
 
62
this mailing-list. So please be aware you will not be able to send
 
63
comments, bug reports and improvement suggestions before you have
 
64
subscribed the ECB-mailing-list. See the section "Mailing-list" at the
 
65
ECB-website at
 
66
<a href="http://ecb.sourceforge.net">http://ecb.sourceforge.net</a>
 
67
how to do this.
 
68
 
46
69
<ul>
47
70
<li><a accesskey=1 href="Install-and-first-steps.html#Install%20and%20first%20steps">Install and first steps</a>:      Installing ECB and first steps
48
71
<li><a accesskey=2 href="Overview.html#Overview">Overview</a>:                     Introduce basic concepts
96
119
<li><a href="The-edit-area.html#The%20edit-area">The edit-area</a>:                How to use the edit-area
97
120
<li><a href="Temp--and-compile-buffers.html#Temp-%20and%20compile-buffers">Temp- and compile-buffers</a>:    Displaying temp- and compilation-buffers
98
121
<li><a href="The-other-window.html#The%20other%20window">The other window</a>:             How the ``other window'' is determined
99
 
<li><a href="The-Methods-buffer.html#The%20Methods%20buffer">The Methods buffer</a>:           Using and customizing he Methods-buffer
 
122
<li><a href="The-Methods-buffer.html#The%20Methods%20buffer">The Methods buffer</a>:           Using and customizing the Methods-buffer
 
123
<li><a href="Filtering-the-tree-buffers.html#Filtering%20the%20tree-buffers">Filtering the tree-buffers</a>:   Applying filters to the ECB-tree-buffers
100
124
<li><a href="The-ECB-layout.html#The%20ECB-layout">The ECB-layout</a>:               Changing, customizing, redrawing, creating
101
125
<li><a href="Hiding-the-ECB-windows.html#Hiding%20the%20ECB%20windows">Hiding the ECB windows</a>:       Hiding/Showing the ECB-windows
102
126
<li><a href="Maximizing-the-ECB-windows.html#Maximizing%20the%20ECB%20windows">Maximizing the ECB windows</a>:   Maximizing the ECB-windows
118
142
<li><a href="Customizing-the-display.html#Customizing%20the%20display">Customizing the display</a>:      How to customize the Methods-buffer display
119
143
<li><a href="Rebuilding-the-Methods.html#Rebuilding%20the%20Methods">Rebuilding the Methods</a>:       When to rebuild the Methods-buffer
120
144
 
 
145
<p>Applying filters to the special ECB-tree-buffers
 
146
 
 
147
</p><li><a href="Filtering-Directories.html#Filtering%20Directories">Filtering Directories</a>:        Applying filters to the Directories-buffer
 
148
<li><a href="Filtering-Sources.html#Filtering%20Sources">Filtering Sources</a>:            Applying filters to the Sources--buffer
 
149
<li><a href="Filtering-History.html#Filtering%20History">Filtering History</a>:            Applying filters to the History-buffer
 
150
<li><a href="Filtering-Methods.html#Filtering%20Methods">Filtering Methods</a>:            Applying filters to the Methods-buffer
 
151
 
121
152
<p>Changing, customizing, redrawing and creating layouts
122
153
 
123
154
</p><li><a href="Changing-the-ECB-layout.html#Changing%20the%20ECB-layout">Changing the ECB-layout</a>:      How to change and customize the layout
153
184
<li><a href="ecb-download.html#ecb-download">ecb-download</a>:                 Customizing how to download ECB
154
185
<li><a href="ecb-help.html#ecb-help">ecb-help</a>:                     Customizing the online help of ECB
155
186
<li><a href="ecb-eshell.html#ecb-eshell">ecb-eshell</a>:                   Customizing the eshell-integration
 
187
<li><a href="ecb-speedbar.html#ecb-speedbar">ecb-speedbar</a>:                 Customizing the speedbar-integration
156
188
<li><a href="ecb-non-semantic.html#ecb-non-semantic">ecb-non-semantic</a>:             Customizing parsing non-semantic sources
157
189
<li><a href="ecb-winman.html#ecb-winman">ecb-winman</a>:                   Customizing window-manager support
158
190
<li><a href="ecb-mode-line.html#ecb-mode-line">ecb-mode-line</a>:                Customizing the tree-buffer-modelines
191
223
</p><li><a href="Style-basics.html#Style%20basics">Style basics</a>:                 Basic knowledge about the styles
192
224
<li><a href="Ascii-based-styles.html#Ascii-based%20styles">Ascii-based styles</a>:           How to customize the ascii-styles
193
225
<li><a href="Tree-buffers-with-images.html#Tree-buffers%20with%20images">Tree-buffers with images</a>:     Which images are used for the tree
 
226
<li><a href="Images-for-Methods-buffer.html#Images%20for%20Methods-buffer">Images for Methods-buffer</a>:    Images for the tags in the Methods-buffer
194
227
 
195
228
<p>Entry points for Elisp programmers
196
229