| 1 | .TH caca-config 1 "2003-11-22" "libcaca" |
|---|
| 2 | .SH NAME |
|---|
| 3 | caca-config \- script to get information about the installed version of libcaca |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B caca-config |
|---|
| 6 | [ --prefix= |
|---|
| 7 | .IR DIR ] |
|---|
| 8 | [ --exec-prefix= |
|---|
| 9 | .IR DIR ] |
|---|
| 10 | [ --version ] [ --libs | --plugin-libs ] [ --cflags ] |
|---|
| 11 | .SH DESCRIPTION |
|---|
| 12 | .B caca-config |
|---|
| 13 | is a tool that is used to configure and determine the compiler and linker |
|---|
| 14 | flags that should be used to compile and link progams, libraries, and |
|---|
| 15 | plugins that use libcaca. |
|---|
| 16 | .SH OPTIONS |
|---|
| 17 | .TP |
|---|
| 18 | .B --cflags |
|---|
| 19 | Print the compiler flags that are necessary to compile a program or library |
|---|
| 20 | that uses libcaca. |
|---|
| 21 | .TP |
|---|
| 22 | .BI --exec-prefix= DIR |
|---|
| 23 | If specified, use |
|---|
| 24 | .I DIR |
|---|
| 25 | instead of the installation exec prefix that libcaca was build with when |
|---|
| 26 | computing the output for the --cflags, --libs, and --plugin-libs options. |
|---|
| 27 | This option must be specified before any of the --cflags, --libs, and |
|---|
| 28 | --plugin-libs options. |
|---|
| 29 | .TP |
|---|
| 30 | .B --libs |
|---|
| 31 | Print the linker flags that are necessary to link a program that uses |
|---|
| 32 | libcaca. |
|---|
| 33 | .TP |
|---|
| 34 | .B --plugin-libs |
|---|
| 35 | Print the linker flags that are necessary to link a libcaca-using object that |
|---|
| 36 | is to be accessed via |
|---|
| 37 | .IR dlopen (3). |
|---|
| 38 | This may include static objects with PIC symbol information. This option |
|---|
| 39 | should |
|---|
| 40 | .B not |
|---|
| 41 | be used for standalone applications. |
|---|
| 42 | .TP |
|---|
| 43 | .BI --prefix= DIR |
|---|
| 44 | If specified, use PREFIX instead of the installation prefix that libcaca |
|---|
| 45 | was built with when computing the output for the --cflags, --libs, |
|---|
| 46 | and --plugin-libs options. This option is also used for the exec prefix |
|---|
| 47 | if --exec-prefix was not specified. This option must be specified before |
|---|
| 48 | any of the --cflags, --libs, and --plugin-libs options. |
|---|
| 49 | .TP |
|---|
| 50 | .B --version |
|---|
| 51 | Prints the currently installed version of libcaca on standard output. |
|---|
| 52 | .SH EXAMPLES |
|---|
| 53 | .TP |
|---|
| 54 | gcc -o main.o $(caca-config --cflags) -c main.c |
|---|
| 55 | is how you might use |
|---|
| 56 | .B caca-config |
|---|
| 57 | to compile a C source file for an executable program. |
|---|
| 58 | .TP |
|---|
| 59 | gcc -o my_app $(caca-config --libs) main.o util.o |
|---|
| 60 | is how you might use |
|---|
| 61 | .B caca-config |
|---|
| 62 | to link compiled objects into an executable program. |
|---|
| 63 | .TP |
|---|
| 64 | gcc -o libcaca_plugin.so $(caca-config --plugin-libs) caca_plugin.o stubs.o |
|---|
| 65 | is how you might use |
|---|
| 66 | .B caca-config |
|---|
| 67 | to link compiled objects into a plugin for use by another program. |
|---|
| 68 | .SH AUTHOR |
|---|
| 69 | The libcaca library was written by Sam Hocevar <sam@zoy.org>. |
|---|
| 70 | .PP |
|---|
| 71 | This manual page was written for sdl-config by Branden Robinson, originally |
|---|
| 72 | for Progeny Linux Systems, Inc., and the Debian Project. It was adapted to |
|---|
| 73 | libcaca by Sam Hocevar. |
|---|
