<sect2 id="using-cmake">

	<title>Using <command>cmake</command></title>

	<para>If your port uses <application>CMake</application>,

	  define <literal>USES= cmake[:outsource]</literal>.</para>

	<table frame="none">

	  <title>Variables for Ports That Use

	    <command>cmake</command></title>

	  <tgroup cols="2">

	    <thead>

	      <row>

		<entry>Variable</entry>

		<entry>Means</entry>

	      </row>

	    </thead>

	    <tbody>

	      <row>

		<entry><makevar>CMAKE_ARGS</makevar></entry>

		<entry>Port specific <application>CMake</application> flags

		  to be passed to the <command>cmake</command> binary.

		</entry>

	      </row>

	      <row>

		<entry><makevar>CMAKE_BUILD_TYPE</makevar></entry>

		<entry>Type of build (<application>CMake</application>

		  predefined build profiles). Default is

		  <literal>Release</literal> if <makevar>WITH_DEBUG</makevar>

		  is not set, otherwise <literal>Debug</literal>.

		</entry>

	      </row>

	      <row>

		<entry><makevar>CMAKE_ENV</makevar></entry>

		<entry>Environment variables to be set for

		  <command>cmake</command> binary. Default is

		  <literal>&dollar;{CONFIGURE_ENV}</literal>.

		</entry>

	      </row>

	      <row>

		<entry><makevar>CMAKE_SOURCE_PATH</makevar></entry>

		<entry>Path to the source directory. Default is

		  <literal>&dollar;{WRKSRC}</literal>.

		</entry>

	      </row>

	    </tbody>

	  </tgroup>

	</table>

	<para>

	  <application>CMake</application> supports the following build 

	  profiles: <literal>Debug</literal>, <literal>Release</literal>,

	  <literal>RelWithDebInfo</literal> and <literal>MinSizeRel</literal>.

	  <literal>Debug</literal> and <literal>Release</literal> profiles

	  respect system <literal>*FLAGS</literal>,

	  <literal>RelWithDebInfo</literal> and <literal>MinSizeRel</literal>

	  will set <makevar>CFLAGS</makevar> to "-O2 -g" and "-Os -DNDEBUG"

	  correspondingly. The lower-cased value of

	  <makevar>CMAKE_BUILD_TYPE</makevar> is exported to the

	  <makevar>PLIST_SUB</makevar> and should be used if port installs 

	  <literal>*.cmake</literal> files depending on the build type (see

	  <filename role="package">deskutils/strigi</filename> for example).

	  Please note that some projects may define their own build profiles

	  and/or force particular build type by setting

	  <literal>CMAKE_BUILD_TYPE</literal> in <filename>CMakeLists.txt

	  </filename> files. In order to make port for such project respect

	  <makevar>CFLAGS</makevar> and <makevar>WITH_DEBUG</makevar> the

	  <literal>CMAKE_BUILD_TYPE</literal> definitions must be removed

	  from those files.

	</para>

	<para>Most <application>CMake</application> based projects support

	  out-of-source way of buildling. The ouf-of-source build for a port

	  can be requested by using <literal>:outsource</literal> suffix. In

	  this case <makevar>CONFIGURE_WRKSRC</makevar>,

	  <makevar>BUILD_WRKSRC</makevar> and <makevar>INSTALL_WRKSRC</makevar>

	  will be set to <literal>&dollar;{WRKDIR}/.build</literal> and this

	  directory will be used to keep all files generated during

	  configuration and build stages, leaving the source directory intact.

	</para>

	<example id="using-cmake-example">

	  <title><literal>USES= cmake</literal> example</title>

	  <para>

	    The following snippet demonstrates the use of

	    <application>CMake</application> for a port.

	    <makevar>CMAKE_SOURCE_PATH</makevar> is not usually required, but

	    can be set when the sources are not located in the top directory,

	    or if only a subset of the project is intended to be built by the

	    port.

	  </para>

	  <programlisting>USES=			cmake:outsource

CMAKE_SOURCE_PATH=	&dollar;{WRKSRC}/subproject</programlisting>

	</example>

      </sect2>

  <entry><literal>cmake</literal></entry>

  <entry>none, <literal>outsource</literal></entry>

  <entry>The port will use <application>CMake</application> for configuring

    and building. With <literal>outsource</literal> argument the

    out-of-source build will be performed. For more information see

    <xref linkend="using-cmake"/>.

  </entry>

</row>

<row>