aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Love2000-08-15 13:14:45 +0000
committerDave Love2000-08-15 13:14:45 +0000
commit9105187020025123f64e48f2f735babb329cd09a (patch)
tree54ed4395debf4f8abc0f12c6c9c206d8ce5e01ab
parent2394fd21183d9c7250f39b7dabd9dd938c67224d (diff)
downloademacs-9105187020025123f64e48f2f735babb329cd09a.tar.gz
emacs-9105187020025123f64e48f2f735babb329cd09a.zip
Minor English and formatting changes.
-rw-r--r--man/ebrowse.texi72
1 files changed, 36 insertions, 36 deletions
diff --git a/man/ebrowse.texi b/man/ebrowse.texi
index 8d0471c345d..187046ce603 100644
--- a/man/ebrowse.texi
+++ b/man/ebrowse.texi
@@ -94,9 +94,9 @@ software support for two things:
94@item 94@item
95When you get a new class library, or you have to work on source code you 95When you get a new class library, or you have to work on source code you
96haven't written yourself (or written sufficiently long ago), you need a 96haven't written yourself (or written sufficiently long ago), you need a
97tool letting you navigate through class hierarchies and investigate 97tool to let you navigate class hierarchies and investigate
98features of the software. Without such a tool you often end up grep'ing 98features of the software. Without such a tool you often end up
99through dozens or even hundreds of files. 99@command{grep}ing through dozens or even hundreds of files.
100 100
101@item 101@item
102Once you are productive, it would be nice to have a tool that knows your 102Once you are productive, it would be nice to have a tool that knows your
@@ -113,7 +113,7 @@ How does it work?
113@cindex parser for C++ sources 113@cindex parser for C++ sources
114A fast parser written in C is used to process C++ source files. 114A fast parser written in C is used to process C++ source files.
115The parser generates a data base containing information about classes, 115The parser generates a data base containing information about classes,
116members, global functions, defines, types etc. found in the sources. 116members, global functions, defines, types etc.@: found in the sources.
117 117
118The second part of Ebrowse is a Lisp program. This program reads 118The second part of Ebrowse is a Lisp program. This program reads
119the data base generated by the parser. It displays its contents in 119the data base generated by the parser. It displays its contents in
@@ -138,20 +138,20 @@ displayed as a member list of its own:
138 138
139@itemize @bullet 139@itemize @bullet
140@item 140@item
141Instance member variables, 141Instance member variables;
142 142
143@item 143@item
144Instance member functions, 144Instance member functions;
145 145
146@item 146@item
147Static member variables, 147Static member variables;
148 148
149@item 149@item
150Static member functions, 150Static member functions;
151 151
152@item 152@item
153Friends/Defines, The list of defines is contained in the friends 153Friends/Defines. The list of defines is contained in the friends
154list of the pseudo-class @samp{*Globals*}. 154list of the pseudo-class @samp{*Globals*};
155 155
156@item 156@item
157Types (@code{enum}s, and @code{typedef}s defined with class 157Types (@code{enum}s, and @code{typedef}s defined with class
@@ -269,7 +269,7 @@ of a command pipe.
269 269
270@findex --search-path 270@findex --search-path
271@item --search-path=@var{paths} 271@item --search-path=@var{paths}
272This option let's you specify search paths for your input files. 272This option lets you specify search paths for your input files.
273@var{paths} is a list of directory names, separated from each other by a 273@var{paths} is a list of directory names, separated from each other by a
274either a colon or a semicolon, depending on the operating system. 274either a colon or a semicolon, depending on the operating system.
275@end table 275@end table
@@ -328,7 +328,7 @@ append its output to an existing file with this command line option.
328This switch suppresses all classes in the data base declared as 328This switch suppresses all classes in the data base declared as
329@code{struct} or @code{union} in the output. 329@code{struct} or @code{union} in the output.
330 330
331This is mainly thought for the case that you are converting an existing 331This is mainly useful when you are converting an existing
332C program to C++, and do not want to see the old C structs in a class 332C program to C++, and do not want to see the old C structs in a class
333tree. 333tree.
334@end table 334@end table
@@ -343,7 +343,7 @@ tree.
343@cindex regular expressions, recording 343@cindex regular expressions, recording
344The parser @command{ebrowse} normally writes regular expressions to its 344The parser @command{ebrowse} normally writes regular expressions to its
345output file that help the Lisp part of Ebrowse to find functions, 345output file that help the Lisp part of Ebrowse to find functions,
346variables etc. in their source files. 346variables etc.@: in their source files.
347 347
348You can instruct @command{ebrowse} to omit these regular expressions by 348You can instruct @command{ebrowse} to omit these regular expressions by
349calling it with the command line switch @samp{--no-regexps}. 349calling it with the command line switch @samp{--no-regexps}.
@@ -357,7 +357,7 @@ coding styles are used.
357@table @samp 357@table @samp
358@findex --no-regexps 358@findex --no-regexps
359@item --no-regexps 359@item --no-regexps
360This option turns regular expression recording off. 360This option turns off regular expression recording.
361 361
362@findex --min-regexp-length 362@findex --min-regexp-length
363@cindex minimum regexp length for recording 363@cindex minimum regexp length for recording
@@ -367,7 +367,7 @@ the regular expressions recorded to match class and member declarations
367and definitions. The default value is set at compilation time of 367and definitions. The default value is set at compilation time of
368@command{ebrowse}. 368@command{ebrowse}.
369 369
370The smaller the minimum length the higher the probability that 370The smaller the minimum length, the higher the probability that
371Ebrowse will find a wrong match. The larger the value, the 371Ebrowse will find a wrong match. The larger the value, the
372larger the output file and therefore the memory consumption once the 372larger the output file and therefore the memory consumption once the
373file is read from Emacs. 373file is read from Emacs.
@@ -380,10 +380,10 @@ regular expressions used to match class and member declarations and
380definitions. The default value is set at compilation time of 380definitions. The default value is set at compilation time of
381@command{ebrowse}. 381@command{ebrowse}.
382 382
383The larger the maximum length the higher the probability that the 383The larger the maximum length, the higher the probability that the
384browser will find a correct match, but the larger the value the larger 384browser will find a correct match, but the larger the value the larger
385the output file and therefore the memory consumption once the data is 385the output file and therefore the memory consumption once the data is
386read. As a second effect, the larger the regular expression the higher 386read. As a second effect, the larger the regular expression, the higher
387the probability that it will no longer match after editing the file. 387the probability that it will no longer match after editing the file.
388@end table 388@end table
389 389
@@ -460,7 +460,7 @@ where no highlight is displayed.
460 460
461Class trees are displayed in @dfn{tree buffers} which install their own 461Class trees are displayed in @dfn{tree buffers} which install their own
462major mode. Most Emacs keys work in tree buffers in the usual way, 462major mode. Most Emacs keys work in tree buffers in the usual way,
463e.g., you can move around in the buffer with the usual @kbd{C-f}, 463e.g.@: you can move around in the buffer with the usual @kbd{C-f},
464@kbd{C-v} etc., or you can search with @kbd{C-s}. 464@kbd{C-v} etc., or you can search with @kbd{C-s}.
465 465
466Tree-specific commands are bound to simple keystrokes, similar to 466Tree-specific commands are bound to simple keystrokes, similar to
@@ -681,7 +681,7 @@ cursor is on.
681 681
682@item + 682@item +
683This command expands the branch of the tree starting at the class the 683This command expands the branch of the tree starting at the class the
684cursor is on. Both commands for collapsing and expanding branches are 684cursor is on. Both commands for collapsing and expanding branches are
685also available from the class' object menu. 685also available from the class' object menu.
686 686
687@item * 687@item *
@@ -700,7 +700,7 @@ This command expands all collapsed branches in the tree.
700@table @kbd 700@table @kbd
701@item T w 701@item T w
702This command reads a new indentation width from the minibuffer and 702This command reads a new indentation width from the minibuffer and
703redisplays the tree buffer with the new indentation. It is also 703redisplays the tree buffer with the new indentation It is also
704available from the tree buffer's context menu. 704available from the tree buffer's context menu.
705@end table 705@end table
706 706
@@ -733,8 +733,8 @@ deletion is actually performed.
733 733
734@table @kbd 734@table @kbd
735@item C-x C-s 735@item C-x C-s
736This command writes a class tree to the file it was read from. This is 736This command writes a class tree to the file from which it was read.
737useful after classes have been deleted from a tree. 737This is useful after classes have been deleted from a tree.
738 738
739@item C-x C-w 739@item C-x C-w
740Writes the tree to a file whose name is read from the minibuffer. 740Writes the tree to a file whose name is read from the minibuffer.
@@ -814,15 +814,15 @@ Ebrowse distinguishes six kinds of lists:
814 814
815@itemize @bullet 815@itemize @bullet
816@item 816@item
817Instance variables (normal member variables), 817Instance variables (normal member variables);
818@item 818@item
819Instance functions (normal member functions), 819Instance functions (normal member functions);
820@item 820@item
821Static variables, 821Static variables;
822@item 822@item
823Static member functions, 823Static member functions;
824@item 824@item
825Friend functions, 825Friend functions;
826@item 826@item
827Types (@code{enum}s and @code{typedef}s defined with class scope. 827Types (@code{enum}s and @code{typedef}s defined with class scope.
828Nested classes will be shown in the class tree like normal classes. 828Nested classes will be shown in the class tree like normal classes.
@@ -888,7 +888,7 @@ Switch to the list of static member variables.
888Switch to the list of friends or defines. 888Switch to the list of friends or defines.
889 889
890@item L t 890@item L t
891Switch to the list of types.x 891Switch to the list of types.
892@end table 892@end table
893 893
894Both commands cycle through the member list. 894Both commands cycle through the member list.
@@ -947,7 +947,7 @@ displayed when clicking @kbd{mouse-2} on a member name.
947@table @kbd 947@table @kbd
948@item D b 948@item D b
949This command toggles the display of inherited members in the member 949This command toggles the display of inherited members in the member
950buffer. This is also in the buffer's context menu. 950buffer. This is also in the buffer's context menu.
951@end table 951@end table
952 952
953 953
@@ -966,12 +966,12 @@ list.
966 966
967@item G m 967@item G m
968Like the above command, but all members for the current class appear in 968Like the above command, but all members for the current class appear in
969the completion list. If necessary, the current member list is switched 969the completion list. If necessary, the current member list is switched
970to the one containing the member. 970to the one containing the member.
971 971
972With a prefix argument (@kbd{C-u}), all members in the class tree, 972With a prefix argument (@kbd{C-u}), all members in the class tree,
973i.e., all members the browser knows about appear in the completion 973i.e.@: all members the browser knows about appear in the completion
974list. The member display will be switched to the class and member list 974list. The member display will be switched to the class and member list
975containing the member. 975containing the member.
976 976
977@item G n 977@item G n
@@ -1350,7 +1350,7 @@ This command sets point to the previous position in the position stack.
1350Directly after you performed a jump, this will put you back to the 1350Directly after you performed a jump, this will put you back to the
1351position where you came from. 1351position where you came from.
1352 1352
1353The stack is not popped, i.e., you can always switch back and forth 1353The stack is not popped, i.e.@: you can always switch back and forth
1354between positions in the stack. To avoid letting the stack grow to 1354between positions in the stack. To avoid letting the stack grow to
1355infinite size there is a maximum number of positions defined. When this 1355infinite size there is a maximum number of positions defined. When this
1356number is reached, older positions are discarded when new positions are 1356number is reached, older positions are discarded when new positions are
@@ -1362,7 +1362,7 @@ the next position stored in the position stack.
1362 1362
1363@item C-c b p 1363@item C-c b p
1364Displays an electric buffer showing all positions saved in the stack. 1364Displays an electric buffer showing all positions saved in the stack.
1365You can select a position by pressing @kbd{SPC} in a line. You can 1365You can select a position by pressing @kbd{SPC} in a line. You can
1366view a position with @kbd{v}. 1366view a position with @kbd{v}.
1367@end table 1367@end table
1368 1368
@@ -1397,7 +1397,7 @@ selected in the usual way with completion.
1397Perform a query replace over the set of files. 1397Perform a query replace over the set of files.
1398 1398
1399@item C-c b , 1399@item C-c b ,
1400All three operations above stop when finding a match. You can restart 1400All three operations above stop when finding a match. You can restart
1401the operation with this command. 1401the operation with this command.
1402 1402
1403@item C-c b n 1403@item C-c b n
@@ -1432,7 +1432,7 @@ given regular expression. This command can be very useful if you
1432remember only part of a member name, and not its beginning. 1432remember only part of a member name, and not its beginning.
1433 1433
1434A special buffer is popped up containing all identifiers matching the 1434A special buffer is popped up containing all identifiers matching the
1435regular expression, and what kind of symbol it is (e.g., a member 1435regular expression, and what kind of symbol it is (e.g.@: a member
1436function, or a type). You can then switch to this buffer, and use the 1436function, or a type). You can then switch to this buffer, and use the
1437command @kbd{C-c b f}, for example, to jump to a specific member. 1437command @kbd{C-c b f}, for example, to jump to a specific member.
1438 1438