Allow to use call sets instead of call numbers / frequencies.

[apitrace] / README.markdown

diff --git a/README.markdown b/README.markdown
index 7ca0df7be6609550439b390b03a5b96f12b58d47..38dfa5e21c357ae47a9187ded3d786b895a9dee4 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -64,6 +64,34 @@ Advanced command line usage
 ===========================
 
 
+Call sets
+---------
+
+Several tools take `CALLSET` arguments, e.g:
+
+    apitrace dump --calls CALLSET foo.trace
+    glretrace -S CALLSET foo.trace
+
+The call syntax is very flexible. Here are a few examples:
+
+ * `4`             one call
+
+ * `1,2,4,5`       set of calls
+
+ * `"1 2 4 5"`     set of calls (commas are optional and can be replaced with whitespace)
+
+ * `1-100/2`       calls 1, 3, 5, ...,  99
+
+ * `1-1000/draw`   all draw calls between 1 and 1000
+
+ * `1-1000/fbo`    all fbo changes between calls 1 and 1000
+
+ * `frame`         all calls at end of frames
+
+ * `@foo.txt`      read call numbers from `foo.txt`, using the same syntax as above
+
+
+
 Tracing manually
 ----------------
 
@@ -96,6 +124,10 @@ to trace by using `glxtrace.so` as an ordinary `libGL.so` and injecting into
 See the `ld.so` man page for more information about `LD_PRELOAD` and
 `LD_LIBRARY_PATH` environment flags.
 
+To trace the application inside gdb, invoke gdb as:
+
+    gdb --ex 'set exec-wrapper env LD_PRELOAD=/path/to/glxtrace.so' --args /path/to/application
+
 ### Mac OS X ###
 
 Run the application you want to trace as