os_posix: Fix return value for os::execute()

[apitrace] / README.markdown

diff --git a/README.markdown b/README.markdown
index 38dfa5e21c357ae47a9187ded3d786b895a9dee4..536729e81fcac8bbc121db5ca71b87d2b82210b5 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -12,24 +12,38 @@ About **apitrace**
 * visualize and edit trace files.
 
 
 * visualize and edit trace files.
 
 

-Basic usage
-===========
+Obtaining **apitrace**
+======================

 
 

+To obtain apitrace either [download the latest
+binaries](https://github.com/apitrace/apitrace/downloads) for your platform if
+available, or follow the instructions in INSTALL.markdown to build it yourself.
+On 64bits Linux and Windows platforms you'll need apitrace binaries that match
+the architecture (32bits or 64bits) of the application being traced.

 
 

-Linux and Mac OS X
-------------------
+
+Basic usage
+===========

 
 Run the application you want to trace as
 
 
 Run the application you want to trace as
 

-    apitrace trace /path/to/application [args...]
+    apitrace trace --api API /path/to/application [args...]

 
 and it will generate a trace named `application.trace` in the current
 
 and it will generate a trace named `application.trace` in the current

-directory.  You can specify the written trace filename by setting the
-`TRACE_FILE` environment variable before running.
+directory.  You can specify the written trace filename by passing the
+`--output` command line option.
+
+Problems while tracing (e.g, if the application uses calls/parameters
+unsupported by apitrace) will be reported via stderr output on Unices.  On
+Windows you'll need to run
+[DebugView](http://technet.microsoft.com/en-us/sysinternals/bb896647) to view
+these messages.
+
+Follow the "Tracing manually" instructions below if you cannot obtain a trace.

 
 View the trace with
 
 
 View the trace with
 

-    apitrace dump --color application.trace
+    apitrace dump application.trace

 
 Replay an OpenGL trace with
 
 
 Replay an OpenGL trace with
 


@@ -38,26 +52,17 @@ Replay an OpenGL trace with
 Pass the `-sb` option to use a single buffered visual.  Pass `--help` to
 glretrace for more options.
 
 Pass the `-sb` option to use a single buffered visual.  Pass `--help` to
 glretrace for more options.
 

-Start the GUI as
-
-    qapitrace application.trace
-

 
 

-Windows
--------
+Basic GUI usage
+===============

 
 

-* Copy `opengl32.dll`, `d3d8.dll`, or `d3d9.dll` from build/wrappers directory
-  to the directory with the application you want to trace.
-
-* Run the application.
-
-* View the trace with
+Start the GUI as

 
 

-        \path\to\apitrace dump application.trace
+    qapitrace application.trace

 
 

-* Replay the trace with
+You can also tell the GUI to go directly to a specific call

 
 

-        \path\to\glretrace application.trace
+    qapitrace application.trace 12345

 
 
 Advanced command line usage
 
 
 Advanced command line usage


@@ -97,6 +102,14 @@ Tracing manually
 
 ### Linux ###
 
 
 ### Linux ###
 

+On 64 bits systems, you'll need to determine ether the application is 64 bits
+or 32 bits.  This can be done by doing
+
+    file /path/to/application
+
+But beware of wrapper shell scripts -- what matters is the architecture of the
+main process.
+

 Run the application you want to trace as
 
      LD_PRELOAD=/path/to/apitrace/wrappers/glxtrace.so /path/to/application
 Run the application you want to trace as
 
      LD_PRELOAD=/path/to/apitrace/wrappers/glxtrace.so /path/to/application


@@ -139,11 +152,35 @@ Note that although Mac OS X has an `LD_PRELOAD` equivalent,
 `DYLD_FORCE_FLAT_NAMESPACE=1` which breaks most applications.  See the `dyld` man
 page for more details about these environment flags.
 
 `DYLD_FORCE_FLAT_NAMESPACE=1` which breaks most applications.  See the `dyld` man
 page for more details about these environment flags.
 

+### Windows ###
+
+When tracing third-party applications, you can identify the target
+application's main executable, either by:

 
 

-Emitting annotations to the trace from GL applications
-------------------------------------------------------
+* right clicking on the application's icon in the _Start Menu_, choose
+  _Properties_, and see the _Target_ field;

 
 

-You can emit string and frame annotations through the
+* or by starting the application, run Windows Task Manager (taskmgr.exe), right
+  click on the application name in the _Applications_ tab, choose _Go To Process_,
+  note the highlighted _Image Name_, and search it on `C:\Program Files` or
+  `C:\Program Files (x86)`.
+
+On 64 bits Windows, you'll need to determine ether the application is a 64 bits
+or 32 bits. 32 bits applications will have a `*32` suffix in the _Image Name_
+column of the _Processes_ tab of _Windows Task Manager_ window.
+
+Copy the appropriate `opengl32.dll`, `d3d8.dll`, or `d3d9.dll` from the
+wrappers directory to the directory with the application you want to trace.
+Then run the application as usual.
+
+You can specify the written trace filename by setting the `TRACE_FILE`
+environment variable before running.
+
+
+Emitting annotations to the trace
+---------------------------------
+
+From OpenGL applications you can embed annotations in the trace file through the

 [`GL_GREMEDY_string_marker`](http://www.opengl.org/registry/specs/GREMEDY/string_marker.txt)
 and
 [`GL_GREMEDY_frame_terminator`](http://www.opengl.org/registry/specs/GREMEDY/frame_terminator.txt)
 [`GL_GREMEDY_string_marker`](http://www.opengl.org/registry/specs/GREMEDY/string_marker.txt)
 and
 [`GL_GREMEDY_frame_terminator`](http://www.opengl.org/registry/specs/GREMEDY/frame_terminator.txt)


@@ -173,6 +210,15 @@ detect and use GL extensions, you could easily accomplish this by doing:
 This has the added advantage of working equally well with gDEBugger.
 
 
 This has the added advantage of working equally well with gDEBugger.
 
 

+From OpenGL ES applications you can embed annotations in the trace file through the
+[`GL_EXT_debug_marker`](http://www.khronos.org/registry/gles/extensions/EXT/EXT_debug_marker.txt)
+extension.
+
+
+For Direct3D applications you can follow the same procedure used for 
+[instrumenting an application for PIX](http://technet.microsoft.com/en-us/query/ee417250)
+
+

 Dump GL state at a particular call
 ----------------------------------
 
 Dump GL state at a particular call
 ----------------------------------
 


@@ -205,6 +251,18 @@ You can make a video of the output by doing
     | ffmpeg -r 30 -f image2pipe -vcodec ppm -i pipe: -vcodec mpeg4 -y output.mp4
 
 
     | ffmpeg -r 30 -f image2pipe -vcodec ppm -i pipe: -vcodec mpeg4 -y output.mp4
 
 

+Triming a trace
+---------------
+
+You can make a smaller trace by doing:
+
+    apitrace trim --callset 100-1000 -o trimed.trace applicated.trace
+
+If you need precise control over which calls to trim you can specify the
+individual call numbers a plaintext file, as described in the 'Call sets'
+section above.
+
+

 Advanced usage for OpenGL implementors
 ======================================
 
 Advanced usage for OpenGL implementors
 ======================================
 


@@ -218,13 +276,11 @@ These are the steps to create a regression test-suite around **apitrace**:
 
 * obtain a trace
 
 
 * obtain a trace
 

-* obtain reference snapshots, by doing:
+* obtain reference snapshots, by doing on a reference system:

 
 

-        mkdir /path/to/snapshots/
+        mkdir /path/to/reference/snapshots/

         glretrace -s /path/to/reference/snapshots/ application.trace
 
         glretrace -s /path/to/reference/snapshots/ application.trace
 

-  on reference system.
-

 * prune the snapshots which are not interesting
 
 * to do a regression test, do:
 * prune the snapshots which are not interesting
 
 * to do a regression test, do:


@@ -233,8 +289,8 @@ These are the steps to create a regression test-suite around **apitrace**:
 
   Alternatively, for a HTML summary, use `apitrace diff-images`:
 
 
   Alternatively, for a HTML summary, use `apitrace diff-images`:
 

-        glretrace -s /path/to/current/snapshots/ application.trace
-        apitrace diff-images --output summary.html /path/to/reference/snapshots/ /path/to/current/snapshots/
+        glretrace -s /path/to/test/snapshots/ application.trace
+        apitrace diff-images --output summary.html /path/to/reference/snapshots/ /path/to/test/snapshots/

 
 
 Automated git-bisection
 
 
 Automated git-bisection


@@ -302,16 +358,20 @@ reference software renderer.
 
 This can be achieved with retracediff.py script, which invokes glretrace with
 different environments, allowing to choose the desired GL driver by
 
 This can be achieved with retracediff.py script, which invokes glretrace with
 different environments, allowing to choose the desired GL driver by

-manipulating variables such as `LD_LIBRARY_PATH` or `LIBGL_DRIVERS_DIR`.
+manipulating variables such as `LD_LIBRARY_PATH`, `LIBGL_DRIVERS_DIR`, or
+`TRACE_LIBGL`.

 
 

-For example:
+For example, on Linux:

 
     ./scripts/retracediff.py \
         --ref-env LD_LIBRARY_PATH=/path/to/reference/GL/implementation \
 
     ./scripts/retracediff.py \
         --ref-env LD_LIBRARY_PATH=/path/to/reference/GL/implementation \

-        -r ./glretrace \
+        --retrace /path/to/glretrace \

         --diff-prefix=/path/to/output/diffs \
         application.trace
 
         --diff-prefix=/path/to/output/diffs \
         application.trace
 

+Or on Windows:
+
+    python scripts\retracediff.py --retrace \path\to\glretrace.exe --ref-env TRACE_LIBGL=\path\to\reference\opengl32.dll application.trace

 
 
 Links
 
 
 Links


@@ -343,8 +403,12 @@ Closed-source:
 
   * [D3DSpy](http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm): the predecessor of PIX
 
 
   * [D3DSpy](http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm): the predecessor of PIX
 

+* [NVIDIA PerfKit](http://developer.nvidia.com/nvidia-perfkit)
+

 * [AMD GPU PerfStudio](http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx)
 
 * [AMD GPU PerfStudio](http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx)
 

+* [Intel Graphics Performance Analyzers](http://www.intel.com/software/gpa/)
+

 
 OpenGL
 ------
 
 OpenGL
 ------


@@ -357,9 +421,11 @@ Open-source:
 
 * [tracy](https://gitorious.org/tracy): OpenGL ES and OpenVG trace, retrace, and state inspection
 
 
 * [tracy](https://gitorious.org/tracy): OpenGL ES and OpenVG trace, retrace, and state inspection
 

+* [WebGL-Inspector](http://benvanik.github.com/WebGL-Inspector/)
+

 Closed-source:
 
 Closed-source:
 

-* [gDEBugger](http://www.gremedy.com/products.php)
+* [gDEBugger](http://www.gremedy.com/products.php) and [AMD gDEBugger](http://developer.amd.com/tools/gDEBugger/Pages/default.aspx)

 
 * [glslDevil](http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html)
 
 
 * [glslDevil](http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html)