summaryrefslogtreecommitdiff
path: root/man/intel_aubdump.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_aubdump.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_aubdump.rst')
-rw-r--r--man/intel_aubdump.rst55
1 files changed, 55 insertions, 0 deletions
diff --git a/man/intel_aubdump.rst b/man/intel_aubdump.rst
new file mode 100644
index 00000000..c6a51676
--- /dev/null
+++ b/man/intel_aubdump.rst
@@ -0,0 +1,55 @@
+=============
+intel_aubdump
+=============
+
+-----------------------------------------------------
+Launch an application and capture rendering to an AUB
+-----------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <intel-gfx@lists.freedesktop.org>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2015-2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_aubdump** [*OPTIONS*] -- *COMMAND* [*ARGUMENTS*]
+
+DESCRIPTION
+===========
+
+Run COMMAND with ARGUMENTS and dump an AUB file that captures buffer contents
+and execution of the i915 GEM application.
+
+OPTIONS
+=======
+
+-v
+ Enable verbose mode.
+
+--help
+ Output a usage message and exit.
+
+-o FILE, --output=FILE
+ Write the trace output to the file FILE. Default is COMMAND.aub.
+
+--device=ID
+ Override the PCI ID of the drm device. This is useful for getting an aub
+ dump for a different generation of GPU. In this mode **intel_aubdump** will
+ intercept but not forward the execbuffer2 ioctl, as that would typically
+ cause a GPU hang.
+
+EXAMPLES
+========
+
+intel_aubdump -v --output=stuff.aub -- glxgears -geometry 500x500
+ Launches glxgears with its -geometry option and enables aub dumping with
+ the -v and --output=stuff.aub options.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.