[project @ 2003-07-21 15:24:42 by simonmar]
[ghc-hetmet.git] / ghc / docs / users_guide / flags.sgml
index 37c9f5d..8dc22af 100644 (file)
              <entry>-</entry>
            </row>
            <row>
-             <entry><option>--version</option></entry>
+             <entry><option>&ndash;&ndash;version</option></entry>
              <entry>display GHC version</entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
            <row>
-             <entry><option>--numeric-version</option></entry>
+             <entry><option>&ndash;&ndash;numeric-version</option></entry>
              <entry>display GHC version (numeric only)</entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
+           <row>
+             <entry><option>&ndash;&ndash;print-libdir</option></entry>
+             <entry>display GHC library directory</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
          </tbody>
        </tgroup>
       </informaltable>
          </thead>
          <tbody>
            <row>
+             <entry><option>-hcsuf</option> <replaceable>suffix</replaceable></entry>
+             <entry>set the suffix to use for intermediate C files</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-hidir</option> <replaceable>dir</replaceable></entry>
+             <entry>set directory for interface files</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-hisuf</option> <replaceable>suffix</replaceable></entry>
              <entry>set the suffix to use for interface files</entry>
              <entry>static</entry>
     </sect2>
 
     <sect2>
-      <title>Finding imports (<xref linkend="options-finding-imports">)</title>
+      <title>Finding imports (<xref linkend="search-path">)</title>
 
       <informaltable>
        <tgroup cols=3 align=left colsep=1 rowsep=1>
          </thead>
          <tbody>
            <row>
-             <entry><option>-ohi</option> <replaceable>file</replaceable></entry>
-             <entry>Put the interface file in <replaceable>file</replaceable></entry>
-             <entry>static</entry>
-             <entry>-</entry>
-           </row>
-           <row>
              <entry><option>-ddump-hi</option></entry>
              <entry>Dump the new interface to stdout</entry>
              <entry>dynamic</entry>
              <entry>dynamic</entry>
              <entry>-</entry>
            </row>
+           <row>
+             <entry><option>-ddump-minimal-imports</option></entry>
+             <entry>Dump a minimal set of imports</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>--show-iface</option> <replaceable>file</replaceable></entry>
+             <entry>Read the interface in
+             <replaceable>file</replaceable> and dump it as text to
+             <literal>stdout</literal>.</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
          </tbody>
        </tgroup>
       </informaltable>
     </sect2>
 
     <sect2>
-      <title>Packages (<xref linkend="packages">)</title>
+      <title>Interactive-mode options (<xref linkend="ghci-dot-files">)</title>
+      
       <informaltable>
        <tgroup cols=3 align=left colsep=1 rowsep=1>
          <thead>
-           <row>
+           <row>
              <entry>Flag</entry>
              <entry>Description</entry>
              <entry>Static/Dynamic</entry>
          </thead>
          <tbody>
            <row>
-             <entry><option>--add-package</option></entry>
-             <entry>Install a new package</entry>
+             <entry><option>-ignore-dot-ghci</option></entry>
+             <entry>Disable reading of <filename>.ghci</filename> files</entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
            <row>
-             <entry><option>--delete-package</option> <replaceable>name</replaceable></entry>
-             <entry>Delete package entry <replaceable>name</replaceable></entry>
+             <entry><option>-read-dot-ghci</option></entry>
+             <entry>Enable reading of <filename>.ghci</filename> files</entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
+         </tbody>
+       </tgroup>
+      </informaltable>
+    </sect2>
+
+    <sect2>
+      <title>Packages (<xref linkend="packages">)</title>
+      <informaltable>
+       <tgroup cols=3 align=left colsep=1 rowsep=1>
+         <thead>
+           <row>
+             <entry>Flag</entry>
+             <entry>Description</entry>
+             <entry>Static/Dynamic</entry>
+             <entry>Reverse</entry>
+           </row>
+         </thead>
+         <tbody>
            <row>
-             <entry><option>--list-packages</option></entry>
-             <entry>List installed packages</entry>
+             <entry><option>-package</option> <replaceable>name</replaceable></entry>
+             <entry>Use package <replaceable>name</replaceable></entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
            <row>
-             <entry><option>-package</option> <replaceable>name</replaceable></entry>
-             <entry>Use package <replaceable>name</replaceable></entry>
+             <entry><option>-package-conf</option> <replaceable>file</replaceable></entry>
+             <entry>Load more packages from <replaceable>file</replaceable></entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
              <entry><option>-fno-glasgow-exts</option></entry>
            </row>
            <row>
+             <entry><option>-ffi</option> or <option>-fffi</option></entry>
+             <entry>Enable foreign function interface (implied by
+             <option>-fglasgow-exts</option>)</entry>
+             <entry>dynamic</entry>
+             <entry><option>-fno-ffi</option></entry>
+           </row>
+           <row>
+             <entry><option>-farrows</option></entry>
+             <entry>Enable arrow notation extension</entry>
+             <entry>dynamic</entry>
+             <entry><option>-fno-arrows</option></entry>
+           </row>
+           <row>
+             <entry><option>-fwith</option></entry>
+             <entry>Enable deprecated <literal>with</literal> keyword</entry>
+             <entry>dynamic</entry>
+             <entry><option>-fno-with</option></entry>
+           </row>
+           <row>
              <entry><option>-fignore-asserts</option></entry>
              <entry>Ignore assertions</entry>
              <entry>dynamic</entry>
            <entry>dynamic</entry>
            <entry><option>-w</option></entry>
          </row>
+         <row>
+           <entry><option>-Werror</option></entry>
+           <entry>make warnings fatal</entry>
+           <entry>dynamic</entry>
+           <entry></entry>
+         </row>
 
          <row>
            <entry><option>-fwarn-deprecations</option></entry>
              <entry>static</entry>
              <entry><option>-O0</option></entry>
            </row>
-           <row>
-             <entry><option>-O2-for-C</option></entry>
-             <entry>Run <command>gcc</command> with <option>-O2</option></entry>
-             <entry>static</entry>
-             <entry>-</entry>
-           </row>
          </tbody>
        </tgroup>
       </informaltable>
          </thead>
          <tbody>
            <row>
-             <entry><option>-fall-strict</option></entry>
-             <entry>Make everything strict</entry>
-             <entry>dynamic</entry>
-             <entry><option>-fno-all-strict</option></entry>
-           </row>
-
-           <row>
              <entry><option>-fcase-merge</option></entry>
              <entry>Enable case-merging</entry>
              <entry>static</entry>
            </row>
 
            <row>
-             <entry><option>-ffoldr-build-on</option></entry>
-             <entry>Enable foldr-build optimisation</entry>
+             <entry><option>-frules-off</option></entry>
+             <entry>Switch off all rewrite rules (including rules
+             generated by automatic specialisation of overloaded functions)</entry>
              <entry>static</entry>
-             <entry><option>-fno-foldr-build-on</option></entry>
+             <entry><option>-frules-off</option></entry>
            </row>
 
            <row>
 
            <row>
              <entry><option>-fliberate-case-threshold</option></entry>
-             <entry>Tweak the liberate-case optimisation</entry>
+             <entry>Tweak the liberate-case optimisation (default: 10)</entry>
              <entry>static</entry>
              <entry><option>-fno-liberate-case-threshold</option></entry>
            </row>
            </row>
 
            <row>
+             <entry><option>-fmax-worker-args</option></entry>
+             <entry>If a worker has that many arguments, none will be
+               unpacked anymore (default: 10)</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+
+           <row>
              <entry><option>-fmax-simplifier-iterations</option></entry>
              <entry>Set the max iterations for the simplifier</entry>
              <entry>static</entry>
              <entry>dynamic</entry>
              <entry>-fasm</entry>
            </row>
+           <row>
+             <entry><option>-fno-code</option></entry>
+             <entry>Omit code generation</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
          </tbody>
        </tgroup>
       </informaltable>
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-no-link</option></entry>
+             <entry>Omit linking</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-package</option> <replaceable>name</replaceable></entry>
              <entry>Link in package <replaceable>name</replaceable></entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-framework</option> <replaceable>name</replaceable></entry>
+             <entry>On Darwin/MacOS X only, link in the framework <replaceable>name</replaceable>.
+               This option corresponds to the <option>-framework</option> option for Apple's Linker.</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-framework-path</option> <replaceable>name</replaceable></entry>
+             <entry>On Darwin/MacOS X only, add <replaceable>dir</replaceable> to the list of
+               directories searched for frameworks.
+               This option corresponds to the <option>-F</option> option for Apple's Linker.</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-split-objs</option></entry>
              <entry>Split objects (for libraries)</entry>
              <entry>static</entry>
              <entry>static</entry>
              <entry>-</entry>
            </row>
+           <row>
+             <entry><option>-pgmF</option> <replaceable>cmd</replaceable></entry>
+             <entry>Use <replaceable>cmd</replaceable> as the pre-processor
+             (with <option>-F</option> only)</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
          </tbody>
        </tgroup>
       </informaltable>
       <indexterm><primary><option>-pgml</option></primary></indexterm>
       <indexterm><primary><option>-pgmdll</option></primary></indexterm>
       <indexterm><primary><option>-pgmdep</option></primary></indexterm>
+      <indexterm><primary><option>-pgmF</option></primary></indexterm>
 
     </sect2>
 
       </informaltable>
     </sect2>
 
+         
+    <sect2>
+      <title>External core file options (<xref linkend="ext-core">)</title>
+
+      <informaltable>
+       <tgroup cols=3 align=left colsep=1 rowsep=1>
+         <thead>
+           <row>
+             <entry>Flag</entry>
+             <entry>Description</entry>
+             <entry>Static/Dynamic</entry>
+             <entry>Reverse</entry>
+           </row>
+         </thead>
+         <tbody>
+           <row>
+             <entry><option>-fext-core</option></entry>
+             <entry>Generate <filename>.hcr</filename> external Core files</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+         </tbody>
+       </tgroup>
+      </informaltable>
+    </sect2>
+       
+
     <sect2>
       <title>Compiler debugging options (<xref linkend="options-debugging">)</title>