[project @ 2004-05-05 14:32:01 by simonmar]

Rearrange the -F/-pgmF documentation a bit.

diff --git a/ghc/docs/users_guide/phases.sgml b/ghc/docs/users_guide/phases.sgml
index ebbdf64..39e4ea4 100644 (file)
--- a/ghc/docs/users_guide/phases.sgml
+++ b/ghc/docs/users_guide/phases.sgml
@@ -375,44 +375,39 @@ strmod = "\
          <listitem>
            <para>A custom pre-processor is run over your Haskell
            source file only if the <option>-F</option> option
-           <indexterm><primary>-F</primary></indexterm> is given.
-           </para>
-           <para>
-           Running a custom pre-processor at compile-time is in some
-           settings appropriate and useful. The <option>-F</option>
-            option lets you run a pre-processor as part of the overall
-           GHC compilation pipeline, which has the advantage over
-           running a Haskell pre-processor separately in that it
-           works in interpreted mode and you can continue to take
-           reap the benefits of GHC's recompilation checker.
-           </para>
-           <para>
-           The pre-processor is run just before the Haskell
-           compiler proper processes the Haskell input, but after
-           the literate markup has been stripped away and (possibly)
-           the C pre-processor has washed the Haskell input.
-           </para>
-         </listitem>
-       </varlistentry>
-       <varlistentry>
-         <term><option>-pgmF</option> <replaceable>cmd</replaceable></term>
-         <indexterm><primary><option>-pgmF</option> <replaceable>cmd</replaceable></primary></indexterm>
-         <listitem>
-           <para>Use <replaceable>cmd</replaceable> as the Haskell
-         pre-processor. When invoked, the
-         <replaceable>cmd</replaceable> pre-processor is given at
-         least three arguments on its command-line: the first
-         argument is the name of the original source file, the second
-         is the name of the file holding the input, and the third is
-         the name of the file where
-         <replaceable>cmd</replaceable> should write its output to.
-         </para>
-         <para>Additional arguments to the
-         <replaceable>cmd</replaceable> pre-processor can be passed
-         in using the <option>-optF</option> option. These are fed to
-         <replaceable>cmd</replaceable> on the command line after the
-         three standard input and output arguments. 
-        </para>
+           <indexterm><primary>-F</primary></indexterm> is
+           given.</para>
+
+           <para>Running a custom pre-processor at compile-time is in
+           some settings appropriate and useful. The
+           <option>-F</option> option lets you run a pre-processor as
+           part of the overall GHC compilation pipeline, which has
+           the advantage over running a Haskell pre-processor
+           separately in that it works in interpreted mode and you
+           can continue to take reap the benefits of GHC's
+           recompilation checker.</para>
+
+           <para>The pre-processor is run just before the Haskell
+           compiler proper processes the Haskell input, but after the
+           literate markup has been stripped away and (possibly) the
+           C pre-processor has washed the Haskell input.</para>
+
+           <para>Use
+            <option>-pgmF&nbsp;<replaceable>cmd</replaceable></option>
+            to select the program to use as the preprocessor.  When
+            invoked, the <replaceable>cmd</replaceable> pre-processor
+            is given at least three arguments on its command-line: the
+            first argument is the name of the original source file,
+            the second is the name of the file holding the input, and
+            the third is the name of the file where
+            <replaceable>cmd</replaceable> should write its output
+            to.</para>
+
+           <para>Additional arguments to the pre-processor can be
+           passed in using the <option>-optF</option> option. These
+           are fed to <replaceable>cmd</replaceable> on the command
+           line after the three standard input and output
+           arguments.</para>
          </listitem>
        </varlistentry>
       </variablelist>