annotate doc/man/ebrowse.1 @ 103774:5048b64c7cf0

* b2m.c (main): Ensure that each message ends in two newlines.
author Chong Yidong <cyd@stupidchicken.com>
date Wed, 08 Jul 2009 03:20:03 +0000
parents cb5d2387102c
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
1 .\" See section COPYING for copyright and redistribution information.
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
2 .TH EBROWSE 1
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
3 .SH NAME
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
4 ebrowse \- create a class hierarchy database
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
5 .SH SYNOPSIS
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
6 .B ebrowse
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
7 .RI [ options ]
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
8 .RI [ FILES .\|.\|.]
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
9 .SH "DESCRIPTION"
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
10 This manual page documents briefly the
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
11 .BR ebrowse
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
12 command. Full documentation is available in the GNU Info format.
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
13 .PP
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
14 .B ebrowse
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
15 is used to create the database used by the class browser in Emacs.
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
16 .PP
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
17 .SH OPTIONS
100419
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
18 The program follows the usual GNU command line syntax, with long
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
19 options starting with two dashes (`-').
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
20 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
21 .B \-a, \-\-append
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
22 append output to existing file
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
23 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
24 .B \-f, \-\-files=FILES
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
25 read input file names from
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
26 .I FILE
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
27 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
28 .B \-I, \-\-search-path=LIST
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
29 set search path for input files
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
30 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
31 .B \-m, \-\-min-regexp-length=N
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
32 set minimum regexp length to
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
33 .I N
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
34 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
35 .B \-M, \-\-max-regexp-length=N
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
36 set maximum regexp length to
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
37 .I N
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
38 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
39 .B \-n, \-\-no-nested-classes
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
40 exclude nested classes
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
41 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
42 .B \-o, \-\-output-file=FILE
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
43 set output file name to
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
44 .I FILE
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
45 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
46 .B \-p, \-\-position-info
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
47 print info about position in file
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
48 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
49 .B \-s, \-\-no-structs-or-unions
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
50 don't record structs or unions
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
51 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
52 .B \-v, \-\-verbose
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
53 be verbose
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
54 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
55 .B \-V, \-\-very-verbose
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
56 be very verbose
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
57 .TP
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
58 .B \-x, \-\-no-regexps
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
59 don't record regular expressions
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
60 .TP
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
61 .B \-\-help
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
62 display this help
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
63 .TP
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
64 .B \-\-version
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
65 display version info
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
66 .SH "SEE ALSO"
100419
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
67 .BR emacs (1),
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
68 .BR etags (1),
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
69 and the full documentation for
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
70 .B ebrowse
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
71 which is maintained as a Texinfo manual. If the
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
72 .B info
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
73 and
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
74 .B ebrowse
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
75 programs are properly installed at your site, the command
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
76 .IP
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
77 .B info ebrowse
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
78 .PP
4f64aa90b939 Fix typos. Add more to the "SEE ALSO" section.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100389
diff changeset
79 should give you access to the complete manual.
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
80 .SH AUTHOR
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
81 .I Ebrowse
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
82 was written by Gerd Moellmann.
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
83 .
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
84 .SH COPYING
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
85 Copyright
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
86 .if t \(co
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
87 .if n (C)
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100419
diff changeset
88 2008, 2009 Free Software Foundation, Inc.
100389
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
89 .PP
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
90 Permission is granted to make and distribute verbatim copies of this
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
91 document provided the copyright notice and this permission notice are
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
92 preserved on all copies.
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
93 .PP
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
94 Permission is granted to copy and distribute modified versions of
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
95 this document under the conditions for verbatim copying, provided that
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
96 the entire resulting derived work is distributed under the terms of
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
97 a permission notice identical to this one.
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
98 .PP
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
99 Permission is granted to copy and distribute translations of this
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
100 document into another language, under the above conditions for
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
101 modified versions, except that this permission notice may be stated
74d035a0c201 Fix "emacsclient" typo. Replace problematic character.
Glenn Morris <rgm@gnu.org>
parents: 100372
diff changeset
102 in a translation approved by the Free Software Foundation.
100313
1912976b0dec * Makefile.in (install-arch-indep): Install ebrowse.1.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
diff changeset
103 .
100372
a2a672d854a1 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 100313
diff changeset
104 .\" arch-tag: b771158b-90cb-43a5-b9af-dbc506311817