perf config: Add initial man page
authorTaeung Song <treeze.taeung@gmail.com>
Sun, 22 Nov 2015 10:11:56 +0000 (19:11 +0900)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 23 Nov 2015 21:31:25 +0000 (18:31 -0300)
Add perf-config document to describe the perf configuration and a
'list’ subcommand.

Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: http://lkml.kernel.org/r/63AD9B57-7B8C-46F8-8F18-0FFEB9A6A1BC@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-config.txt [new file with mode: 0644]

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
new file mode 100644 (file)
index 0000000..b9ca1e3
--- /dev/null
@@ -0,0 +1,103 @@
+perf-config(1)
+==============
+
+NAME
+----
+perf-config - Get and set variables in a configuration file.
+
+SYNOPSIS
+--------
+[verse]
+'perf config' -l | --list
+
+DESCRIPTION
+-----------
+You can manage variables in a configuration file with this command.
+
+OPTIONS
+-------
+
+-l::
+--list::
+       Show current config variables, name and value, for all sections.
+
+CONFIGURATION FILE
+------------------
+
+The perf configuration file contains many variables to change various
+aspects of each of its tools, including output, disk usage, etc.
+The '$HOME/.perfconfig' file is used to store a per-user configuration.
+The file '$(sysconfdir)/perfconfig' can be used to
+store a system-wide default configuration.
+
+Syntax
+~~~~~~
+
+The file consist of sections. A section starts with its name
+surrounded by square brackets and continues till the next section
+begins. Each variable must be in a section, and have the form
+'name = value', for example:
+
+       [section]
+               name1 = value1
+               name2 = value2
+
+Section names are case sensitive and can contain any characters except
+newline (double quote `"` and backslash have to be escaped as `\"` and `\\`,
+respectively). Section headers can't span multiple lines.
+
+Example
+~~~~~~~
+
+Given a $HOME/.perfconfig like this:
+
+#
+# This is the config file, and
+# a '#' and ';' character indicates a comment
+#
+
+       [colors]
+               # Color variables
+               top = red, default
+               medium = green, default
+               normal = lightgray, default
+               selected = white, lightgray
+               code = blue, default
+               addr = magenta, default
+               root = white, blue
+
+       [tui]
+               # Defaults if linked with libslang
+               report = on
+               annotate = on
+               top = on
+
+       [buildid]
+               # Default, disable using /dev/null
+               dir = ~/.debug
+
+       [annotate]
+               # Defaults
+               hide_src_code = false
+               use_offset = true
+               jump_arrows = true
+               show_nr_jumps = false
+
+       [help]
+               # Format can be man, info, web or html
+               format = man
+               autocorrect = 0
+
+       [ui]
+               show-headers = true
+
+       [call-graph]
+               # fp (framepointer), dwarf
+               record-mode = fp
+               print-type = graph
+               order = caller
+               sort-key = function
+
+SEE ALSO
+--------
+linkperf:perf[1]