From 873ae3cb0031d6e402ce253e81662def33e81b09 Mon Sep 17 00:00:00 2001
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Tue, 17 Jun 2014 15:00:58 +0000
Subject: [PATCH] Document the new Uses/gssapi.mk

Sponsored by:	Absolight
---
 .../books/porters-handbook/uses.xml           | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)

diff --git a/en_US.ISO8859-1/books/porters-handbook/uses.xml b/en_US.ISO8859-1/books/porters-handbook/uses.xml
index b07de8563d..238d7ccaa3 100644
--- a/en_US.ISO8859-1/books/porters-handbook/uses.xml
+++ b/en_US.ISO8859-1/books/porters-handbook/uses.xml
@@ -267,6 +267,71 @@
     for the build.</entry>
 </row>
 
+<row xml:id="uses-gssapi">
+  <entry><literal>gssapi</literal></entry>
+
+  <entry>(none), <literal>base</literal> (default),
+    <literal>heimdal</literal>, <literal>mit</literal>,
+    <literal>flags</literal>, <literal>bootstrap</literal></entry>
+
+  <entry>
+    <para>Handle dependency on <application>Kerberos</application>
+      ports.  By default, or set to <literal>base</literal>,
+      <application>Kerberos</application> from the base system is
+      used.  Set to <literal>heimdal</literal> to use <package
+	role="port">security/heimdal</package>, or
+      <literal>mit</literal> to use <package
+	role="port">security/krb5</package>.</para>
+
+    <para>When the local <application>Kerberos</application>
+      installation is not in <varname>LOCALBASE</varname>, set
+      <varname>HEIMDAL_HOME</varname> (for <literal>heimdal</literal>)
+      or <varname>KRB5_HOME</varname> (for <literal>krb5</literal>) to
+      the base <application>Kerberos</application> directory.</para>
+
+    <para>These variables are exported for the ports to use:</para>
+
+    <itemizedlist>
+      <listitem><para><varname>GSSAPIBASEDIR</varname></para></listitem>
+      <listitem><para><varname>GSSAPICPPFLAGS</varname></para></listitem>
+      <listitem><para><varname>GSSAPIINCDIR</varname></para></listitem>
+      <listitem><para><varname>GSSAPILDFLAGS</varname></para></listitem>
+      <listitem><para><varname>GSSAPILIBDIR</varname></para></listitem>
+      <listitem><para><varname>GSSAPILIBS</varname></para></listitem>
+      <listitem><para><varname>GSSAPI_CONFIGURE_ARGS</varname></para></listitem>
+    </itemizedlist>
+
+    <para>The <literal>flags</literal> option can be set with
+      <literal>base</literal>, <literal>heimdal</literal>, or
+      <literal>mit</literal> to automatically add
+      <varname>GSSAPICPPFLAGS</varname>,
+      <varname>GSSAPILDFLAGS</varname>, and
+      <varname>GSSAPILIBS</varname> to <varname>CFLAGS</varname>,
+      <varname>LDFLAGS</varname>, and <varname>LDADD</varname>,
+      respectively.  For example, use
+      <literal>base,flags</literal>.</para>
+
+    <para>The <literal>bootstrap</literal> option is a special prefix
+      only for use with <package role="port">security/krb5</package>
+      and <package role="port">security/heimdal</package>.  For
+      example, use <literal>bootstrap,mit</literal>.</para>
+
+    <example>
+      <title>Typical Use</title>
+
+      <programlisting>OPTIONS_SINGLE=	GSSAPI
+OPTIONS_SINGLE_GSSAPI=	GSSAPI_BASE GSSAPI_HEIMDAL GSSAPI_MIT GSSAPI_NONE
+
+GSSAPI_BASE_USES=	gssapi
+GSSAPI_BASE_CONFIGURE_ON=	--with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
+GSSAPI_HEIMDAL_USES=	gssapi:heimdal
+GSSAPI_HEIMDAL_CONFIGURE_ON=	--with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
+GSSAPI_MIT_USES=	gssapi:mit
+GSSAPI_MIT_CONFIGURE_ON=	--with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
+GSSAPI_NONE_CONFIGURE_ON=	--without-gssapi</programlisting>
+    </example></entry>
+</row>
+
 <row xml:id="uses-iconv">
   <entry><literal>iconv</literal></entry>