openpkg/rpm-config.pod

Fri, 07 Sep 2012 19:08:07 +0200

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 07 Sep 2012 19:08:07 +0200
changeset 667
9dacbd1d1aa2
parent 13
cb59d6afeb61
permissions
-rw-r--r--

Correct build configuration in Solaris subdir, correct english grammar,
remove irrelevant strip notice, introduce custom CFLAG logic, facilitate
use of Solaris Studio compiler with needed build configuration
adjustments, conditionally build 64 bit position independent code,
and accommodate tun(7) in newer Solaris releases by renaming driver
and module from conflicting 'tun' to 'vtun'. These changes include
some nonstandard 'I give up' logic causing out of tree builds by
manipulating the PATH, for example.

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

mercurial