Codebase list cppad / upstream/2015.00.00.7 doc / pkgconfig.xml
upstream/2015.00.00.7

Tree @upstream/2015.00.00.7 (Download .tar.gz)

pkgconfig.xml @upstream/2015.00.00.7 — raw · history · blame 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>CppAD pkg-config Files</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="CppAD pkg-config Files"/>
<meta name="keywords" id="keywords" content=" cppad pkg-config files pc purpose usage defined fields configuration "/>
<style type='text/css'>
body { color : black }
body { background-color : white }
A:link { color : blue }
A:visited { color : purple }
A:active { color : purple }
</style>
<script type='text/javascript' language='JavaScript' src='_pkgconfig_xml.js'>
</script>
</head>
<body>
<table><tr>
<td>
<a href="http://www.coin-or.org/CppAD/" target="_top"><img border="0" src="_image.gif"/></a>
</td>
<td><a href="cmake_check.xml" target="_top">Prev</a>
</td><td><a href="installunix.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-&gt;</option>
<option>contents</option>
<option>reference</option>
<option>index</option>
<option>search</option>
<option>external</option>
</select>
</td>
<td>
<select onchange='choose_up0(this)'>
<option>Up-&gt;</option>
<option>CppAD</option>
<option>Install</option>
<option>pkgconfig</option>
</select>
</td>
<td>
<select onchange='choose_down2(this)'>
<option>CppAD-&gt;</option>
<option>Install</option>
<option>Introduction</option>
<option>AD</option>
<option>ADFun</option>
<option>preprocessor</option>
<option>multi_thread</option>
<option>library</option>
<option>ipopt_solve</option>
<option>Example</option>
<option>speed</option>
<option>Appendix</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>Install-&gt;</option>
<option>download</option>
<option>cmake</option>
<option>cmake_check</option>
<option>pkgconfig</option>
<option>InstallUnix</option>
</select>
</td>
<td>pkgconfig</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Purpose</option>
<option>Usage</option>
<option>Defined Fields</option>
<option>CppAD Configuration Files</option>
</select>
</td>
</tr></table><br/>
<center><b><big><big>CppAD pkg-config Files</big></big></b></center>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
The <code><font color="blue">pkg-config</font></code> package helps with the use of installed libraries; 
see its
<a href="http://people.freedesktop.org/~dbn/pkg-config-guide.html" target="_top"><span style='white-space: nowrap'>guide</span></a>

for more information.

<br/>
<br/>
<b><big><a name="Usage" id="Usage">Usage</a></big></b>
<br/>
The necessary flags for compiling code that includes CppAD can 
be obtained with the command
<code><font color='blue'><pre style='display:inline'> 
	pkg-config --cflags cppad
</pre></font></code>

Note that this command assumes <a href="pkgconfig.xml" target="_top"><span style='white-space: nowrap'>cppad.pc</span></a>
 is in
the search path <code><font color="blue">PKG_CONFIG_PATH</font></code>.
If <a href="ipopt_prefix.xml" target="_top"><span style='white-space: nowrap'>ipopt_prefix</span></a>
 is specified,
the necessary flags for linking <a href="cppad_ipopt_nlp.xml" target="_top"><span style='white-space: nowrap'>cppad_ipopt</span></a>

can be obtained with the commands
<code><font color='blue'><pre style='display:inline'> 
	pkg-config --libs cppad
</pre></font></code>

Note that this command assumes <code><font color="blue">ipopt.pc</font></code> is in
the search path <code><font color="blue">PKG_CONFIG_PATH</font></code>.

<br/>
<br/>
<b><big><a name="Defined Fields" id="Defined Fields">Defined Fields</a></big></b>

<table><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Name</span></font></i></code>
 </td><td align='left'  valign='top'>

	A human-readable name for the CppAD package.
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Description</span></font></i></code>
 </td><td align='left'  valign='top'>

	A brief description of the CppAD package.
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>URL</span></font></i></code>
 </td><td align='left'  valign='top'>

	A URL where people can get more information about the CppAD package.
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Version</span></font></i></code>
 </td><td align='left'  valign='top'>

	A string specifically defining the version of the CppAD package.
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Cflags</span></font></i></code>
 </td><td align='left'  valign='top'>

	The necessary flags for using any of the CppAD include files.
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Libs</span></font></i></code>
 </td><td align='left'  valign='top'>

	If <a href="ipopt_prefix.xml" target="_top"><span style='white-space: nowrap'>ipopt_prefix</span></a>
 is specified,
	the necessary flags for using the <a href="cppad_ipopt_nlp.xml" target="_top"><span style='white-space: nowrap'>cppad_ipopt</span></a>

	library
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>Requires</span></font></i></code>
 </td><td align='left'  valign='top'>

	If <a href="ipopt_prefix.xml" target="_top"><span style='white-space: nowrap'>ipopt_prefix</span></a>
 is specified,
	the packages required to use the <a href="cppad_ipopt_nlp.xml" target="_top"><span style='white-space: nowrap'>cppad_ipopt</span></a>

	library
</td></tr>
</table>
<br/>
<b><big><a name="CppAD Configuration Files" id="CppAD Configuration Files">CppAD Configuration Files</a></big></b>
<br/>
In the table below, 

<code><i><font color="black"><span style='white-space: nowrap'>builddir</span></font></i></code>
 is the build directory; i.e., the directory where
the CppAD
<a href="installunix.xml#Configure" target="_top"><span style='white-space: nowrap'>Configure</span></a>
 command is executed.
The directory 
<code><i><font color="black"><span style='white-space: nowrap'>prefix</span></font></i></code>
 is the value of
<a href="cmake.xml#cmake_install_prefix" target="_top"><span style='white-space: nowrap'>cmake_install_prefix</span></a>
 during configuration.
The directory 
<code><i><font color="black"><span style='white-space: nowrap'>datadir</span></font></i></code>
 is the value of
<a href="cmake.xml#cmake_install_datadir" target="_top"><span style='white-space: nowrap'>cmake_install_datadir</span></a>
.
The following configuration files contain the information above
<table><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>File</span></font></i></code>
             </td><td align='left'  valign='top'>
 
	
<code><i><font color="black"><span style='white-space: nowrap'>Description</span></font></i></code>
 </td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>prefix</span></font></i><font color="blue"><span style='white-space: nowrap'>/</span></font><i><font color="black"><span style='white-space: nowrap'>datadir</span></font></i><font color="blue"><span style='white-space: nowrap'>/pkgconfig/cppad.pc</span></font></code>
              </td><td align='left'  valign='top'>
 
	for use after <a href="install.xml#Instructions.Step 4: Install" target="_top"><span style='white-space: nowrap'>make&#xA0;install</span></a>
 
</td></tr><tr><td align='left'  valign='top'>


<code><i><font color="black"><span style='white-space: nowrap'>builddir</span></font></i><font color="blue"><span style='white-space: nowrap'>/pkgconfig/cppad-uninstalled.pc</span></font></code>
       </td><td align='left'  valign='top'>
 
	for testing before <code><font color="blue">make install</font></code>                      
</td></tr>
</table>

<hr/>Input File: omh/install/pkgconfig.omh

</body>
</html>