@syncodeindex fn cp
@comment %**end of header
-@ifinfo
-@dircategory Emacs
-@direntry
-* Ebrowse: (ebrowse). A C++ class browser for Emacs.
-@end direntry
-
+@copying
This file documents Ebrowse, a C++ class browser for GNU Emacs.
-Copyright @copyright{} 2000 Free Software Foundation, Inc.
+Copyright @copyright{} 2000, 2002, 2003, 2004,
+ 2005 Free Software Foundation, Inc.
+@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the
license is included in the section entitled ``GNU Free Documentation
License'' in the Emacs manual.
Documentation License. If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license.
-@end ifinfo
+@end quotation
+@end copying
+
+@dircategory Emacs
+@direntry
+* Ebrowse: (ebrowse). A C++ class browser for Emacs.
+@end direntry
-@iftex
@titlepage
@title Ebrowse User's Manual
@sp 4
@sp 5
@author Gerd Moellmann
@page
-
@vskip 0pt plus 1filll
-@noindent
-Copyright @copyright{} 2000 Free Software Foundation, Inc.
-
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software. Copies published by the Free
-Software Foundation raise funds for GNU development.''
-
-This document is part of a collection distributed under the GNU Free
-Documentation License. If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
+@insertcopying
@end titlepage
-@page
-@end iftex
@node Top, Overview, (dir), (dir)
The design of Ebrowse reflects these two needs.
-How does it work?
+How does it work?
@cindex parser for C++ sources
A fast parser written in C is used to process C++ source files.
(add-to-list 'auto-mode-alist '(@var{NAME} . ebrowse-tree-mode))
@end lisp
-@noindent
+@noindent
where @var{NAME} is the Lisp data base name you are using.
@findex --append
@item --append
By default, each run of @command{ebrowse} erases the old contents of the
output file when writing to it. You can instruct @command{ebrowse} to
-append its output to an existing file with this command line option.
+append its output to an existing file produced by @command{ebrowse}
+with this command line option.
@end table
@cindex mouse highlight in tree buffers
When you run Emacs on a display which supports colors and the mouse, you
-will notice that that certain areas in the tree buffer are highlighted
+will notice that certain areas in the tree buffer are highlighted
when you move the mouse over them. This highlight marks mouse-sensitive
regions in the buffer. Please notice the help strings in the echo area
when the mouse moves over a sensitive region.
@cindex context menu
-A click with @kbd{mouse-3} on a mouse-sensitive region opens a context
+A click with @kbd{Mouse-3} on a mouse-sensitive region opens a context
menu. In addition to this, each buffer also has a buffer-specific menu
-that is opened with a click with @kbd{mouse-3} somewhere in the buffer
+that is opened with a click with @kbd{Mouse-3} somewhere in the buffer
where no highlight is displayed.
@end table
The same functionality is available from the menu opened with
-@kbd{mouse-3} on the class name.
+@kbd{Mouse-3} on the class name.
@end table
These lists are also available from the class' context menu invoked with
-@kbd{mouse-3} on the class name.
+@kbd{Mouse-3} on the class name.
@item s
Display file names for the current line, or for the number of lines
-given by a prefix argument.
+given by a prefix argument.
@end table
Here is an example of a tree buffer with file names displayed.
@table @kbd
@item -
This command collapses the branch of the tree starting at the class the
-cursor is on.
+cursor is on.
@item +
This command expands the branch of the tree starting at the class the
@item M t
Toggle the mark of the line point is in or for as many lines as given by
a prefix command. This command can also be found in the class' context
-menu.
+menu.
@cindex unmark all
@item M a
@item L f
Switch to the list of member functions.
-@cindex static
+@cindex static
@item L F
Switch to the list of static member functions.
Both commands cycle through the member list.
-Most of the commands are also available from the member buffer's
+Most of the commands are also available from the member buffer's
context menu.
class declaration or definition has been found, or when it is not found.
All the commands described above can also be found in the context menu
-displayed when clicking @kbd{mouse-2} on a member name.
+displayed when clicking @kbd{Mouse-2} on a member name.
@table @kbd
@cindex @code{public} members
-@item F a u
+@item F a u
This command toggles the display of @code{public} members. The
@samp{a} stands for `access'.
@item D a
Toggle the display of member attributes (default is on).
-The nine member attributes Ebrowse knows about are are displayed
+The nine member attributes Ebrowse knows about are displayed
as a list a single-characters flags enclosed in angle brackets in front
the of the member's name. A @samp{-} at a given position means that
the attribute is false. The list of attributes from left to right is
This command forces a redisplay of the member buffer. If the width
of the window displaying the member buffer is changed this command
redraws the member list with the appropriate column widths and number of
-columns.
+columns.
@end table
the next position stored in the position stack.
@item C-c b p
-Displays an electric buffer showing all positions saved in the stack.
+Displays an electric buffer showing all positions saved in the stack.
You can select a position by pressing @kbd{SPC} in a line. You can
view a position with @kbd{v}.
@end table
the operation with this command.
@item C-c b n
-This restarts the last tags operation with the next file in the list.
+This restarts the last tags operation with the next file in the list.
@end table
@node Apropos, Symbol Completion, Members in Files, Tags-like Functions
@comment node-name, next, previous, up
-@section Member Apropos
+@section Member Apropos
@cindex apropos on class members
@cindex members, matching regexp
@contents
@bye
+
+@ignore
+ arch-tag: 52fe78ac-a1c4-48e7-815e-0a31acfad4bf
+@end ignore
HCoop / bpt / emacs.git / blobdiff