orbit2-config.1 revision 10139
10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13625N/A<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc.
10139N/ACopyright (c) 2001, Dick Porter, ACM, and Elliot Lee
10139N/A Copyright (c) 2000, Chris Waters, Debian.
10139N/AAll Rights Reserved.">
10139N/A<!ENTITY cmd "orbit2-config">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<refentry id="orbit2-config-1">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>orbit2-config</refentrytitle><manvolnum>1</manvolnum>
13741N/A<refmiscinfo class="date">11 Jan 2003</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
10139N/A<indexterm><primary>orbit2-config</primary></indexterm><indexterm><primary>
13741N/Ahelper script for building with <filename>orbit2</filename></primary></indexterm>
10139N/A<refnamediv id="orbit2-config-1-name"><refname>orbit2-config</refname><refpurpose>
13741N/Ahelper script for building with <filename>orbit2</filename></refpurpose></refnamediv>
10139N/A<refsynopsisdiv id="orbit2-config-1-synp"><title>&synp-tt;</title>
10139N/A<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>-help </option></arg>
10139N/A<arg choice="opt"><option>-version</option></arg><arg choice="opt"><option>
10139N/A-prefix=<replaceable>dir</replaceable></option></arg><arg choice="opt"><option>
10139N/A-cflags</option></arg><arg choice="opt"><option>-libs</option></arg><arg choice="opt"><option>
10139N/A-exec-prefix=<replaceable>dir</replaceable></option></arg><arg choice="opt"><option>
10139N/A-use-service=<replaceable>service</replaceable></option></arg><group><arg
10139N/Achoice="plain"><option role="nodash">client</option></arg><arg choice="plain"><option
10139N/Arole="nodash">server</option></arg></group>
10139N/A</cmdsynopsis></refsynopsisdiv>
10139N/A<refsect1 id="orbit2-config-1-desc"><title>&desc-tt;</title>
10139N/A<para>The <command>&cmd;</command> tool is used to determine the compiler
10139N/Aand linker flags that should be used to compile and link programs that use
10139N/Athe <filename>orbit2</filename> library. It is also used internally by the <filename>
10139N/A.m4</filename> macros for GNU autoconf that are included with orbit. <?Pub Caret>In
11904N/Amost cases, you will use one (or both) of the options <option>-cflags</option>
10139N/Aor <option>-libs</option>, depending on whether you are compiling or linking.
10139N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="orbit2-config-1-opts"><title>&opts-tt;</title>
10139N/A<para>The following options are supported:</para>
10139N/A<variablelist termlength="wide">
10139N/A<varlistentry><term><option>-cflags</option></term>
10139N/A<listitem><para>Print the compiler flags that are necessary to compile a program
10139N/Ausing the specified library.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-libs</option></term><listitem><para>Print the
10139N/Alinker flags that are necessary to link with the specified library.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-exec-prefix=<replaceable>dir</replaceable></option></term>
10139N/A<listitem><para>If specified, use <filename><replaceable>dir </replaceable></filename>instead
10139N/Aof the installation <filename>exec</filename> prefix that the library was
10139N/Abuilt with, when computing the output for the <option>-cflags</option> and <option>
10139N/A-libs</option> options. This option must be specified before any <option>
10139N/A-libs</option> or <option>-cflags</option> options.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-help</option></term><listitem><para>Print a usage
10139N/Asummary.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-prefix=<replaceable>dir</replaceable></option></term>
10139N/A<listitem><para>If specified, use <filename><replaceable>dir</replaceable></filename>
10139N/Ainstead of the installation prefix that the library was built with, when computing
10139N/Athe output for the <option>-cflags</option> and <option>-libs</option> options.
10139N/AThis option must be specified before any <option>-libs</option> or <option>
10139N/A-cflags</option> options. This option is also used for the <filename>exec
10139N/A</filename> prefix, if the <option>-exec-prefix</option> option is not specified.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-use-service=<replaceable>service</replaceable></option></term>
10139N/A<listitem><para>If specified, provide additional flags (if any) for using
10139N/Athe specified service. Known values for <replaceable>service</replaceable>
10139N/Aare: module CosNaming, interfaces LNameComponent, LName.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>-version</option></term><listitem><para>Print
10139N/Athe currently installed version of the library on the standard output.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="orbit2-config-1-oper"><title>&oper-tt;</title>
10139N/A<para>The following operands are supported:</para>
10139N/A<variablelist termlength="wide"><varlistentry><term><option role="nodash">
10139N/Aclient</option></term><listitem><para>Used when compiling an <filename>orbit2
10139N/A</filename> client.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option role="nodash">server</option></term><listitem>
10139N/A<para>Used when compiling an <filename>orbit2</filename> server.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="orbit2-config-1-exam"><title>&exam-tt;</title>
10139N/A<example role="example"><title>Getting the orbit2 library version</title>
10139N/A<para><screen>example% <userinput>&cmd; --version</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example"><title>Determining the libraries required to link
10139N/Awith the orbit2 library</title>
10139N/A<para><screen>example% <userinput>&cmd; --libs</userinput></screen></para>
10139N/A</example>
10139N/A</refsect1>
10139N/A<refsect1 id="orbit2-config-1-exit"><title>&exit-tt;</title>
10139N/A<para>The following exit values are returned:</para>
10139N/A<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
10139N/A<listitem><para>Application exited successfully</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
10139N/Aexited with failure</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="orbit2-config-1-file"><title>&file-tt;</title>
10139N/A<para>The following files are used by this application:</para>
10139N/A<variablelist termlength="medium"><varlistentry><term><filename>/usr/bin/&cmd;</filename>
10139N/A</term><listitem><para>Executable for the <filename>orbit2</filename> helper
10139N/Ascript</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="orbit2-config-1-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
10139N/A<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-component-devel
10139N/A</para></entry></row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
10139N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="orbit2-config-1-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
10139N/A<para><citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1
11905N/A</manvolnum></citerefentry>, <citerefentry><refentrytitle>libORBit-2</refentrytitle>
11905N/A<manvolnum>1</manvolnum></citerefentry></para>
11905N/A</refsect1>
11905N/A<refsect1 id="orbit2-config-1-note"><title>&note-tt;</title>
11905N/A<para>This man page was originally written by Chris Waters (xtifr@debian.org)
10139N/Afor Debian GNU/Linux. Updated by Dick Porter (dick@acm.org) and Elliot Lee
10139N/A(sopwith@redhat.com). Updated by Brian Cameron, Sun Microsystems, 2003.</para>
10139N/A</refsect1>
10139N/A</refentry>
11933N/A<?Pub *0000008155>
10139N/A