docs/108863: enhance porters handbook by USE_XFCE

[Oliver Lehmann]

>Number:         108863
>Category:       docs
>Synopsis:       enhance porters handbook by USE_XFCE
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          update
>Submitter-Id:   current-users
>Arrival-Date:   Wed Feb 07 05:40:17 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Oliver Lehmann
>Release:        FreeBSD 6.2-PRERELEASE amd64
>Organization:
>Environment:
System: FreeBSD kartoffel.salatschuessel.net 6.2-PRERELEASE FreeBSD 6.2-PRERELEASE #0: Tue Dec 19 12:46:15 CET 2006 olivleh1 at kartoffel.salatschuessel.net:/usr/obj/amd64-athlon64-6.1/usr/src/sys/KARTOFFEL amd64


>Description:
	enhance the porters handbook by adding a "Using Xfce" section
	please consider moving bsd.xfce.mk at first to Mk/ as described
	in the previous PR first
>How-To-Repeat:
>Fix:

--- book.sgml.diff begins here ---
Index: book.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.796
diff -u -r1.796 book.sgml
--- book.sgml	5 Feb 2007 01:33:20 -0000	1.796
+++ book.sgml	7 Feb 2007 05:28:19 -0000
@@ -3434,8 +3434,10 @@
 	    and PEAR modules.  <application>Python</application> is discussed
 	    in <xref linkend="using-python">, while
 	    <application>Ruby</application> in <xref linkend="using-ruby">.
-	    Finally, <xref linkend="using-sdl"> provides variables used for
-	    <application>SDL</application> applications.</para>
+	    <xref linkend="using-sdl"> provides variables used for
+	    <application>SDL</application> applications and finally,
+	    <xref linkend="using-xfce"> contains information on
+	    <application>Xfce</application>.</para>
 
 	</sect2>
 
@@ -7466,6 +7468,77 @@
       </sect2>
     </sect1>
 
+    <sect1 id="using-xfce">
+      <title>Using Xfce</title>
+
+      <para>The <makevar>USE_XFCE</makevar> variable is used to autoconfigure
+	the dependencies for ports which use an Xfce based library or application
+	like
+	<filename role="package">x11-toolkits/libxfce4gui</filename> and
+	<filename role="package">x11-wm/xfce4-panel</filename>.</para>
+
+      <para>The following Xfce libraries and applications are recognized at
+	the moment:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para>libexo: <filename role="package">x11/libexo</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>libgui: <filename role="package">x11-toolkits/libxfce4gui</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>libutil: <filename role="package">x11/libxfce4util</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>libmcs: <filename role="package">x11/libxfce4mcs</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>mcsmanager: <filename role="package">sysutils/xfce4-mcs-manager</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>panel: <filename role="package">x11-wm/xfce4-panel</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>thunar: <filename role="package">x11-fm/thunar</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>wm: <filename role="package">xfce4-wm</filename></para>
+	</listitem>
+
+	<listitem>
+	  <para>xfdev: <filename role="package">dev/xfce4-dev-tools</filename></para>
+	</listitem>
+
+      </itemizedlist>
+
+      <para>The following additional parameters are recognized:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para>configenv: Use this if your port requires a special modified
+	    <makevar>CONFIGURE_ENV</makevar> to find it's required libraries.
+	    <programlisting>-I${LOCALBASE}/include -L${LOCALBASE}/lib</programlisting>
+	    gets added to CPPFLAGS to <makevar>CONFIGURE_ENV</makevar>.
+	</listitem>
+
+      </itemizedlist>
+
+      <para>Therefore, if a port has a dependency on
+	<filename role="package">sysutils/xfce4-mcs-manager</filename> and
+	requires the special CPPFLAGS in its configure environment,
+	the syntax will be:</para>
+
+      <programlisting>USE_XFCE=        mcsmanager configenv</programlisting>
+    </sect1>
+
     <sect1 id="rc-scripts">
       <title>Starting and stopping services (rc scripts)</title>
 
--- book.sgml.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: