Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill the C version of tesh (now unused). RIP :(
[simgrid.git] / tools / tesh / tesh.1
index d5d7283..7dee6bb 100644 (file)
@@ -1,4 +1,8 @@
-.\" Manpage for tesh
+.\" Manpage for tesh, the TEsting SHell.
+.\" 
+.\" To read it locally (when not installed): 
+.\"   man ./tesh.1
+.\"
 .TH tesh 1 "10 Oct 2012" "1.0" "tesh man page"
 .SH NAME
 tesh \- testing shell
@@ -8,9 +12,11 @@ tesh \- testing shell
 .SH DESCRIPTION
 This is the TESH tool. It constitutes a testing shell, ie a sort of shell specialized to run tests. The list of actions to take is parsed from files files called testsuite.
 .SH OPTIONS
-  --cd some/directory: ask tesh to switch the working directory before
-                       launching the tests
-  --setenv var=value: set a specific environment variable
+  --cd some/directory : ask tesh to switch the working directory before
+                        launching the tests
+  --setenv var=value  : set a specific environment variable
+  --cfg arg           : add parameter --cfg=arg to each command line
+  --enable-coverage   : ignore output lines starting with "profiling:"
 .SH TESH FILE SYNTAX
 Here is the syntax of these files:
 
@@ -105,7 +111,7 @@ parallel). To ensure that the simulator outputs still match, we have
 to sort the output back before comparing it.
 
 We expect the simulators to run with that log formatting argument:
-   -log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
+   --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
 Then, tesh sorts string on the 19 first chars only, and is stable when
 line beginnings are equal. This should ensure that:
  (1) tesh is effective (no false positive, no false negative)