<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc.

All Rights Reserved.">

<!ENTITY cmd "libgcrypt-config">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="libgcrypt-config-1">

<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">10 Jan 2008</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>

helper script for building with <filename>libgcrypt</filename></primary></indexterm>

<refnamediv id="libgcrypt-config-1-name"><refname>&cmd;</refname><refpurpose>

helper script for building with <filename>libgcrypt</filename></refpurpose>

</refnamediv>

<refsynopsisdiv id="libgcrypt-config-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>-version</option></arg>

<arg choice="opt"><option>-prefix=<replaceable>dir</replaceable></option></arg>

<arg choice="opt"><option>-cflags</option></arg><arg choice="opt"><option>

-libs</option></arg><arg choice="opt"><option>-exec-prefix=<replaceable>dir

</replaceable></option></arg>

<arg choice="opt"><option>-api-version</option></arg>

<arg choice="opt"><option>-algorithms</option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="libgcrypt-config-1-desc"><title>&desc-tt;</title>

<para>The <command>&cmd;</command> tool is used to determine the compiler

and linker flags that should be used to compile and link programs that use

the <filename>libgcrypt</filename> library.</para>

</refsect1>

<refsect1 id="libgcrypt-config-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="medium"><varlistentry><term><option>-cflags</option></term>

<listitem><para>Print the compiler flags that are necessary to compile a program

using the specified library.</para>

</listitem></varlistentry>

<varlistentry><term><option>-exec-prefix=<replaceable>dir</replaceable></option></term>

<listitem><para>If specified, use <replaceable>dir</replaceable> instead of

the <literal>exec</literal> installation prefix that the library was built

with, when computing the output for the <option>-cflags</option> and <option>

-libs</option> options. This option must be specified before any <option>

-libs</option> or <option>-cflags</option> options.</para>

</listitem></varlistentry>

<varlistentry><term><option>-libs</option></term><listitem><para>Print the

linker flags that are necessary to link with the specified library.</para>

</listitem></varlistentry>

<varlistentry><term><option>-prefix=<replaceable>dir</replaceable></option></term>

<listitem><para>If specified, use <replaceable>dir</replaceable> instead of

the installation prefix that the library was built with, when computing the

output for the <option>-cflags</option> and <option>-libs</option> options.

This option must be specified before any <option>-libs</option> or <option>

-cflags</option> options. This option is also used for the <literal>exec</literal>

prefix if the <option>-exec-prefix</option> option is not specified.

</para>

</listitem></varlistentry>

<varlistentry><term><option>-version</option></term><listitem><para>Print

the currently installed version of the library on the standard output.</para>

</listitem></varlistentry>

<varlistentry><term><option>-api-version</option></term><listitem><para>Print

the currently installed version of the api on the standard output.</para>

</listitem></varlistentry>

<varlistentry><term><option>-algorithms</option></term><listitem><para>Print

the currently installed algorithms the library contains on the standard output.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="libgcrypt-config-1-exam"><title>&exam-tt;</title>

<example role="example"><title>Getting the libgcrypt library version</title>

<para><screen>example% <userinput>&cmd; --version</userinput></screen></para>

</example>

<example role="example"><title>Determining the libraries required to link

with the libgcrypt library</title>

<para><screen>example% <userinput>&cmd; --libs</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="libgcrypt-config-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>

<listitem><para>Application exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="libgcrypt-config-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="wide"><varlistentry><term><filename>/usr/bin/&cmd;</filename>

</term><listitem><para>Executable for <filename>libgcrypt</filename> helper

script</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="libgcrypt-config-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>SUNWlibgcrypt-devel

</para></entry></row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="libgcrypt-config-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>libgcrypt</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

<refsect1>

<para>

Written by Jeff Cai, Sun Microsystems Inc., 2008.

</para>

</refsect1>

</refsect1>

</refentry>