* etc/CONTRIBUTE: Copyedits.
[emacs.git] / doc / man / ebrowse.1
blob89506db98ef6e70b84fef24c85d6e22b412a88f3
1 .\" See section COPYING for copyright and redistribution information.
2 .TH EBROWSE 1
3 .SH NAME
4 ebrowse \- create a class hierarchy database
5 .SH SYNOPSIS
6 .B ebrowse
7 .RI [ options ]
8 .RI [ FILES .\|.\|.]
9 .SH "DESCRIPTION"
10 This manual page documents briefly the
11 .BR ebrowse
12 command.  Full documentation is available in the GNU Info format.
13 .PP
14 .B ebrowse
15 is used to create the database used by the class browser in Emacs.
16 .PP
17 .SH OPTIONS
18 The program follows the usual GNU command line syntax, with long
19 options starting with two dashes (`-').
20 .TP
21 .B \-a, \-\-append
22 append output to existing file
23 .TP
24 .B \-f, \-\-files=FILES
25 read input file names from
26 .I FILE
27 .TP
28 .B \-I, \-\-search-path=LIST
29 set search path for input files
30 .TP
31 .B \-m, \-\-min-regexp-length=N
32 set minimum regexp length to
33 .I N
34 .TP
35 .B \-M, \-\-max-regexp-length=N
36 set maximum regexp length to
37 .I N
38 .TP
39 .B \-n, \-\-no-nested-classes
40 exclude nested classes
41 .TP
42 .B \-o, \-\-output-file=FILE
43 set output file name to
44 .I FILE
45 .TP
46 .B \-p, \-\-position-info
47 print info about position in file
48 .TP
49 .B \-s, \-\-no-structs-or-unions
50 don't record structs or unions
51 .TP
52 .B \-v, \-\-verbose
53 be verbose
54 .TP
55 .B \-V, \-\-very-verbose
56 be very verbose
57 .TP
58 .B \-x, \-\-no-regexps
59 don't record regular expressions
60 .TP
61 .B \-\-help
62 display this help
63 .TP
64 .B \-\-version
65 display version info
66 .SH "SEE ALSO"
67 .BR emacs (1),
68 .BR etags (1),
69 and the full documentation for
70 .B ebrowse
71 which is maintained as a Texinfo manual.  If the
72 .B info
73 and
74 .B ebrowse
75 programs are properly installed at your site, the command
76 .IP
77 .B info ebrowse
78 .PP
79 should give you access to the complete manual.
80 .SH AUTHOR
81 .I Ebrowse
82 was written by Gerd Moellmann.
84 .SH COPYING
85 Copyright
86 .if t \(co
87 .if n (C)
88 2008-2013 Free Software Foundation, Inc.
89 .PP
90 Permission is granted to make and distribute verbatim copies of this
91 document provided the copyright notice and this permission notice are
92 preserved on all copies.
93 .PP
94 Permission is granted to copy and distribute modified versions of
95 this document under the conditions for verbatim copying, provided that
96 the entire resulting derived work is distributed under the terms of
97 a permission notice identical to this one.
98 .PP
99 Permission is granted to copy and distribute translations of this
100 document into another language, under the above conditions for
101 modified versions, except that this permission notice may be stated
102 in a translation approved by the Free Software Foundation.