\input texinfo @c -*-texinfo-*-
@comment %**start of header
-@setfilename ../../info/ebrowse
+@setfilename ../../info/ebrowse.info
@settitle A Class Browser for C++
+@documentencoding UTF-8
@setchapternewpage odd
@syncodeindex fn cp
@comment %**end of header
@copying
This file documents Ebrowse, a C++ class browser for GNU Emacs.
-Copyright @copyright{} 2000--2013 Free Software Foundation, Inc.
+Copyright @copyright{} 2000--2015 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.3 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+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''.
@item
Types (@code{enum}s, and @code{typedef}s defined with class
-scope).@refill
+scope).
@end itemize
You can switch member buffers from one list to another, or to another
@findex --help
When invoked with option @samp{--help}, @command{ebrowse} prints a list of
-available command line options.@refill
+available command line options.
@menu
* Input files:: Specifying which files to parse
name.
@table @kbd
-@item SPC
+@item @key{SPC}
This command views the class declaration if the database
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
+location of their declarations and definitions will not be known.
-@item RET
+@item @key{RET}
Works like @kbd{SPC}, except that it finds the class
declaration rather than viewing it, so that it is ready for
-editing.@refill
+editing.
@end table
The same functionality is available from the menu opened with
@node Member Display
@section Displaying Members
-@cindex @samp{*Members*} buffer
+@cindex @file{*Members*} buffer
@cindex @samp{*Globals*}
@cindex freezing a member buffer
@cindex member lists, in tree buffers
If the branch of the class tree containing the class searched for is
currently collapsed, the class itself and all its base classes are
recursively made visible. (See also @ref{Expanding and
-Collapsing}.)@refill
+Collapsing}.)
This function is also available from the tree buffer's context menu.
You can expand and collapse parts of a tree to reduce the complexity of
large class hierarchies. Expanding or collapsing branches of a tree has
no impact on the functionality of other commands, like @kbd{/}. (See
-also @ref{Go to Class}.)@refill
+also @ref{Go to Class}.)
Collapsed branches are indicated with an ellipsis following the class
name like in the example below.
Classes can be marked for operations similar to the standard Emacs
commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see
-also @xref{Tags-like Functions}.)@refill
+also @xref{Tags-like Functions}.)
@table @kbd
@cindex toggle mark
@cindex declaration of a member, in member buffers
@table @kbd
-@item RET
+@item @key{RET}
This command finds the definition of the member the cursor is on.
Finding involves roughly the same as the standard Emacs tags facility
does---loading the file and searching for a regular expression matching
@item f
This command finds the declaration of the member the cursor is on.
-@item SPC
+@item @key{SPC}
This is the same command as @kbd{RET}, but views the member definition
instead of finding the member's source file.
Ebrowse's commands, the position from where you performed the
jump and the position where you jumped to are recorded in a
@dfn{position stack}. There are several ways in which you can quickly
-move to positions in the stack:@refill
+move to positions in the stack:
@table @kbd
@cindex return to original position