import insight-2000-02-04 snapshot (2nd try)
[external/binutils.git] / gprof / gprof.texi
index 4c22c9a..b4606b4 100644 (file)
@@ -16,7 +16,7 @@ END-INFO-DIR-ENTRY
 @ifinfo
 This file documents the gprof profiler of the GNU system.
 
-Copyright (C) 1988, 1992, 1997, 1998 Free Software Foundation, Inc.
+Copyright (C) 1988, 1992, 1997, 1998, 1999 Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -477,6 +477,12 @@ are annotated.  If this option is specified, every line in
 a basic-block is annotated by repeating the annotation for the
 first line.  This behavior is similar to @code{tcov}'s @samp{-a}.
 
+@item --demangle
+@itemx --no-demangle
+These options control whether C++ symbol names should be demangled when
+printing output.  The default is to demangle symbols.  The
+@code{--no-demangle} option may be used to turn off demangling.
+
 @end table
 
 @node Analysis Options,Miscellaneous Options,Output Options,Invoking
@@ -572,9 +578,9 @@ If @var{num} is not specified, enable all debugging.
 
 @item -O@var{name}
 @itemx --file-format=@var{name}
-Selects the format of the profile data files.
-Recognized formats are @samp{auto} (the default), @samp{bsd}, @samp{magic},
-and @samp{prof} (not yet supported).
+Selects the format of the profile data files.  Recognized formats are
+@samp{auto} (the default), @samp{bsd}, @samp{4.4bsd}, @samp{magic}, and
+@samp{prof} (not yet supported).
 
 @item -s
 @itemx --sum
@@ -663,34 +669,39 @@ following syntax:
 
 Here are some sample symspecs:
 
-@table @code
+@table @samp
 @item main.c
-Selects everything in file "main.c"---the
+Selects everything in file @file{main.c}---the
 dot in the string tells gprof to interpret
 the string as a filename, rather than as
 a function name.  To select a file whose
 name does not contain a dot, a trailing colon
-should be specified.  For example, "odd:" is
-interpreted as the file named "odd".
+should be specified.  For example, @samp{odd:} is
+interpreted as the file named @file{odd}.
 
 @item main
-Selects all functions named "main".  Notice
-that there may be multiple instances of the
-same function name because some of the
-definitions may be local (i.e., static).
-Unless a function name is unique in a program,
-you must use the colon notation explained
-below to specify a function from a specific
-source file.  Sometimes, function names contain
-dots.  In such cases, it is necessar to
-add a leading colon to the name.  For example,
-":.mul" selects function ".mul".
+Selects all functions named @samp{main}.
+
+Note that there may be multiple instances of the same function name
+because some of the definitions may be local (i.e., static).  Unless a
+function name is unique in a program, you must use the colon notation
+explained below to specify a function from a specific source file.
+
+Sometimes, function names contain dots.  In such cases, it is necessary
+to add a leading colon to the name.  For example, @samp{:.mul} selects
+function @samp{.mul}.
+
+In some object file formats, symbols have a leading underscore.  gprof
+will normally not print these underscores.  However, you must use the
+underscore when you name a symbol in a symspec.  You can use the
+@code{nm} program to see whether symbols have underscores for the object
+file format you are using.
 
 @item main.c:main
-Selects function "main" in file "main.c".
+Selects function @samp{main} in file @file{main.c}.
 
 @item main.c:134
-Selects line 134 in file "main.c".
+Selects line 134 in file @file{main.c}.
 @end table
 
 @node Output