1#!/bin/sh
2##
3##  OSSP uuid - Universally Unique Identifier
4##  Copyright (c) 2004-2008 Ralf S. Engelschall <rse@engelschall.com>
5##  Copyright (c) 2004-2008 The OSSP Project <http://www.ossp.org/>
6##
7##  This file is part of OSSP uuid, a library for the generation
8##  of UUIDs which can found at http://www.ossp.org/pkg/lib/uuid/
9##
10##  Permission to use, copy, modify, and distribute this software for
11##  any purpose with or without fee is hereby granted, provided that
12##  the above copyright notice and this permission notice appear in all
13##  copies.
14##
15##  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
16##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
17##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
19##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26##  SUCH DAMAGE.
27##
28##  uuid-config.pod: library build utility manpage
29##
30
31=pod
32
33=head1 NAME
34
35B<uuid-config> - B<OSSP uuid API build utility>
36
37=head1 VERSION
38
39OSSP uuid UUID_VERSION_STR
40
41=head1 SYNOPSIS
42
43B<uuid-config>
44[B<--help>]
45[B<--version>]
46[B<--all>]
47[B<--prefix>]
48[B<--exec-prefix>]
49[B<--bindir>]
50[B<--libdir>]
51[B<--includedir>]
52[B<--mandir>]
53[B<--datadir>]
54[B<--acdir>]
55[B<--cflags>]
56[B<--ldflags>]
57[B<--libs>]
58
59=head1 DESCRIPTION
60
61The B<uuid-config> program is a little helper utility for easy configuring and
62building applications based on the uuid(3) library.  It can be used to query the
63C compiler and linker flags which are required to correctly compile and link
64the application against the uuid(3) library.
65
66=head1 OPTIONS
67
68B<uuid-config> accepts the following options:
69
70=over 2
71
72=item B<--help>
73
74Prints the short usage information.
75
76=item B<--version>
77
78Prints the version number and date of the installed uuid(3) library.
79
80=item B<--all>
81
82Forces the output of all flags, that is, including extra flags which are not
83B<OSSP uuid> specific.
84
85=item B<--prefix>
86
87Prints the installation prefix of architecture independent files
88
89=item B<--exec-prefix>
90
91Prints the installation prefix of architecture dependent files.
92
93=item B<--bindir>
94
95Prints the installation directory of binaries.
96
97=item B<--libdir>
98
99Prints the installation directory of libraries.
100
101=item B<--includedir>
102
103Prints the installation directory of include headers.
104
105=item B<--mandir>
106
107Prints the installation directory of manual pages.
108
109=item B<--datadir>
110
111Prints the installation directory of shared data.
112
113=item B<--acdir>
114
115Prints the installation directory of B<autoconf> data.
116
117=item B<--cflags>
118
119Prints the C compiler flags which are needed to compile the uuid(3)-based
120application. The output is usually added to the C<CFLAGS> uuidiable of the
121applications C<Makefile>.
122
123=item B<--ldflags>
124
125Prints the linker flags (C<-L>) which are needed to link the application with
126the uuid(3) library. The output is usually added to the C<LDFLAGS> uuidiable of
127the applications C<Makefile>.
128
129=item B<--libs>
130
131Prints the library flags (C<-l>) which are needed to link the application with
132the C uuid(3) library. The output is usually added to the C<LIBS> uuidiable of the
133applications C<Makefile>.
134
135=back
136
137=head1 EXAMPLE
138
139 CC      = cc
140 CFLAGS  = -O `uuid-config --cflags`
141 LDFLAGS = `uuid-config --ldflags`
142 LIBS    = -lm `uuid-config --libs`
143
144 all: foo
145 foo: foo.o
146     $(CC) $(LDFLAGS) -o foo foo.o $(LIBS)
147 foo.o: foo.c
148     $(CC) $(CFLAGS) -c foo.c
149
150=head1 SEE ALSO
151
152uuid(3), uuid(1), OSSP::uuid(3).
153
154=cut
155
156