third_party/tcmalloc/vendor/doc/pprof.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.23.
   2 .TH PPROF "1" "February 2005" "pprof (part of gperftools)" Google
   3 .SH NAME
   4 pprof \- manual page for pprof (part of gperftools)
   5 .SH SYNOPSIS
   6 .B pprof
   7 [\fIoptions\fR] \fI<program> <profile>\fR
   8 .SH DESCRIPTION
   9 .IP
  10 Prints specified cpu- or heap-profile
  11 .SH OPTIONS
  12 .TP
  13 \fB\-\-cum\fR
  14 Sort by cumulative data
  15 .TP
  16 \fB\-\-base=\fR<base>
  17 Subtract <base> from <profile> before display
  18 .SS "Reporting Granularity:"
  19 .TP
  20 \fB\-\-addresses\fR
  21 Report at address level
  22 .TP
  23 \fB\-\-lines\fR
  24 Report at source line level
  25 .TP
  26 \fB\-\-functions\fR
  27 Report at function level [default]
  28 .TP
  29 \fB\-\-files\fR
  30 Report at source file level
  31 .SS "Output type:"
  32 .TP
  33 \fB\-\-text\fR
  34 Generate text report [default]
  35 .TP
  36 \fB\-\-gv\fR
  37 Generate Postscript and display
  38 .TP
  39 \fB\-\-list=\fR<regexp>
  40 Generate source listing of matching routines
  41 .TP
  42 \fB\-\-disasm=\fR<regexp>
  43 Generate disassembly of matching routines
  44 .TP
  45 \fB\-\-dot\fR
  46 Generate DOT file to stdout
  47 .TP
  48 \fB\-\-ps\fR
  49 Generate Postcript to stdout
  50 .TP
  51 \fB\-\-pdf\fR
  52 Generate PDF to stdout
  53 .TP
  54 \fB\-\-gif\fR
  55 Generate GIF to stdout
  56 .SS "Heap-Profile Options:"
  57 .TP
  58 \fB\-\-inuse_space\fR
  59 Display in-use (mega)bytes [default]
  60 .TP
  61 \fB\-\-inuse_objects\fR
  62 Display in-use objects
  63 .TP
  64 \fB\-\-alloc_space\fR
  65 Display allocated (mega)bytes
  66 .TP
  67 \fB\-\-alloc_objects\fR
  68 Display allocated objects
  69 .TP
  70 \fB\-\-show_bytes\fR
  71 Display space in bytes
  72 .TP
  73 \fB\-\-drop_negative\fR
  74 Ignore negaive differences
  75 .SS "Call-graph Options:"
  76 .TP
  77 \fB\-\-nodecount=\fR<n>
  78 Show at most so many nodes [default=80]
  79 .TP
  80 \fB\-\-nodefraction=\fR<f>
  81 Hide nodes below <f>*total [default=.005]
  82 .TP
  83 \fB\-\-edgefraction=\fR<f>
  84 Hide edges below <f>*total [default=.001]
  85 .TP
  86 \fB\-\-focus=\fR<regexp>
  87 Focus on nodes matching <regexp>
  88 .TP
  89 \fB\-\-ignore=\fR<regexp>
  90 Ignore nodes matching <regexp>
  91 .TP
  92 \fB\-\-scale=\fR<n>
  93 Set GV scaling [default=0]
  94 .SH EXAMPLES
  95
  96 pprof /bin/ls ls.prof
  97 .IP
  98 Outputs one line per procedure
  99 .PP
 100 pprof \fB\-\-gv\fR /bin/ls ls.prof
 101 .IP
 102 Displays annotated call-graph via 'gv'
 103 .PP
 104 pprof \fB\-\-gv\fR \fB\-\-focus\fR=\fIMutex\fR /bin/ls ls.prof
 105 .IP
 106 Restricts to code paths including a .*Mutex.* entry
 107 .PP
 108 pprof \fB\-\-gv\fR \fB\-\-focus\fR=\fIMutex\fR \fB\-\-ignore\fR=\fIstring\fR /bin/ls ls.prof
 109 .IP
 110 Code paths including Mutex but not string
 111 .PP
 112 pprof \fB\-\-list\fR=\fIgetdir\fR /bin/ls ls.prof
 113 .IP
 114 Dissassembly (with per-line annotations) for getdir()
 115 .PP
 116 pprof \fB\-\-disasm\fR=\fIgetdir\fR /bin/ls ls.prof
 117 .IP
 118 Dissassembly (with per-PC annotations) for getdir()
 119 .SH COPYRIGHT
 120 Copyright \(co 2005 Google Inc.
 121 .SH "SEE ALSO"
 122 Further documentation for
 123 .B pprof
 124 is maintained as a web page called
 125 .B cpu_profiler.html
 126 and is likely installed at one of the following locations:
 127 .IP
 128 .B /usr/share/gperftools/cpu_profiler.html
 129 .br
 130 .B /usr/local/share/gperftools/cpu_profiler.html
 131 .PP