[project @ 2002-06-15 20:23:12 by wolfgang]

Documentation for Darwin/MacOS X-Specific options/packacke.conf entries
(-framework, -framework-path; framework_dirs, extra_frameworks)

diff --git a/ghc/docs/users_guide/flags.sgml b/ghc/docs/users_guide/flags.sgml
index cf76694..8514c48 100644 (file)
--- a/ghc/docs/users_guide/flags.sgml
+++ b/ghc/docs/users_guide/flags.sgml
@@ -1092,6 +1092,21 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-framework</option> <replaceable>name</replaceable></endtry>
+             <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>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-framework-path</option> <replaceable>name</replaceable></endtry>
+             <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>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-split-objs</option></entry>
              <entry>Split objects (for libraries)</entry>
              <entry>static</entry>

diff --git a/ghc/docs/users_guide/packages.sgml b/ghc/docs/users_guide/packages.sgml
index a014b3f..b778a50 100644 (file)
--- a/ghc/docs/users_guide/packages.sgml
+++ b/ghc/docs/users_guide/packages.sgml
@@ -527,6 +527,28 @@
            (for linking) when this package is being used.</para>
          </listitem>
        </varlistentry>
+       
+       <varlistentry>
+         <term><literal>framework_dirs</literal></term>
+         <indexterm><primary><literal>framework_dirs</literal></primary>
+           <secondary>package specification</secondary></indexterm>
+         <listitem>
+           <para>On Darwin/MacOS X, a list of directories containing frameworks for this
+           package. This corresponds to the <option>-framework-path</options> option.
+           It is ignored on all other platforms.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term><literal>extra_frameworks</literal></term>
+         <indexterm><primary><literal>extra_frameworks</literal></primary>
+           <secondary>package specification</secondary></indexterm>
+         <listitem>
+           <para>On Darwin/MacOS X, a list of frameworks to link to. This corresponds to the
+           <option>-framework</option> option. Take a look at Apple's developer documentation
+           to find out what frameworks actually are. This entry is ignored on all other platforms.</para>
+         </listitem>
+       </varlistentry>
       </variablelist>
       
       <para>

diff --git a/ghc/docs/users_guide/phases.sgml b/ghc/docs/users_guide/phases.sgml
index 043a451..b3f4883 100644 (file)
--- a/ghc/docs/users_guide/phases.sgml
+++ b/ghc/docs/users_guide/phases.sgml
@@ -475,6 +475,20 @@ strmod = "\
        </varlistentry>
 
        <varlistentry>
+         <term><option>-framework</option> <replaceable>name</replaceable></term>
+         <indexterm><primary><option>-framework</option></primary></indexterm>
+         <listitem>
+           <para>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.
+           Please note that frameworks and packages are two different things - frameworks don't
+           contain any haskell code. Rather, they are Apple's way of packaging shared libraries.
+           To link to Apple's &ldquo;Carbon&qdquo; API, for example, you'd use
+           <option>-framework Carbon</option>.
+           </para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term><option>-L</option><replaceable>dir</replaceable></term>
          <indexterm><primary><option>-L</option></primary></indexterm>
          <listitem>
@@ -485,6 +499,16 @@ strmod = "\
        </varlistentry>
 
        <varlistentry>
+         <term><option>-framework-path</option><replaceable>dir</replaceable></term>
+         <indexterm><primary><option>-framework-path</option></primary></indexterm>
+         <listitem>
+           <para>On Darwin/MacOS X only, prepend the directory <replaceable>dir</replaceable> to
+            the framework directories path. This option corresponds to the <option>-F</option>
+           option for Apple's Linker (<option>-F</option> already means something else for GHC).</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term><option>-split-objs</option></term>
          <indexterm><primary><option>-split-objs</option></primary></indexterm>
          <listitem>