]> oss.titaniummirror.com Git - msp430-binutils.git/blobdiff - gprof/gprof.1
Imported binutils-2.20
[msp430-binutils.git] / gprof / gprof.1
index 8c634b8014c7eb609c85dbf05f61a934269dfc9c..536c6a22ea9df407ce62e3c24404fadf8b4351cd 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "GPROF 1"
-.TH GPROF 1 "2007-08-06" "binutils-2.17.90" "GNU"
+.TH GPROF 1 "2009-10-16" "binutils-2.20" "GNU"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 gprof \- display call graph profile data
 .SH "SYNOPSIS"
@@ -148,7 +156,8 @@ gprof [ \-[abcDhilLrsTvwxyz] ] [ \-[ACeEfFJnNOpPqQZ][\fIname\fR] ]
  [ \-\-static\-call\-graph ] [ \-\-sum ] [ \-\-table\-length=\fIlen\fR ]
  [ \-\-traditional ] [ \-\-version ] [ \-\-width=\fIn\fR ]
  [ \-\-ignore\-non\-functions ] [ \-\-demangle[=\fI\s-1STYLE\s0\fR] ]
- [ \-\-no\-demangle ] [ \fIimage-file\fR ] [ \fIprofile-file\fR ... ]
+ [ \-\-no\-demangle ] [\-\-external\-symbol\-table=name] 
+ [ \fIimage-file\fR ] [ \fIprofile-file\fR ... ]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 \&\f(CW\*(C`gprof\*(C'\fR produces an execution profile of C, Pascal, or Fortran77 
@@ -179,11 +188,11 @@ The \fIcall graph\fR shows, for each function, which functions called it, which
 other functions it called, and how many times.  There is also an estimate
 of how much time was spent in the subroutines of each function.  This can
 suggest places where you might try to eliminate function calls that use a
-lot of time.  
+lot of time.
 .PP
 The \fIannotated source\fR listing is a copy of the program's
 source code, labeled with the number of times each line of the
-program was executed.  
+program was executed.
 .SH "OPTIONS"
 .IX Header "OPTIONS"
 These options specify which of several output formats
@@ -192,7 +201,7 @@ These options specify which of several output formats
 Many of these options take an optional \fIsymspec\fR to specify
 functions to be included or excluded.  These options can be
 specified multiple times, with different symspecs, to include
-or exclude sets of symbols.  
+or exclude sets of symbols.
 .PP
 Specifying any of these options overrides the default (\fB\-p \-q\fR),
 which prints a flat profile and call graph analysis
@@ -349,7 +358,7 @@ default is 10.
 .PD
 This option affects annotated source output only.
 Normally, \f(CW\*(C`gprof\*(C'\fR prints annotated source files
-to standard\-output.  If this option is specified,
+to standard-output.  If this option is specified,
 annotated source for a file named \fIpath/\fIfilename\fI\fR
 is generated in the file \fI\fIfilename\fI\-ann\fR.  If the underlying
 file system would truncate \fI\fIfilename\fI\-ann\fR so that it
@@ -571,6 +580,18 @@ to only propagate times for symbols matching \fIsymspec\fR.
 .PD
 The \fB\-n\fR option causes \f(CW\*(C`gprof\*(C'\fR, in its call graph analysis,
 not to propagate times for symbols matching \fIsymspec\fR.
+.ie n .IP """\-S\f(CIfilename\f(CW""" 4
+.el .IP "\f(CW\-S\f(CIfilename\f(CW\fR" 4
+.IX Item "-Sfilename"
+.PD 0
+.ie n .IP """\-\-external\-symbol\-table=\f(CIfilename\f(CW""" 4
+.el .IP "\f(CW\-\-external\-symbol\-table=\f(CIfilename\f(CW\fR" 4
+.IX Item "--external-symbol-table=filename"
+.PD
+The \fB\-S\fR option causes \f(CW\*(C`gprof\*(C'\fR to read an external symbol table
+file, such as \fI/proc/kallsyms\fR, rather than read the symbol table 
+from the given object file (the default is \f(CW\*(C`a.out\*(C'\fR). This is useful 
+for profiling kernel modules.
 .ie n .IP """\-z""" 4
 .el .IP "\f(CW\-z\fR" 4
 .IX Item "-z"
@@ -646,42 +667,42 @@ number, and then exit.
 .IX Subsection "Deprecated Options"
 .RS 4
 These options have been replaced with newer versions that use symspecs.
-.RE
-.ie n .IP """\-e \f(CIfunction_name\f(CW""" 4
-.el .IP "\f(CW\-e \f(CIfunction_name\f(CW\fR" 4
-.IX Item "-e function_name"
+.Sp
+\&\f(CW\*(C`\-e \f(CIfunction_name\f(CW\*(C'\fR
+.Sp
 The \fB\-e\fR \fIfunction\fR option tells \f(CW\*(C`gprof\*(C'\fR to not print
 information about the function \fIfunction_name\fR (and its
 children...) in the call graph.  The function will still be listed
 as a child of any functions that call it, but its index number will be
 shown as \fB[not printed]\fR.  More than one \fB\-e\fR option may be
 given; only one \fIfunction_name\fR may be indicated with each \fB\-e\fR
-option. 
-.ie n .IP """\-E \f(CIfunction_name\f(CW""" 4
-.el .IP "\f(CW\-E \f(CIfunction_name\f(CW\fR" 4
-.IX Item "-E function_name"
+option.
+.Sp
+\&\f(CW\*(C`\-E \f(CIfunction_name\f(CW\*(C'\fR
+.Sp
 The \f(CW\*(C`\-E \f(CIfunction\f(CW\*(C'\fR option works like the \f(CW\*(C`\-e\*(C'\fR option, but
 time spent in the function (and children who were not called from
 anywhere else), will not be used to compute the percentages-of-time for
 the call graph.  More than one \fB\-E\fR option may be given; only one
 \&\fIfunction_name\fR may be indicated with each \fB\-E\fR option.
-.ie n .IP """\-f \f(CIfunction_name\f(CW""" 4
-.el .IP "\f(CW\-f \f(CIfunction_name\f(CW\fR" 4
-.IX Item "-f function_name"
+.Sp
+\&\f(CW\*(C`\-f \f(CIfunction_name\f(CW\*(C'\fR
+.Sp
 The \fB\-f\fR \fIfunction\fR option causes \f(CW\*(C`gprof\*(C'\fR to limit the
 call graph to the function \fIfunction_name\fR and its children (and
 their children...).  More than one \fB\-f\fR option may be given;
 only one \fIfunction_name\fR may be indicated with each \fB\-f\fR
-option.  
-.ie n .IP """\-F \f(CIfunction_name\f(CW""" 4
-.el .IP "\f(CW\-F \f(CIfunction_name\f(CW\fR" 4
-.IX Item "-F function_name"
+option.
+.Sp
+\&\f(CW\*(C`\-F \f(CIfunction_name\f(CW\*(C'\fR
+.Sp
 The \fB\-F\fR \fIfunction\fR option works like the \f(CW\*(C`\-f\*(C'\fR option, but
 only time spent in the function and its children (and their
 children...) will be used to determine total-time and
 percentages-of-time for the call graph.  More than one \fB\-F\fR option
 may be given; only one \fIfunction_name\fR may be indicated with each
 \&\fB\-F\fR option.  The \fB\-F\fR option overrides the \fB\-E\fR option.
+.RE
 .SH "FILES"
 .IX Header "FILES"
 .ie n .IP """\f(CIa.out\f(CW""" 4
@@ -695,7 +716,7 @@ dynamic call graph and profile.
 .ie n .IP """\f(CIgmon.sum\f(CW""" 4
 .el .IP "\f(CW\f(CIgmon.sum\f(CW\fR" 4
 .IX Item "gmon.sum"
-summarized dynamic call graph and profile.  
+summarized dynamic call graph and profile.
 .SH "BUGS"
 .IX Header "BUGS"
 The granularity of the sampling is shown, but remains
@@ -735,11 +756,17 @@ Proceedings of the \s-1SIGPLAN\s0 '82 Symposium on Compiler Construction,
 \&\s-1SIGPLAN\s0 Notices, Vol. 17, No  6, pp. 120\-126, June 1982.
 .SH "COPYRIGHT"
 .IX Header "COPYRIGHT"
-Copyright (c) 1988, 92, 97, 98, 99, 2000, 2001, 2003, 2007 Free Software Foundation, Inc.
+Copyright (c) 1988, 92, 97, 98, 99, 2000, 2001, 2003, 2007, 2008, 2009 Free Software Foundation, Inc.
 .PP
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
+under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
 or any later version published by the Free Software Foundation;
 with no Invariant Sections, with no Front-Cover Texts, and with no
 Back-Cover Texts.  A copy of the license is included in the
 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".
+.SH "POD ERRORS"
+.IX Header "POD ERRORS"
+Hey! \fBThe above document had some coding errors, which are explained below:\fR
+.IP "Around line 539:" 4
+.IX Item "Around line 539:"
+You can't have =items (as at line 545) unless the first thing after the =over is an =item