util/README

   1 Cairo Utilities
   2 ===============
   3
   4 There are a varieties of utilities we use with cairo.
   5
   6
   7 backtrace-symbols
   8 -----------------
   9
  10 This is a small shared library designed to be preloaded by the
  11 linker and its purpose is to make the backtrace_symbols() function
  12 of glibc produce more useful source reference information.
  13
  14 Build by:
  15
  16         make backtrace-symbols.so
  17
  18 and use by:
  19
  20         LD_PRELOAD=$PWD/backtrace-symbols.so app-to-run
  21
  22 This code should be contributed back to glibc at some point.
  23
  24
  25 malloc-stats
  26 ------------
  27
  28 This is a small shared library designed to be preloaded by the
  29 linker and its purpose is to make the malloc_stats() function
  30 of glibc produce more useful information.
  31
  32 Build by:
  33
  34         make malloc-stats.so
  35
  36 and use by:
  37
  38         LD_PRELOAD=$PWD/malloc-stats.so app-to-run
  39
  40 This works best when backtrace-symbols is in use.  That is:
  41
  42         LD_PRELOAD="$PWD/backtrace-symbols.so $PWD/malloc-stats.so" app-to-run
  43
  44
  45 cairo-trace
  46 -----------
  47
  48 This tool can be used to trace all the cairo function calls made by an
  49 applications.  This is useful for either extracting a test case triggering
  50 a bug from an application, or simply to get a general idea of how an
  51 application is using cairo.
  52
  53
  54 cairo-api-update and xr2cairo
  55 -----------------------------
  56
  57 These two scripts were used to convert source code written for pre-1.0
  58 cairo to newer API.  See $(top_srcdir)/PORTING_GUIDE for more information.
  59
  60 These files are obsolete now and may be removed in a future version.
  61
  62
  63 cairo-view and waterfall
  64 ------------------------
  65
  66 These are two pycairo scripts useful for testing the toy font backend.
  67