From: simonmar <unknown>
Date: Tue, 10 Jan 2006 09:05:18 +0000 (+0000)
Subject: [project @ 2006-01-10 09:05:18 by simonmar]
X-Git-Tag: final_switch_to_darcs,_this_repo_is_now_live~45
X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=e0dc0bc87a534b5a0329d3544c408c5f32d129a4

[project @ 2006-01-10 09:05:18 by simonmar]
add file argument to docs for +RTS -t
---

diff --git a/ghc/docs/users_guide/runtime_control.xml b/ghc/docs/users_guide/runtime_control.xml
index e779ce3..daed07c 100644
--- a/ghc/docs/users_guide/runtime_control.xml
+++ b/ghc/docs/users_guide/runtime_control.xml
@@ -377,13 +377,20 @@
 
       <varlistentry>
 	<term>
-          <option>-t</option>
+          <option>-t<replaceable>file</replaceable></option>
           <indexterm><primary><option>-t</option></primary><secondary>RTS option</secondary></indexterm>
         </term>
 	<listitem>
 	  <para>Write a one-line GC stats summary after running the
 	  program.  This output is in the same format as that produced
 	  by the <option>-Rghc-timing</option> option.</para>
+
+	  <para>As with <option>-s</option>, the default
+          <replaceable>file</replaceable> is
+          <filename><replaceable>program</replaceable>.stat</filename>. The
+          <replaceable>file</replaceable> <constant>stderr</constant>
+          is treated specially, with the output really being sent to
+          <constant>stderr</constant>.</para>
 	</listitem>
       </varlistentry>
     </variablelist>