Import binutils-2.20
[dragonfly.git] / contrib / binutils-2.20 / binutils / doc / size.1
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "SIZE 1"
135 .TH SIZE 1 "2009-10-16" "binutils-2.20" "GNU Development Tools"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 size \- list section sizes and total size.
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 size [\fB\-A\fR|\fB\-B\fR|\fB\-\-format=\fR\fIcompatibility\fR]
145      [\fB\-\-help\fR]
146      [\fB\-d\fR|\fB\-o\fR|\fB\-x\fR|\fB\-\-radix=\fR\fInumber\fR]
147      [\fB\-\-common\fR]
148      [\fB\-t\fR|\fB\-\-totals\fR]
149      [\fB\-\-target=\fR\fIbfdname\fR] [\fB\-V\fR|\fB\-\-version\fR]
150      [\fIobjfile\fR...]
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 The \s-1GNU\s0 \fBsize\fR utility lists the section sizes\-\-\-and the total
154 size\-\-\-for each of the object or archive files \fIobjfile\fR in its
155 argument list.  By default, one line of output is generated for each
156 object file or each module in an archive.
157 .PP
158 \&\fIobjfile\fR... are the object files to be examined.
159 If none are specified, the file \f(CW\*(C`a.out\*(C'\fR will be used.
160 .SH "OPTIONS"
161 .IX Header "OPTIONS"
162 The command line options have the following meanings:
163 .IP "\fB\-A\fR" 4
164 .IX Item "-A"
165 .PD 0
166 .IP "\fB\-B\fR" 4
167 .IX Item "-B"
168 .IP "\fB\-\-format=\fR\fIcompatibility\fR" 4
169 .IX Item "--format=compatibility"
170 .PD
171 Using one of these options, you can choose whether the output from \s-1GNU\s0
172 \&\fBsize\fR resembles output from System V \fBsize\fR (using \fB\-A\fR,
173 or \fB\-\-format=sysv\fR), or Berkeley \fBsize\fR (using \fB\-B\fR, or
174 \&\fB\-\-format=berkeley\fR).  The default is the one-line format similar to
175 Berkeley's.
176 .Sp
177 Here is an example of the Berkeley (default) format of output from
178 \&\fBsize\fR:
179 .Sp
180 .Vb 4
181 \&        $ size \-\-format=Berkeley ranlib size
182 \&        text    data    bss     dec     hex     filename
183 \&        294880  81920   11592   388392  5ed28   ranlib
184 \&        294880  81920   11888   388688  5ee50   size
185 .Ve
186 .Sp
187 This is the same data, but displayed closer to System V conventions:
188 .Sp
189 .Vb 7
190 \&        $ size \-\-format=SysV ranlib size
191 \&        ranlib  :
192 \&        section         size         addr
193 \&        .text         294880         8192
194 \&        .data          81920       303104
195 \&        .bss           11592       385024
196 \&        Total         388392
197 \&        
198 \&        
199 \&        size  :
200 \&        section         size         addr
201 \&        .text         294880         8192
202 \&        .data          81920       303104
203 \&        .bss           11888       385024
204 \&        Total         388688
205 .Ve
206 .IP "\fB\-\-help\fR" 4
207 .IX Item "--help"
208 Show a summary of acceptable arguments and options.
209 .IP "\fB\-d\fR" 4
210 .IX Item "-d"
211 .PD 0
212 .IP "\fB\-o\fR" 4
213 .IX Item "-o"
214 .IP "\fB\-x\fR" 4
215 .IX Item "-x"
216 .IP "\fB\-\-radix=\fR\fInumber\fR" 4
217 .IX Item "--radix=number"
218 .PD
219 Using one of these options, you can control whether the size of each
220 section is given in decimal (\fB\-d\fR, or \fB\-\-radix=10\fR); octal
221 (\fB\-o\fR, or \fB\-\-radix=8\fR); or hexadecimal (\fB\-x\fR, or
222 \&\fB\-\-radix=16\fR).  In \fB\-\-radix=\fR\fInumber\fR, only the three
223 values (8, 10, 16) are supported.  The total size is always given in two
224 radices; decimal and hexadecimal for \fB\-d\fR or \fB\-x\fR output, or
225 octal and hexadecimal if you're using \fB\-o\fR.
226 .IP "\fB\-\-common\fR" 4
227 .IX Item "--common"
228 Print total size of common symbols in each file.  When using Berkeley
229 format these are included in the bss size.
230 .IP "\fB\-t\fR" 4
231 .IX Item "-t"
232 .PD 0
233 .IP "\fB\-\-totals\fR" 4
234 .IX Item "--totals"
235 .PD
236 Show totals of all objects listed (Berkeley format listing mode only).
237 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
238 .IX Item "--target=bfdname"
239 Specify that the object-code format for \fIobjfile\fR is
240 \&\fIbfdname\fR.  This option may not be necessary; \fBsize\fR can
241 automatically recognize many formats.
242 .IP "\fB\-V\fR" 4
243 .IX Item "-V"
244 .PD 0
245 .IP "\fB\-\-version\fR" 4
246 .IX Item "--version"
247 .PD
248 Display the version number of \fBsize\fR.
249 .IP "\fB@\fR\fIfile\fR" 4
250 .IX Item "@file"
251 Read command-line options from \fIfile\fR.  The options read are
252 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
253 does not exist, or cannot be read, then the option will be treated
254 literally, and not removed.
255 .Sp
256 Options in \fIfile\fR are separated by whitespace.  A whitespace
257 character may be included in an option by surrounding the entire
258 option in either single or double quotes.  Any character (including a
259 backslash) may be included by prefixing the character to be included
260 with a backslash.  The \fIfile\fR may itself contain additional
261 @\fIfile\fR options; any such options will be processed recursively.
262 .SH "SEE ALSO"
263 .IX Header "SEE ALSO"
264 \&\fIar\fR\|(1), \fIobjdump\fR\|(1), \fIreadelf\fR\|(1), and the Info entries for \fIbinutils\fR.
265 .SH "COPYRIGHT"
266 .IX Header "COPYRIGHT"
267 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
268 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
269 .PP
270 Permission is granted to copy, distribute and/or modify this document
271 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
272 or any later version published by the Free Software Foundation;
273 with no Invariant Sections, with no Front-Cover Texts, and with no
274 Back-Cover Texts.  A copy of the license is included in the
275 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".