tools/perf/Documentation/perf-config.txt

   1 perf-config(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 perf-config - Get and set variables in a configuration file.
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'perf config' -l | --list
  12
  13 DESCRIPTION
  14 -----------
  15 You can manage variables in a configuration file with this command.
  16
  17 OPTIONS
  18 -------
  19
  20 -l::
  21 --list::
  22         Show current config variables, name and value, for all sections.
  23
  24 CONFIGURATION FILE
  25 ------------------
  26
  27 The perf configuration file contains many variables to change various
  28 aspects of each of its tools, including output, disk usage, etc.
  29 The '$HOME/.perfconfig' file is used to store a per-user configuration.
  30 The file '$(sysconfdir)/perfconfig' can be used to
  31 store a system-wide default configuration.
  32
  33 Syntax
  34 ~~~~~~
  35
  36 The file consist of sections. A section starts with its name
  37 surrounded by square brackets and continues till the next section
  38 begins. Each variable must be in a section, and have the form
  39 'name = value', for example:
  40
  41         [section]
  42                 name1 = value1
  43                 name2 = value2
  44
  45 Section names are case sensitive and can contain any characters except
  46 newline (double quote `"` and backslash have to be escaped as `\"` and `\\`,
  47 respectively). Section headers can't span multiple lines.
  48
  49 Example
  50 ~~~~~~~
  51
  52 Given a $HOME/.perfconfig like this:
  53
  54 #
  55 # This is the config file, and
  56 # a '#' and ';' character indicates a comment
  57 #
  58
  59         [colors]
  60                 # Color variables
  61                 top = red, default
  62                 medium = green, default
  63                 normal = lightgray, default
  64                 selected = white, lightgray
  65                 code = blue, default
  66                 addr = magenta, default
  67                 root = white, blue
  68
  69         [tui]
  70                 # Defaults if linked with libslang
  71                 report = on
  72                 annotate = on
  73                 top = on
  74
  75         [buildid]
  76                 # Default, disable using /dev/null
  77                 dir = ~/.debug
  78
  79         [annotate]
  80                 # Defaults
  81                 hide_src_code = false
  82                 use_offset = true
  83                 jump_arrows = true
  84                 show_nr_jumps = false
  85
  86         [help]
  87                 # Format can be man, info, web or html
  88                 format = man
  89                 autocorrect = 0
  90
  91         [ui]
  92                 show-headers = true
  93
  94         [call-graph]
  95                 # fp (framepointer), dwarf
  96                 record-mode = fp
  97                 print-type = graph
  98                 order = caller
  99                 sort-key = function
 100
 101 SEE ALSO
 102 --------
 103 linkperf:perf[1]