pth-config.pod

   1 ##
   2 ##  GNU Pth - The GNU Portable Threads
   3 ##  Copyright (c) 1999-2006 Ralf S. Engelschall <rse@engelschall.com>
   4 ##
   5 ##  This file is part of GNU Pth, a non-preemptive thread scheduling
   6 ##  library which can be found at http://www.gnu.org/software/pth/.
   7 ##
   8 ##  This library is free software; you can redistribute it and/or
   9 ##  modify it under the terms of the GNU Lesser General Public
  10 ##  License as published by the Free Software Foundation; either
  11 ##  version 2.1 of the License, or (at your option) any later version.
  12 ##
  13 ##  This library is distributed in the hope that it will be useful,
  14 ##  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 ##  Lesser General Public License for more details.
  17 ##
  18 ##  You should have received a copy of the GNU Lesser General Public
  19 ##  License along with this library; if not, write to the Free Software
  20 ##  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 ##  USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
  22 ##
  23 ##  pth-config.pod: Pth library build utility manual page
  24 ##
  25
  26 =pod
  27
  28 =head1 NAME
  29
  30 B<pth-config> - Pth library build utility
  31
  32 =head1 VERSION
  33
  34 GNU Pth PTH_VERSION_STR
  35
  36 =head1 SYNOPSIS
  37
  38 B<pth-config>
  39 [B<--help>]
  40 [B<--version>]
  41 [B<--all>]
  42 [B<--prefix>]
  43 [B<--exec-prefix>]
  44 [B<--bindir>]
  45 [B<--libdir>]
  46 [B<--includedir>]
  47 [B<--mandir>]
  48 [B<--datadir>]
  49 [B<--acdir>]
  50 [B<--cflags>]
  51 [B<--ldflags>]
  52 [B<--libs>]
  53
  54 =head1 DESCRIPTION
  55
  56 The B<pth-config> program is a little helper utility for easy configuring and
  57 building applications based on the pth(3) library.  It can be used to query the
  58 C compiler and linker flags which are required to correctly compile and link
  59 the application against the pth(3) library.
  60
  61 =head1 OPTIONS
  62
  63 B<pth-config> accepts the following options:
  64
  65 =over 4
  66
  67 =item B<--help>
  68
  69 Prints the short usage information.
  70
  71 =item B<--version>
  72
  73 Prints the version number and date of the installed pth(3) library.
  74
  75 =item B<--all>
  76
  77 Forces the output of all flags, that is, including extra flags which are not
  78 B<Pth> specific.
  79
  80 =item B<--prefix>
  81
  82 Prints the installation prefix of architecture independent files
  83
  84 =item B<--exec-prefix>
  85
  86 Prints the installation prefix of architecture dependent files.
  87
  88 =item B<--bindir>
  89
  90 Prints the installation directory of binaries.
  91
  92 =item B<--libdir>
  93
  94 Prints the installation directory of libraries.
  95
  96 =item B<--includedir>
  97
  98 Prints the installation directory of include headers.
  99
 100 =item B<--mandir>
 101
 102 Prints the installation directory of manual pages.
 103
 104 =item B<--datadir>
 105
 106 Prints the installation directory of shared data.
 107
 108 =item B<--acdir>
 109
 110 Prints the installation directory of B<autoconf> data.
 111
 112 =item B<--cflags>
 113
 114 Prints the C compiler flags which are needed to compile the pth(3)-based
 115 application. The output is usually added to the C<CFLAGS> variable of the
 116 applications C<Makefile>.
 117
 118 =item B<--ldflags>
 119
 120 Prints the linker flags (C<-L>) which are needed to link the application with
 121 the pth(3) library. The output is usually added to the C<LDFLAGS> variable of
 122 the applications C<Makefile>.
 123
 124 =item B<--libs>
 125
 126 Prints the library flags (C<-l>) which are needed to link the application with
 127 the pth(3) library. The output is usually added to the C<LIBS> variable of the
 128 applications C<Makefile>.
 129
 130 =back
 131
 132 =head1 EXAMPLE
 133
 134  CC      = cc
 135  CFLAGS  = -O `pth-config --cflags`
 136  LDFLAGS = `pth-config --ldflags`
 137  LIBS    = -lm `pth-config --libs`
 138
 139  all: foo
 140  foo: foo.o
 141      $(CC) $(LDFLAGS) -o foo foo.o $(LIBS)
 142  foo.o: foo.c
 143      $(CC) $(CFLAGS) -c foo.c
 144
 145 =head1 SEE ALSO
 146
 147 pth(3), cc(1).
 148
 149 =head1 AUTHOR
 150
 151  Ralf S. Engelschall
 152  rse@engelschall.com
 153  www.engelschall.com
 154
 155 =cut
 156