Current File : //usr/man/man1/orbit2-config.1

'\" te
.TH orbit2-config 1 "11 Jan 2003" "SunOS 5.11" "User Commands"
.SH "NAME"
orbit2-config \- helper script for building with \fBorbit2\fR
.SH "SYNOPSIS"
.PP
\fBorbit2-config\fR [-\fB-help \fR] [-\fB-version\fR] [-\fB-prefix=\fIdir\fR\fR] [-\fB-cflags\fR] [-\fB-libs\fR] [-\fB-exec-prefix=\fIdir\fR\fR] [-\fB-use-service=\fIservice\fR\fR] [\fBclient\fR | \fBserver\fR] 
.SH "DESCRIPTION"
.PP
The \fBorbit2-config\fR tool is used to determine the compiler
and linker flags that should be used to compile and link programs that use
the \fBorbit2\fR library\&.  It is also used internally by the \fB\&.m4\fR macros for GNU autoconf that are included with orbit\&. In
most cases, you will use one (or both) of the options -\fB-cflags\fR
or -\fB-libs\fR, depending on whether you are compiling or linking\&.
.SH "OPTIONS"
.PP
The following options are supported:
.sp
.ne 2
.mk
\fB-\fB-cflags\fR\fR
.in +32n
.rt
Print the compiler flags that are necessary to compile a program
using the specified library\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-libs\fR\fR
.in +32n
.rt
Print the
linker flags that are necessary to link with the specified library\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-exec-prefix=\fIdir\fR\fR\fR
.in +32n
.rt
If specified, use \fB\fIdir \fR\fRinstead
of the installation \fBexec\fR prefix that the library was
built with, when computing the output for the -\fB-cflags\fR and -\fB-libs\fR options\&. This option must be specified before any -\fB-libs\fR or -\fB-cflags\fR options\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-help\fR\fR
.in +32n
.rt
Print a usage
summary\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-prefix=\fIdir\fR\fR\fR
.in +32n
.rt
If specified, use \fB\fIdir\fR\fR
instead of the installation prefix that the library was built with, when computing
the output for the -\fB-cflags\fR and -\fB-libs\fR options\&.
This option must be specified before any -\fB-libs\fR or -\fB-cflags\fR options\&. This option is also used for the \fBexec\fR prefix, if the -\fB-exec-prefix\fR option is not specified\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-use-service=\fIservice\fR\fR\fR
.in +32n
.rt
If specified, provide additional flags (if any) for using
the specified service\&. Known values for \fIservice\fR
are: module CosNaming, interfaces LNameComponent, LName\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-version\fR\fR
.in +32n
.rt
Print
the currently installed version of the library on the standard output\&.
.sp
.sp 1
.in -32n
.SH "OPERANDS"
.PP
The following operands are supported:
.sp
.ne 2
.mk
\fB\fBclient\fR\fR
.in +32n
.rt
Used when compiling an \fBorbit2\fR client\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB\fBserver\fR\fR
.in +32n
.rt
Used when compiling an \fBorbit2\fR server\&.
.sp
.sp 1
.in -32n
.SH "EXAMPLES"
.PP
\fBExample 1: Getting the orbit2 library version\fR
.PP
.PP
.nf
example% \fBorbit2-config --version\fR
.fi
.PP
\fBExample 2: Determining the libraries required to link
with the orbit2 library\fR
.PP
.PP
.nf
example% \fBorbit2-config --libs\fR
.fi
.SH "EXIT STATUS"
.PP
The following exit values are returned:
.sp
.ne 2
.mk
\fB\fB0\fR\fR
.in +9n
.rt
Application exited successfully
.sp
.sp 1
.in -9n
.sp
.ne 2
.mk
\fB\fB>0\fR\fR
.in +9n
.rt
Application
exited with failure
.sp
.sp 1
.in -9n
.SH "FILES"
.PP
The following files are used by this application:
.sp
.ne 2
.mk
\fB\fB/usr/bin/orbit2-config\fR \fR
.in +24n
.rt
Executable for the \fBorbit2\fR helper
script
.sp
.sp 1
.in -24n
.SH "ATTRIBUTES"
.PP
See \fBattributes\fR(5)
for descriptions of the following attributes:
.sp
.TS
tab() allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWgnome-component-devel
Interface stabilityVolatile
.TE
.sp
.SH "SEE ALSO"
.PP
\fBpkg-config\fR(1),
\fBlibORBit-2\fR(1)
\fBattributes\fR(5)
.SH "NOTES"
.PP
This man page was originally written by Chris Waters (xtifr@debian\&.org)
for Debian GNU/Linux\&. Updated by Dick Porter (dick@acm\&.org) and Elliot Lee
(sopwith@redhat\&.com)\&. Updated by Brian Cameron, Sun Microsystems Inc\&., 2003\&.
...\" created by instant / solbook-to-man, Wed 18 Dec 2013, 18:59
...\" LSARC 2001/201 GNOME 2.X on Solaris