Update the changelog
[opencv] / debian / opencv-config.1
1 .TH opencv-config 1 "2004-04-22" "OpenCV"
2 .SH NAME
3 opencv-config \- script to get information about the installed version of OpenCV
4 .SH SYNOPSIS
5 .B opencv-config
6 [ --prefix=
7 .IR DIR ]
8 [ --version ] [ --libs [<extensions>]] [ --cflags | --cxxflags ]
9 .SH DESCRIPTION
10 .B opencv-config
11 is a tool that is used to configure and determine the compiler and linker
12 flags that should be used to compile and link progams, libraries, and
13 plugins that use OpenCV.
14 .SH OPTIONS
15 .TP
16 .B --cflags
17 Print the C compiler flags that are necessary to compile a program or library
18 that uses OpenCV.
19 .TP
20 .B --cxxflags
21 Print the C++ compiler flags that are necessary to compile a program or library
22 that uses OpenCV.
23 .TP
24 .B --libs [<extensions>]
25 Print the linker flags that are necessary to link a program that uses
26 libcv. Optionally, add linker flags for the libhighgui, libcvcam and/or
27 libcvaux OpenCV extensions by appending highgui, cvcam and/or cvaux.
28 .TP
29 .BI --prefix= DIR
30 If specified, use PREFIX instead of the installation prefix that libcv
31 was built with when computing the output for the --cflags, --cxxflags and
32 --libs options. This option must be specified before any of the --cflags,
33 --cxxflags and --libs options.
34 .TP
35 .B --version
36 Prints the currently installed version of libcv on standard output.
37 .SH EXAMPLES
38 .TP
39 gcc -o main.o $(opencv-config --cflags) -c main.c
40 is how you might use
41 .B opencv-config
42 to compile a C source file for an executable program.
43 .TP
44 gcc -o my_app $(opencv-config --libs) main.o util.o
45 is how you might use
46 .B opencv-config
47 to link compiled objects into an executable program.
48 .SH AUTHOR
49 This manual page was written for sdl-config by Branden Robinson, originally
50 for Progeny Linux Systems, Inc., and the Debian Project. It was adapted to
51 libcv by Sam Hocevar.