summaryrefslogtreecommitdiff
path: root/man/intel_gpu_top.man
diff options
context:
space:
mode:
authorGaetan Nadon <memsize@videotron.ca>2012-01-03 21:12:19 -0500
committerDaniel Vetter <daniel.vetter@ffwll.ch>2012-01-04 10:47:10 +0100
commit4384c68f2ed7dac944b1cf57ac4acda606fafffe (patch)
treef5a48da5bfed42a28c796af67fa4fd7ddceec0b8 /man/intel_gpu_top.man
parent6540ed2112dc589e13eb4bf4460df1c95a1b38a5 (diff)
Man pages still showing version 1.0 in the 1.1 release
The patch coverts the man subdir to the standard xorg man page makefile. The version number is automatically updated when a new release is made. The man page section number is no longer hard coded either. The package util-macros at version 1.8 or greater is required. Acked-by: Cyril Brulebois <kibi@debian.org> Reviewed-by: Ben Widawsky <ben@bwidawsk.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'man/intel_gpu_top.man')
-rw-r--r--man/intel_gpu_top.man41
1 files changed, 41 insertions, 0 deletions
diff --git a/man/intel_gpu_top.man b/man/intel_gpu_top.man
new file mode 100644
index 00000000..b307a238
--- /dev/null
+++ b/man/intel_gpu_top.man
@@ -0,0 +1,41 @@
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH intel_gpu_top __appmansuffix__ __xorgversion__
+.SH NAME
+intel_gpu_top \- Display a top-like summary of Intel GPU usage
+.SH SYNOPSIS
+.nf
+.B intel_gpu_top
+.B intel_gpu_top [ parameters ]
+.SH DESCRIPTION
+.B intel_gpu_top
+is a tool to display usage information of an Intel GPU. It requires root
+privilege to map the graphics device.
+.SS Options
+.TP
+.B -s [samples per second]
+number of samples to acquire per second
+.TP
+.B -o [output file]
+collect usage statistics to [file]. If file is "-", run non-interactively
+and output statistics to stdout.
+.TP
+.B -e ["command to profile"]
+execute a command, and leave when it is finished. Note that the entire command
+with all parameters should be included as one parameter.
+.TP
+.B -h
+show usage notes
+.SH EXAMPLES
+.TP
+intel_gpu_top -o "cairo-trace-gvim.log" -s 100 -e "cairo-perf-trace /tmp/gvim"
+will run cairo-perf-trace with /tmp/gvim trace, non-interactively, saving the
+statistics into cairo-trace-gvim.log file, and collecting 100 samples per
+second.
+.PP
+Note that idle units are not
+displayed, so an entirely idle GPU will only display the ring status and
+header.
+.SH BUGS
+Some GPUs report some units as busy when they aren't, such that even when
+idle and not hung, it will show up as 100% busy.