documentation on how to define colors for triva

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@7491 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/doc/FAQ.doc b/doc/FAQ.doc
index 4114d85..bc1d58d 100644 (file)
--- a/doc/FAQ.doc
+++ b/doc/FAQ.doc
@@ -1851,6 +1851,7 @@ Trace Analysis through Visualization
  Other auxiliary options to check the trace file:
   -c, --check                Check the integrity of trace file
   -h, --hierarchy            Export the trace type hierarchy
  Other auxiliary options to check the trace file:
   -c, --check                Check the integrity of trace file
   -h, --hierarchy            Export the trace type hierarchy

+  -l, --list                 List entity types

 
   -?, --help                 Give this help list
       --usage                Give a short usage message
 
   -?, --help                 Give this help list
       --usage                Give a short usage message


@@ -2086,6 +2087,39 @@ visualization was generated with the following configuration:
 \endhtmlonly
 </center>
 
 \endhtmlonly
 </center>
 

+- <b>Understading Triva - colors</b>: An important issue when using Triva is how
+  to define colors. To do that, we have to know which variables are defined in
+the trace file generated by the SimGrid library. The parameter <em>--list</em> 
+lists the variables for a given trace file:
+\verbatim
+$ Triva -l masterslave_forwarder.trace
+iFile
+c  platform
+c    HOST
+v     power
+v     is_slave
+v     is_master
+v     task_creation
+v     task_computation
+v     pcompute
+v     pfinalize
+c    LINK
+v     bandwidth
+v     latency
+v     bcompute
+v     bfinalize
+c  user_type
+\endverbatim
+We can see that HOST has seven variables (from power to pfinalize) and LINK has
+four (from bandwidth to bfinalize). To define a red color for the
+<i>pcompute</i> and <i>bcompute</i> (which are defined based on user category
+<i>compute</i>), execute:
+\verbatim
+$ defaults write Triva 'pcompute Color' '1 0 0'
+$ defaults write Triva 'bcompute Color' '1 0 0'
+\endverbatim
+Where the three numbers in each line are the RGB color with values from 0 to 1.
+

 \section faq_troubleshooting Troubleshooting
 
 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
 \section faq_troubleshooting Troubleshooting
 
 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems