source: trunk/doc/build_tool.doxygen @ 1797

Last change on this file since 1797 was 1797, checked in by Peter, 13 years ago

updating copyright statements

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1// $Id: build_tool.doxygen 1797 2009-02-12 18:07:10Z peter $
2//
3// Copyright (C) 2008 Jari Häkkinen, Peter Johansson
4// Copyright (C) 2009 Peter Johansson
5//
6// This file is part of the yat library, http://dev.thep.lu.se/yat
7//
8// The yat library is free software; you can redistribute it and/or
9// modify it under the terms of the GNU General Public License as
10// published by the Free Software Foundation; either version 3 of the
11// License, or (at your option) any later version.
12//
13// The yat 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// General Public License for more details.
17//
18// You should have received a copy of the GNU General Public License
19// along with yat. If not, see <http://www.gnu.org/licenses/>.
20
21
22/**
23\page build_tool Build Tools
24
25\section yat-config
26
27The \c yat-config script provides information on the local version of
28the library. For instance the following command shows that yat was
29installed at prefix \c `/usr/local'
30
31\verbatim
32 #> yat-config --prefix
33/usr/local
34\endverbatim
35
36This information can then be used in a Makefile, for example, as follows:
37
38\verbatim
39BIN=foo
40SRC=$(BIN).cc
41OBJECTS=$(SRC:.cc=.o)
42
43CPPFLAGS+=`yat-config --cppflags`
44CXXFLAGS+=`yat-config --cxxflags`
45LDFLAGS+=`yat-config --ldflags`
46LIBS+=`yat-config --libs`
47
48all: $(BIN)
49
50$(BIN): $(OBJECTS)
51  $(CXX) $(LDFLAGS) $(OBJECTS) -o $(BIN) $(LIBS)
52
53.cc.o:
54  $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $< -o $@
55
56clean:; rm -f $(OBJECTS) $(BIN)
57\endverbatim
58
59For further information on yat-config use \c `yat-config \c --help'
60
61\since New in yat 0.5
62
63\section macro Autoconf Macro
64
65For applications using autoconf there is a macro available in \c
66yat.m4. The macro can be called from your \c configure.ac:
67
68\verbatim
69   YAT_CHECK_YAT([minimum-version], [action-if-found],[action-if-not-found])
70\endverbatim
71
72The argument minimum-version should be the number (\c MAJOR.MINOR or
73\c MAJOR.MINOR.PATCH) of the version you require. If yat header files
74and library are not found or the version is not new enough, macro will
75complain and execute shell command \c action-if-not-found. A suitable
76\c action-if-not-found could be
77
78\verbatim
79   AC_MSG_ERROR([could not find required version of yat])
80\endverbatim
81
82If the test is successful, \c HAVE_YAT is defined and \c
83action-if-found is executed. The test calls \c yat-config and sets
84variables \c YAT_CPPFLAGS, \c YAT_CXXFLAGS, \c YAT_LDFLAGS, \c
85YAT_LIBS, and \c YAT_LA_FILE. These flags can then be used in the \c
86Makefile.am. For instance:
87
88\verbatim
89   AM_CPPFLAGS = $(YAT_CPPFLAGS)
90   AM_CXXFLAGS = $(YAT_CXXFLAGS)
91   AM_LDFLAGS = $(YAT_LDFLAGS)
92   LDADD = $(YAT_LIBS)
93\endverbatim
94
95or when using libtool you could use \c YAT_LA_FILE:
96
97\verbatim
98   AM_CPPFLAGS = $(YAT_CPPFLAGS)
99   AM_CXXFLAGS = $(YAT_CXXFLAGS)
100   LDADD = $(YAT_LA_FILE)
101\endverbatim
102
103If you have yat installed with a different prefix than aclocal, for
104example, if yat is installed in prefix \c /usr/local and aclocal is
105located in \c /usr/bin, then you need to tell aclocal (or autoreconf)
106where to look for \c yat.m4
107
108\verbatim
109   #> aclocal -I /usr/local/share/aclocal
110\endverbatim
111
112\note this macro assumes that \c yat-config has been installed; \c
113      yat-config was introduced in yat \b 0.5 and consequently this macro
114      \b does \b not work with yat \b 0.4.x (or older).
115
116*/
117
Note: See TracBrowser for help on using the repository browser.