libcaca/doc/caca-config.1

.TH caca-config 1 "2003-11-22" "libcaca"
.SH NAME
caca-config \- script to get information about the installed version of libcaca
.SH SYNOPSIS
.B caca-config
[ --prefix=
.IR DIR ]
[ --exec-prefix=
.IR DIR ]
[ --version ] [ --libs | --plugin-libs ] [ --cflags ]
.SH DESCRIPTION
.B caca-config
is a tool that is used to configure and determine the compiler and linker
flags that should be used to compile and link progams, libraries, and
plugins that use libcaca.
.SH OPTIONS
.TP
.B --cflags
Print the compiler flags that are necessary to compile a program or library
that uses libcaca.
.TP
.BI --exec-prefix= DIR
If specified, use
.I DIR
instead of the installation exec prefix that libcaca was build with when
computing the output for the --cflags, --libs, and --plugin-libs options.
This option must be specified before any of the --cflags, --libs, and
--plugin-libs options.
.TP
.B --libs
Print the linker flags that are necessary to link a program that uses
libcaca.
.TP
.B --plugin-libs
Print the linker flags that are necessary to link a libcaca-using object that
is to be accessed via
.IR dlopen (3).
This may include static objects with PIC symbol information.  This option
should
.B not
be used for standalone applications.
.TP
.BI --prefix= DIR
If specified, use PREFIX instead of the installation prefix that libcaca
was built with when computing the output for the --cflags, --libs,
and --plugin-libs options.  This option is also used for the exec prefix
if --exec-prefix was not specified.  This option must be specified before
any of the --cflags, --libs, and --plugin-libs options.
.TP
.B --version
Prints the currently installed version of libcaca on standard output.
.SH EXAMPLES
.TP
gcc -o main.o $(caca-config --cflags) -c main.c
is how you might use
.B caca-config
to compile a C source file for an executable program.
.TP
gcc -o my_app $(caca-config --libs) main.o util.o
is how you might use
.B caca-config
to link compiled objects into an executable program.
.TP
gcc -o libcaca_plugin.so $(caca-config --plugin-libs) caca_plugin.o stubs.o
is how you might use
.B caca-config
to link compiled objects into a plugin for use by another program.
.SH AUTHOR
The libcaca library was written by Sam Hocevar <sam@zoy.org>.
.PP
This manual page was written for sdl-config by Branden Robinson, originally
for Progeny Linux Systems, Inc., and the Debian Project. It was adapted to
libcaca by Sam Hocevar.