Permalink
Browse files

USAGE message

  • Loading branch information...
1 parent 76719a4 commit 9e004846b0f25a4c3f957580844b0771720e790b Brendan Gregg committed May 18, 2013
Showing with 21 additions and 0 deletions.
  1. +21 −0 README
View
21 README
@@ -75,3 +75,24 @@ $ ./stackcollapse.pl example-stacks.txt | ./flamegraph.pl > example.svg
This was from a particular performance investigation: the Flame Graph
identified that CPU time was spent in the lofs module, and quantified
that time.
+
+
+Options
+=======
+See the USAGE message (--help) for options:
+
+USAGE: ./flamegraph.pl [options] infile > outfile.svg
+
+ --titletext # change title text
+ --width # width of image (default 1200)
+ --height # height of each frame (default 16)
+ --minwidth # omit smaller functions (default 0.1 pixels)
+ --fonttype # font type (default "Verdana")
+ --fontsize # font size (default 12)
+ --countname # count type label (default "samples")
+ --nametype # name type label (default "Function:")
+ eg,
+ ./flamegraph.pl --titletext="Flame Graph: malloc()" trace.txt > graph.svg
+
+As suggested in the example, flame graphs can process traces of any event,
+such as malloc()s, provided stack traces are gathered.

0 comments on commit 9e00484

Please sign in to comment.