openpkg/rpm-config.pod

Fri, 15 Oct 2010 19:06:09 +0200

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 15 Oct 2010 19:06:09 +0200
changeset 263
f4a0b439d0fb
child 428
f880f219c566
permissions
-rw-r--r--

Correct shared library and plugin link logic, as well as informal text.
Update file server URL, update build resource estimations, correct RPATH
logic, allow for qmake(1) static to shared library changes via CONFIG
argument, correct documentation broken title and index links, correct
shared library install path, install only one set of (correct) plugins,
install the designer shared library (as required by QtCreator), announce
features related to shared linking using qmake(1), and correclty
substitute hard coded paths in prl and la library files.

michael@13 1 ##
michael@13 2 ## rpm-config -- OpenPKG RPM Library Build Utility
michael@13 3 ## Copyright (c) 2000-2007 OpenPKG Foundation e.V. <http://openpkg.net/>
michael@13 4 ## Copyright (c) 2000-2007 Ralf S. Engelschall <http://engelschall.com/>
michael@13 5 ##
michael@13 6 ## Permission to use, copy, modify, and distribute this software for
michael@13 7 ## any purpose with or without fee is hereby granted, provided that
michael@13 8 ## the above copyright notice and this permission notice appear in all
michael@13 9 ## copies.
michael@13 10 ##
michael@13 11 ## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
michael@13 12 ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
michael@13 13 ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
michael@13 14 ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
michael@13 15 ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@13 16 ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@13 17 ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
michael@13 18 ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
michael@13 19 ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
michael@13 20 ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
michael@13 21 ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
michael@13 22 ## SUCH DAMAGE.
michael@13 23 ##
michael@13 24 ## rpm-config.pod: manual page
michael@13 25 ##
michael@13 26
michael@13 27 =pod
michael@13 28
michael@13 29 =head1 NAME
michael@13 30
michael@13 31 B<rpm-config> - OpenPKG RPM library build utility
michael@13 32
michael@13 33 =head1 VERSION
michael@13 34
michael@13 35 OpenPKG RPM RPM_VERSION
michael@13 36
michael@13 37 =head1 SYNOPSIS
michael@13 38
michael@13 39 B<rpm-config>
michael@13 40 [B<--help>]
michael@13 41 [B<--version>]
michael@13 42 [B<--cc>]
michael@13 43 [B<--cppflags>]
michael@13 44 [B<--cflags>]
michael@13 45 [B<--ldflags>]
michael@13 46 [B<--libs>]
michael@13 47
michael@13 48 =head1 DESCRIPTION
michael@13 49
michael@13 50 The B<rpm-config> program is a little helper utility for easy
michael@13 51 configuring and building applications based on the OpenPKG RPM library.
michael@13 52 It can be used to query the C compiler and linker flags which are
michael@13 53 required to correctly compile and link the application against the
michael@13 54 RPM library.
michael@13 55
michael@13 56 =head1 OPTIONS
michael@13 57
michael@13 58 B<rpm-config> accepts the following options:
michael@13 59
michael@13 60 =over 4
michael@13 61
michael@13 62 =item B<--help>
michael@13 63
michael@13 64 Prints the short usage information.
michael@13 65
michael@13 66 =item B<--version>
michael@13 67
michael@13 68 Prints the version number and date of the installed RPM library.
michael@13 69
michael@13 70 =item B<--cc>
michael@13 71
michael@13 72 =item B<--cppflags>
michael@13 73
michael@13 74 Prints the C pre-processor flags (C<-I>) which are needed to compile the
michael@13 75 RPM-based application. The output is usually added to the C<CPPFLAGS>
michael@13 76 variable of the applications C<Makefile>.
michael@13 77
michael@13 78 =item B<--cflags>
michael@13 79
michael@13 80 Prints the C compiler flags which are needed to compile the RPM-based
michael@13 81 application. The output is usually added to the C<CFLAGS> variable of the
michael@13 82 applications C<Makefile>.
michael@13 83
michael@13 84 =item B<--ldflags>
michael@13 85
michael@13 86 Prints the linker flags (C<-L>) which are needed to link the application with
michael@13 87 the RPM library. The output is usually added to the C<LDFLAGS> variable of
michael@13 88 the applications C<Makefile>.
michael@13 89
michael@13 90 =item B<--libs>
michael@13 91
michael@13 92 Prints the library flags (C<-l>) which are needed to link the application with
michael@13 93 the RPM library. The output is usually added to the C<LIBS> variable of the
michael@13 94 applications C<Makefile>.
michael@13 95
michael@13 96 =back
michael@13 97
michael@13 98 =head1 EXAMPLE
michael@13 99
michael@13 100 CC = `rpm-config --cc`
michael@13 101 CPPFLAGS = `rpm-config --cppflags`
michael@13 102 CFLAGS = `rpm-config --cflags`
michael@13 103 LDFLAGS = `rpm-config --ldflags`
michael@13 104 LIBS = `rpm-config --libs`
michael@13 105
michael@13 106 all: foo
michael@13 107
michael@13 108 foo: foo.o
michael@13 109 $(CC) $(LDFLAGS) -o foo foo.o $(LIBS)
michael@13 110
michael@13 111 foo.o: foo.c
michael@13 112 $(CC) $(CPPFLAGS) $(CFLAGS) -o foo.o -c foo.c
michael@13 113
michael@13 114 =head1 SEE ALSO
michael@13 115
michael@13 116 rpm(1), cc(1).
michael@13 117
michael@13 118 =head1 AUTHOR
michael@13 119
michael@13 120 Ralf S. Engelschall
michael@13 121 rse@engelschall.com
michael@13 122 www.engelschall.com
michael@13 123
michael@13 124 =cut
michael@13 125

mercurial