rename.2: SEE ALSO: add rename(1)

[thirdparty/man-pages.git] / man1 / sprof.1

diff --git a/man1/sprof.1 b/man1/sprof.1
index c813ea5a897e1257dbb944a292760c3b0af2953d..a5788c247f553f3373c721aec414ca0b2fc2e557 100644 (file)
--- a/man1/sprof.1
+++ b/man1/sprof.1
@@ -22,7 +22,7 @@
 .\" the source, must acknowledge the copyright and authors of this work.
 .\" %%%LICENSE_END
 .\"
-.TH SPROF 1 2014-06-24 "Linux" "Linux User Manual"
+.TH SPROF 1 2019-03-06 "Linux" "Linux User Manual"
 .SH NAME
 sprof \- read and display shared object profiling data
 .SH SYNOPSIS
@@ -41,7 +41,7 @@ If the profiling data pathname is omitted, then
 .B sprof
 will attempt to deduce it using the soname of the shared object,
 looking for a file with the name
-.IR <soname>.profile
+.I <soname>.profile
 in the current directory.
 .SH OPTIONS
 The following command-line options specify the profile output
@@ -67,7 +67,7 @@ The following additional command-line options are available:
 .BR \-? ", " \-\-help
 Display a summary of command-line options and arguments and exit.
 .TP
-.BR \-\-usage
+.B \-\-usage
 Display a short usage message and exit.
 .TP
 .BR \-V ", " \-\-version
@@ -82,9 +82,9 @@ The following example demonstrates the use of
 The example consists of a main program that calls two functions
 in a shared object.
 First, the code of the main program:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBcat prog.c\fP
 #include <stdlib.h>
 
@@ -98,18 +98,18 @@ main(int argc, char *argv[])
     x2();
     exit(EXIT_SUCCESS);
 }
-.fi
+.EE
 .in
 .PP
 The functions
-.IR x1()
+.IR x1 ()
 and
-.IR x2()
+.IR x2 ()
 are defined in the following source file that is used to
 construct the shared object:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBcat libdemo.c\fP
 #include <unistd.h>
 
@@ -147,66 +147,66 @@ x2(void)
     for (j = 0; j < 1000; j++)
        consumeCpu2(10000);
 }
-.fi
+.EE
 .in
 .PP
 Now we construct the shared object with the real name
 .IR libdemo.so.1.0.1 ,
 and the soname
 .IR libdemo.so.1 :
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBcc \-g \-fPIC \-shared \-Wl,\-soname,libdemo.so.1 \e\fP
         \fB\-o libdemo.so.1.0.1 libdemo.c\fP
-.fi
+.EE
 .in
 .PP
 Then we construct symbolic links for the library soname and
 the library linker name:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBln \-sf libdemo.so.1.0.1 libdemo.so.1\fP
 $ \fBln \-sf libdemo.so.1 libdemo.so\fP
-.fi
+.EE
 .in
 .PP
 Next, we compile the main program, linking it against the shared object,
 and then list the dynamic dependencies of the program:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBcc \-g \-o prog prog.c \-L. \-ldemo\fP
 $ \fBldd prog\fP
        linux\-vdso.so.1 =>  (0x00007fff86d66000)
        libdemo.so.1 => not found
        libc.so.6 => /lib64/libc.so.6 (0x00007fd4dc138000)
        /lib64/ld\-linux\-x86\-64.so.2 (0x00007fd4dc51f000)
-.fi
+.EE
 .in
 .PP
 In order to get profiling information for the shared object,
 we define the environment variable
-.BR LD_PROFILE
+.B LD_PROFILE
 with the soname of the library:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBexport LD_PROFILE=libdemo.so.1\fP
-.fi
+.EE
 .in
 .PP
 We then define the environment variable
-.BR LD_PROFILE_OUTPUT
+.B LD_PROFILE_OUTPUT
 with the pathname of the directory where profile output should be written,
 and create that directory if it does not exist already:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBexport LD_PROFILE_OUTPUT=$(pwd)/prof_data\fP
 $ \fBmkdir \-p $LD_PROFILE_OUTPUT\fP
-.fi
+.EE
 .in
 .PP
 .B LD_PROFILE
@@ -214,31 +214,31 @@ causes profiling output to be
 .I appended
 to the output file if it already exists,
 so we ensure that there is no preexisting profiling data:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBrm \-f $LD_PROFILE_OUTPUT/$LD_PROFILE.profile\fP
-.fi
+.EE
 .in
 .PP
 We then run the program to produce the profiling output,
 which is written to a file in the directory specified in
 .BR LD_PROFILE_OUTPUT :
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBLD_LIBRARY_PATH=. ./prog\fP
 $ \fBls prof_data\fP
 libdemo.so.1.profile
-.fi
+.EE
 .in
 .PP
 We then use the
-.BR "sprof \-p"
+.B sprof \-p
 option to generate a flat profile with counts and ticks:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBsprof \-p libdemo.so.1 $LD_PROFILE_OUTPUT/libdemo.so.1.profile\fP
 Flat profile:
 
@@ -249,15 +249,15 @@ Each sample counts as 0.01 seconds.
  40.00      0.10     0.04     1000    40.00           consumeCpu2
   0.00      0.10     0.00        1     0.00           x1
   0.00      0.10     0.00        1     0.00           x2
-.fi
+.EE
 .in
 .PP
 The
-.BR "sprof \-q"
+.B sprof \-q
 option generates a call graph:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBsprof \-q libdemo.so.1 $LD_PROFILE_OUTPUT/libdemo.so.1.profile\fP
 
 index % time    self  children    called     name
@@ -276,7 +276,7 @@ index % time    self  children    called     name
 [3]      0.0    0.00    0.00        1         x2 [3]
                 0.00    0.00     1000/1000        consumeCpu2 [2]
 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-.fi
+.EE
 .in
 .PP
 Above and below, the "<UNKNOWN>" strings represent identifiers that
@@ -284,17 +284,17 @@ are outside of the profiled object (in this example, these are instances of
 .IR main() ).
 .PP
 The
-.BR "sprof \-c"
+.B sprof \-c
 option generates a list of call pairs and the number of their occurrences:
-
+.PP
 .in +4n
-.nf
+.EX
 $ \fBsprof \-c libdemo.so.1 $LD_PROFILE_OUTPUT/libdemo.so.1.profile\fP
 <UNKNOWN>                  x1                                 1
 x1                         consumeCpu1                      100
 <UNKNOWN>                  x2                                 1
 x2                         consumeCpu2                     1000
-.fi
+.EE
 .in
 .SH SEE ALSO
 .BR gprof (1),