@copying
This file documents Ebrowse, a C++ class browser for GNU Emacs.
-Copyright @copyright{} 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-2008, 2009 Free Software Foundation, Inc.
+Copyright @copyright{} 2000--2012 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
-@dircategory Emacs
+@dircategory Emacs misc features
@direntry
-* Ebrowse: (ebrowse). A C++ class browser for Emacs.
+* Ebrowse: (ebrowse). A C++ class browser for Emacs.
@end direntry
@titlepage
@insertcopying
@end titlepage
-@node Top, Overview, (dir), (dir)
+@contents
@ifnottex
+@node Top, Overview, (dir), (dir)
+@top Ebrowse
+
You can browse C++ class hierarchies from within Emacs by using
Ebrowse.
+
+@insertcopying
@end ifnottex
@menu
-* Overview:: What is it and how does it work?
-* Generating browser files:: How to process C++ source files
-* Loading a Tree:: How to start browsing
-* Tree Buffers:: Traversing class hierarchies
-* Member Buffers:: Looking at member information
-* Tags-like Functions:: Finding members from source files
+* Overview:: What is it and how does it work?
+* Generating browser files:: How to process C++ source files
+* Loading a Tree:: How to start browsing
+* Tree Buffers:: Traversing class hierarchies
+* Member Buffers:: Looking at member information
+* Tags-like Functions:: Finding members from source files
* GNU Free Documentation License:: The license for this documentation.
-* Concept Index:: An entry for each concept defined
+* Concept Index:: An entry for each concept defined
@end menu
with a keystroke. @xref{Member Buffers}.
These two buffer types and the commands they provide support the
-navigational use of the browser. The second form resembles Emacs' Tags
+navigational use of the browser. The second form resembles Emacs's Tags
package for C and other procedural languages. Ebrowse's commands of
this type are not confined to special buffers; they are most often used
while you are editing your source code.
available command line options.@refill
@menu
-* Input files:: Specifying which files to parse
-* Output file:: Changing the output file name
-* Structs and unions:: Omitting @code{struct}s and @code{union}s
-* Matching:: Setting regular expression lengths
+* Input files:: Specifying which files to parse
+* Output file:: Changing the output file name
+* Structs and unions:: Omitting @code{struct}s and @code{union}s
+* Matching:: Setting regular expression lengths
* Verbosity:: Getting feedback for lengthy operations
@end menu
Class trees are displayed in @dfn{tree buffers} which install their own
major mode. Most Emacs keys work in tree buffers in the usual way,
-e.g.@: you can move around in the buffer with the usual @kbd{C-f},
+e.g., you can move around in the buffer with the usual @kbd{C-f},
@kbd{C-v} etc., or you can search with @kbd{C-s}.
Tree-specific commands are bound to simple keystrokes, similar to
buffers.
@menu
-* Source Display:: Viewing and finding a class declaration
-* Member Display:: Showing members, switching to member buffers
-* Go to Class:: Finding a class
-* Quitting:: Discarding and burying the tree buffer
-* File Name Display:: Showing file names in the tree
-* Expanding and Collapsing:: Expanding and collapsing branches
-* Tree Indentation:: Changing the tree indentation
-* Killing Classes:: Removing class from the tree
-* Saving a Tree:: Saving a modified tree
-* Statistics:: Displaying class tree statistics
-* Marking Classes:: Marking and unmarking classes
+* Source Display:: Viewing and finding a class declaration
+* Member Display:: Showing members, switching to member buffers
+* Go to Class:: Finding a class
+* Quitting:: Discarding and burying the tree buffer
+* File Name Display:: Showing file names in the tree
+* Expanding and Collapsing:: Expanding and collapsing branches
+* Tree Indentation:: Changing the tree indentation
+* Killing Classes:: Removing class from the tree
+* Saving a Tree:: Saving a modified tree
+* Statistics:: Displaying class tree statistics
+* Marking Classes:: Marking and unmarking classes
@end menu
@table @kbd
@item SPC
This command views the class declaration if the database
-contains informations about it. If you don't parse the entire source
+contains information about it. If you don't parse the entire source
you are working on, some classes will only be known to exist but the
location of their declarations and definitions will not be known.@refill
Here is an example of a tree buffer with file names displayed.
@example
-| Collection (unknown)
-| IndexedCollection (indexedcltn.h)
-| Array (array.h)
-| FixedArray (fixedarray.h)
-| Set (set.h)
-| Dictionary (dict.h)
+| Collection (unknown)
+| IndexedCollection (indexedcltn.h)
+| Array (array.h)
+| FixedArray (fixedarray.h)
+| Set (set.h)
+| Dictionary (dict.h)
@end example
-
-
@node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers
@comment node-name, next, previous, up
@section Expanding and Collapsing a Tree
buffer: members, classes, and the buffer itself.
@menu
-* Switching Member Lists:: Choosing which members to display
-* Finding/Viewing:: Modifying source code
-* Inherited Members:: Display of Inherited Members
-* Searching Members:: Finding members in member buffer
-* Switching to Tree:: Going back to the tree buffer
-* Filters:: Selective member display
-* Attributes:: Display of @code{virtual} etc.
-* Long and Short Display:: Comprehensive and verbose display
-* Regexp Display:: Showing matching regular expressions
-* Switching Classes:: Displaying another class
-* Killing/Burying:: Getting rid of the member buffer
-* Column Width:: Display style
-* Redisplay:: Redrawing the member list
-* Getting Help:: How to get help for key bindings
+* Switching Member Lists:: Choosing which members to display
+* Finding/Viewing:: Modifying source code
+* Inherited Members:: Display of Inherited Members
+* Searching Members:: Finding members in member buffer
+* Switching to Tree:: Going back to the tree buffer
+* Filters:: Selective member display
+* Attributes:: Display of @code{virtual} etc.
+* Long and Short Display:: Comprehensive and verbose display
+* Regexp Display:: Showing matching regular expressions
+* Switching Classes:: Displaying another class
+* Killing/Burying:: Getting rid of the member buffer
+* Column Width:: Display style
+* Redisplay:: Redrawing the member list
+* Getting Help:: How to get help for key bindings
@end menu
to the one containing the member.
With a prefix argument (@kbd{C-u}), all members in the class tree,
-i.e.@: all members the browser knows about appear in the completion
+i.e., all members the browser knows about appear in the completion
list. The member display will be switched to the class and member list
containing the member.
@comment **************************************************************
-@comment *** TAGS LIKE FUNCTIONS
+@comment *** TAGS LIKE FUNCTIONS
@comment **************************************************************
@node Tags-like Functions, GNU Free Documentation License, Member Buffers, Top
Emacs Tags facility, but better suited to the needs of C++ programmers.
@menu
-* Finding and Viewing:: Going to a member declaration/definition
-* Position Stack:: Moving to previous locations
-* Search & Replace:: Searching and replacing over class tree files
-* Members in Files:: Listing all members in a given file
-* Apropos:: Listing members matching a regular expression
-* Symbol Completion:: Completing names while editing
+* Finding and Viewing:: Going to a member declaration/definition
+* Position Stack:: Moving to previous locations
+* Search & Replace:: Searching and replacing over class tree files
+* Members in Files:: Listing all members in a given file
+* Apropos:: Listing members matching a regular expression
+* Symbol Completion:: Completing names while editing
* Member Buffer Display:: Quickly display a member buffer for some
- identifier
+ identifier
@end menu
Directly after you performed a jump, this will put you back to the
position where you came from.
-The stack is not popped, i.e.@: you can always switch back and forth
+The stack is not popped, i.e., you can always switch back and forth
between positions in the stack. To avoid letting the stack grow to
infinite size there is a maximum number of positions defined. When this
number is reached, older positions are discarded when new positions are
remember only part of a member name, and not its beginning.
A special buffer is popped up containing all identifiers matching the
-regular expression, and what kind of symbol it is (e.g.@: a member
+regular expression, and what kind of symbol it is (e.g., a member
function, or a type). You can then switch to this buffer, and use the
command @kbd{C-c C-m f}, for example, to jump to a specific member.
@unnumbered Concept Index
@printindex cp
-@contents
@bye
-
-@ignore
- arch-tag: 52fe78ac-a1c4-48e7-815e-0a31acfad4bf
-@end ignore