source: libcaca/trunk/doc/caca-config.1 @ 1016

Last change on this file since 1016 was 208, checked in by Sam Hocevar, 17 years ago
  • debian/: + Wrote the changelog for the Debian release. + Wrote a copyright file.
  • doc/: + Wrote manpages for caca-demo and caca-spritedit.
  • examples/caca.txt: + Centered the sprite handle. + Added a second frame to the sprite.
File size: 2.4 KB
Line 
1.TH caca-config 1 "2003-11-22" "libcaca"
2.SH NAME
3caca-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
13is a tool that is used to configure and determine the compiler and linker
14flags that should be used to compile and link progams, libraries, and
15plugins that use libcaca.
16.SH OPTIONS
17.TP
18.B --cflags
19Print the compiler flags that are necessary to compile a program or library
20that uses libcaca.
21.TP
22.BI --exec-prefix= DIR
23If specified, use
24.I DIR
25instead of the installation exec prefix that libcaca was build with when
26computing the output for the --cflags, --libs, and --plugin-libs options.
27This option must be specified before any of the --cflags, --libs, and
28--plugin-libs options.
29.TP
30.B --libs
31Print the linker flags that are necessary to link a program that uses
32libcaca.
33.TP
34.B --plugin-libs
35Print the linker flags that are necessary to link a libcaca-using object that
36is to be accessed via
37.IR dlopen (3).
38This may include static objects with PIC symbol information.  This option
39should
40.B not
41be used for standalone applications.
42.TP
43.BI --prefix= DIR
44If specified, use PREFIX instead of the installation prefix that libcaca
45was built with when computing the output for the --cflags, --libs,
46and --plugin-libs options.  This option is also used for the exec prefix
47if --exec-prefix was not specified.  This option must be specified before
48any of the --cflags, --libs, and --plugin-libs options.
49.TP
50.B --version
51Prints the currently installed version of libcaca on standard output.
52.SH EXAMPLES
53.TP
54gcc -o main.o $(caca-config --cflags) -c main.c
55is how you might use
56.B caca-config
57to compile a C source file for an executable program.
58.TP
59gcc -o my_app $(caca-config --libs) main.o util.o
60is how you might use
61.B caca-config
62to link compiled objects into an executable program.
63.TP
64gcc -o libcaca_plugin.so $(caca-config --plugin-libs) caca_plugin.o stubs.o
65is how you might use
66.B caca-config
67to link compiled objects into a plugin for use by another program.
68.SH AUTHOR
69The libcaca library was written by Sam Hocevar <sam@zoy.org>.
70.PP
71This manual page was written for sdl-config by Branden Robinson, originally
72for Progeny Linux Systems, Inc., and the Debian Project. It was adapted to
73libcaca by Sam Hocevar.
Note: See TracBrowser for help on using the repository browser.