summaryrefslogtreecommitdiff
path: root/man/intel_gpu_top.rst
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-03-01 12:57:48 +0200
committerJani Nikula <jani.nikula@intel.com>2016-03-03 16:17:07 +0200
commitcc7387f17ce5750fc640355d94ed60b6936c2d7b (patch)
treea037709d5ebb0f68c4b762d2703e1903e5240bf5 /man/intel_gpu_top.rst
parent037bc69fde7e66511781ebd3fb3f712056fc1ff2 (diff)
man: rewrite manual pages in reStructuredText
intel_reg.rst was the first man page written in reStructuredText. Follow suit with the rest of the man pages. Add a generated defs.rst include file for definitions such as intel-gpu-tools version. This replaces the MAN_SUBSTS sed script substitutions from xorg-macros for old man pages. Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Diffstat (limited to 'man/intel_gpu_top.rst')
-rw-r--r--man/intel_gpu_top.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
new file mode 100644
index 00000000..c9030e1e
--- /dev/null
+++ b/man/intel_gpu_top.rst
@@ -0,0 +1,64 @@
+=============
+intel_gpu_top
+=============
+
+---------------------------------------------
+Display a top-like summary of Intel GPU usage
+---------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <intel-gfx@lists.freedesktop.org>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2011,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_gpu_top** [*OPTIONS*]
+
+DESCRIPTION
+===========
+
+**intel_gpu_top** is a tool to display usage information of an Intel GPU. It
+requires root privilege to map the graphics device.
+
+OPTIONS
+=======
+
+-s SAMPLES
+ Number of samples to acquire per second.
+
+-o FILE
+ Collect usage statistics to FILE. If file is "-", run non-interactively
+ and output statistics to stdout.
+
+-e COMMAND
+ Execute COMMAND to profile, and leave when it is finished. Note that the
+ entire command with all parameters should be included as one parameter.
+
+-h
+ Show usage notes.
+
+EXAMPLES
+========
+
+intel_gpu_top -o "cairo-trace-gvim.log" -s 100 -e "cairo-perf-trace /tmp/gvim"
+ 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.
+
+Note that idle units are not displayed, so an entirely idle GPU will only
+display the ring status and header.
+
+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.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.