<!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) 2003, Sun Microsystems, Inc. 
Copyright (c) 2001, Dick Porter, ACM, and Elliot Lee
 Copyright (c) 2000, Chris Waters, Debian. 
All Rights Reserved.">
<!ENTITY cmd "libart2-config">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
]>
<refentry id="libart2-config-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">10 Jan 2003</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>libart2</filename></primary></indexterm>
<refnamediv id="libart2-config-1-name"><refname>&cmd;</refname>
<refpurpose>helper script for building with <filename>libart2</filename></refpurpose>
</refnamediv>
<refsynopsisdiv id="libart2-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>
</cmdsynopsis></refsynopsisdiv>

<refsect1 id="libart2-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>libart2</filename> library.</para>
</refsect1>

<refsect1 id="libart2-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>
</variablelist>
</refsect1>

<refsect1 id="libart2-config-1-exam"><title>&exam-tt;</title>
<example role="example"><title>Getting the libart2 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 libart2 library</title>
<para><screen>
example% <userinput>&cmd; --libs</userinput>
</screen></para>
</example>
</refsect1>

<refsect1 id="libart2-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="libart2-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>libart2</filename> helper script
</para></listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="libart2-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>SUNWlibart-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="libart2-config-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libart_lgpl_2</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>

<refsect1 id="libart2-config-1-note"><title>&note-tt;</title>
<para>
This man page was originally written by Chris Waters (xtifr@debian.org) for
Debian GNU/Linux. Rewritten by Brian Cameron, Sun Microsystems Inc., using
information from the
<citerefentry><refentrytitle>orbit2-config</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>
man page, by Dick Porter (dick@acm.org) and Elliot Lee (sopwith@redhat.com).
<filename>libart2</filename>&mdash;specific text was written by Christian
Marillat (marillat@debian.org) for Debian GNU/Linux.
</para>
</refsect1>
</refentry>
