Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 83617983 authored by Mike Galbraith's avatar Mike Galbraith Committed by Ingo Molnar
Browse files

perf top: Update man page 



perf_counter tools: update perf top manual page to reflect
current implementation.

Signed-off-by: default avatarMike Galbraith <efault@gmx.de>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
parent 091bd2e9

tools/perf/Documentation/perf-top.txt

+99 −13
Original line number Diff line number Diff line
@@ -3,36 +3,122 @@ perf-top(1) 


NAME

----

perf-top - Run a command and profile it

perf-top - System profiling tool.



SYNOPSIS

--------

[verse]

'perf top' [-e <EVENT> | --event=EVENT] [-l] [-a] <command>

'perf top' [-e <EVENT> | --event=EVENT] [<options>]



DESCRIPTION

-----------

This command runs a command and gathers a performance counter profile

from it.

This command generates and displays a performance counter profile in realtime.





OPTIONS

-------

<command>...::

	Any command you can specify in a shell.

-a::

--all-cpus::

        System-wide collection.  (default)



-c <count>::

--count=<count>::

	Event period to sample.



-C <cpu>::

--CPU=<cpu>::

	CPU to profile.



-d <seconds>::

--delay=<seconds>::

	Number of seconds to delay between refreshes.



-e::

--event=::

-e <event>::

--event=<event>::

	Select the PMU event. Selection can be a symbolic event name

	(use 'perf list' to list all events) or a raw PMU

	event (eventsel+umask) in the form of rNNN where NNN is a

	hexadecimal event descriptor.



-a::

        system-wide collection

-E <entries>::

--entries=<entries>::

	Display this many functions.



-f <count>::

--count-filter=<count>::

	Only display functions with more events than this.



-F <freq>::

--freq=<freq>::

	Profile at this frequency.



-i::

--inherit::

	Child tasks inherit counters, only makes sens with -p option.



-k <path>::

--vmlinux=<path>::

	Path to vmlinux.  Required for annotation functionality.



-m <pages>::

--mmap-pages=<pages>::

	Number of mmapped data pages.



-p <pid>::

--pid=<pid>::

	Profile events on existing pid.



-r <priority>::

--realtime=<priority>::

	Collect data with this RT SCHED_FIFO priority.



-s <symbol>::

--sym-annotate=<symbol>::

        Annotate this symbol.  Requires -k option.



-v::

--verbose::

	Be more verbose (show counter open errors, etc).



-z::

--zero::

	Zero history across display updates.



INTERACTIVE PROMPTING KEYS

--------------------------



[d]::

	Display refresh delay.



[e]::

	Number of entries to display.



[E]::

	Event to display when multiple counters are active.



[f]::

	Profile display filter (>= hit count).



[F]::

	Annotation display filter (>= % of total).



[s]::

	Annotate symbol.



[S]::

	Stop annotation, return to full profile display.



[w]::

	Toggle between weighted sum and individual count[E]r profile.



[z]::

	Toggle event count zeroing across display updates.



[qQ]::

	Quit.



Pressing any unmapped key displays a menu, and prompts for input.



-l::

        scale counter values



SEE ALSO

--------