| Eric Anholt | e71c628 | 2009-05-19 16:09:08 -0700 | [diff] [blame] | 1 | .\" shorthand for double quote that works everywhere. |
| 2 | .ds q \N'34' |
| Gaetan Nadon | 4384c68 | 2012-01-03 21:12:19 -0500 | [diff] [blame] | 3 | .TH intel_gpu_top __appmansuffix__ __xorgversion__ |
| Eric Anholt | e71c628 | 2009-05-19 16:09:08 -0700 | [diff] [blame] | 4 | .SH NAME |
| 5 | intel_gpu_top \- Display a top-like summary of Intel GPU usage |
| 6 | .SH SYNOPSIS |
| Eugeni Dodonov | 09e4b0c | 2011-09-05 16:23:11 -0300 | [diff] [blame] | 7 | .nf |
| Eric Anholt | e71c628 | 2009-05-19 16:09:08 -0700 | [diff] [blame] | 8 | .B intel_gpu_top |
| Eugeni Dodonov | 09e4b0c | 2011-09-05 16:23:11 -0300 | [diff] [blame] | 9 | .B intel_gpu_top [ parameters ] |
| Eric Anholt | e71c628 | 2009-05-19 16:09:08 -0700 | [diff] [blame] | 10 | .SH DESCRIPTION |
| 11 | .B intel_gpu_top |
| 12 | is a tool to display usage information of an Intel GPU. It requires root |
| 13 | privilege to map the graphics device. |
| Eugeni Dodonov | 09e4b0c | 2011-09-05 16:23:11 -0300 | [diff] [blame] | 14 | .SS Options |
| 15 | .TP |
| 16 | .B -s [samples per second] |
| 17 | number of samples to acquire per second |
| 18 | .TP |
| Eugeni Dodonov | c2983f2 | 2011-09-05 19:39:58 -0300 | [diff] [blame] | 19 | .B -o [output file] |
| Eugeni Dodonov | 62c542f | 2011-10-14 15:26:13 -0300 | [diff] [blame] | 20 | collect usage statistics to [file]. If file is "-", run non-interactively |
| 21 | and output statistics to stdout. |
| Eugeni Dodonov | c2983f2 | 2011-09-05 19:39:58 -0300 | [diff] [blame] | 22 | .TP |
| Eugeni Dodonov | a483c97 | 2011-09-05 19:41:24 -0300 | [diff] [blame] | 23 | .B -e ["command to profile"] |
| 24 | execute a command, and leave when it is finished. Note that the entire command |
| 25 | with all parameters should be included as one parameter. |
| 26 | .TP |
| Eugeni Dodonov | 09e4b0c | 2011-09-05 16:23:11 -0300 | [diff] [blame] | 27 | .B -h |
| 28 | show usage notes |
| Eugeni Dodonov | a483c97 | 2011-09-05 19:41:24 -0300 | [diff] [blame] | 29 | .SH EXAMPLES |
| 30 | .TP |
| 31 | intel_gpu_top -o "cairo-trace-gvim.log" -s 100 -e "cairo-perf-trace /tmp/gvim" |
| 32 | will run cairo-perf-trace with /tmp/gvim trace, non-interactively, saving the |
| 33 | statistics into cairo-trace-gvim.log file, and collecting 100 samples per |
| 34 | second. |
| Eric Anholt | e71c628 | 2009-05-19 16:09:08 -0700 | [diff] [blame] | 35 | .PP |
| 36 | Note that idle units are not |
| 37 | displayed, so an entirely idle GPU will only display the ring status and |
| 38 | header. |
| 39 | .SH BUGS |
| 40 | Some GPUs report some units as busy when they aren't, such that even when |
| 41 | idle and not hung, it will show up as 100% busy. |