pthread-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 ##  pthread-config.pod: pthread library build utility manual page
  24 ##
  25
  26 =pod
  27
  28 =head1 NAME
  29
  30 B<pthread-config> - Pth pthread library build utility
  31
  32 =head1 VERSION
  33
  34 GNU Pth PTH_VERSION_STR
  35
  36 =head1 SYNOPSIS
  37
  38 B<pthread-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<--cflags>]
  49 [B<--ldflags>]
  50 [B<--libs>]
  51
  52 =head1 DESCRIPTION
  53
  54 The B<pthread-config> program is a little helper utility for easy configuring
  55 and building applications based on the pthread emulation API of the GNU
  56 Portable Threads (pth) library.  It can be used to query the C compiler and
  57 linker flags which are required to correctly compile and link the application
  58 against the pth(3) library.
  59
  60 =head1 OPTIONS
  61
  62 B<pthread-config> accepts the following options:
  63
  64 =over 4
  65
  66 =item B<--help>
  67
  68 Prints the short usage information.
  69
  70 =item B<--version>
  71
  72 Prints the version number and date of the installed pth(3) library.
  73
  74 =item B<--all>
  75
  76 Forces the output of all flags, that is, including extra flags which are not
  77 B<Pth> specific.
  78
  79 =item B<--prefix>
  80
  81 Prints the installation prefix of architecture independent files
  82
  83 =item B<--exec-prefix>
  84
  85 Prints the installation prefix of architecture dependent files.
  86
  87 =item B<--bindir>
  88
  89 Prints the installation directory of binaries.
  90
  91 =item B<--libdir>
  92
  93 Prints the installation directory of libraries.
  94
  95 =item B<--includedir>
  96
  97 Prints the installation directory of include headers.
  98
  99 =item B<--mandir>
 100
 101 Prints the installation directory of manual pages.
 102
 103 =item B<--cflags>
 104
 105 Prints the C compiler flags which are needed to compile the pth(3)-based
 106 application. The output is usually added to the C<CFLAGS> variable of the
 107 applications C<Makefile>.
 108
 109 =item B<--ldflags>
 110
 111 Prints the linker flags (C<-L>) which are needed to link the application with
 112 the pth(3) library. The output is usually added to the C<LDFLAGS> variable of
 113 the applications C<Makefile>.
 114
 115 =item B<--libs>
 116
 117 Prints the library flags (C<-l>) which are needed to link the application with
 118 the pth(3) library. The output is usually added to the C<LIBS> variable of the
 119 applications C<Makefile>.
 120
 121 =back
 122
 123 =head1 EXAMPLE
 124
 125  CC      = cc
 126  CFLAGS  = -O `pthread-config --cflags`
 127  LDFLAGS = `pthread-config --ldflags`
 128  LIBS    = -lm `pthread-config --libs`
 129
 130  all: foo
 131  foo: foo.o
 132      $(CC) $(LDFLAGS) -o foo foo.o $(LIBS)
 133  foo.o: foo.c
 134      $(CC) $(CFLAGS) -c foo.c
 135
 136 =head1 SEE ALSO
 137
 138 pthread(3), cc(1).
 139
 140 =head1 AUTHOR
 141
 142  Ralf S. Engelschall
 143  rse@engelschall.com
 144  www.engelschall.com
 145
 146 =cut
 147