Debian Codegraph @

deps/libneon/doc/ref/config.xml

raw
1 <refentry id="refconfig">
2
3 <refentryinfo><title>neon</title></refentryinfo>
4
5 <refmeta>
6 <refentrytitle>neon-config</refentrytitle>
7 <manvolnum>1</manvolnum>
8 </refmeta>
9
10 <refnamediv>
11 <refname id="neon-config">neon-config</refname>
12
13 <refpurpose>script providing information about installed copy
14 of neon library</refpurpose>
15 </refnamediv>
16
17 <refsynopsisdiv>
18
19 <cmdsynopsis>
20 <command>neon-config</command>
21 <arg choice="opt"><option>--prefix</option></arg>
22 <group>
23 <arg><option>--cflags</option></arg>
24 <arg><option>--libs</option></arg>
25 <arg><option>--la-file</option></arg>
26 <arg><option>--support</option> <replaceable>feature</replaceable></arg>
27 <arg><option>--help</option></arg>
28 <arg><option>--version</option></arg>
29 </group>
30 </cmdsynopsis>
31
32 </refsynopsisdiv>
33
34 <refsect1>
35 <title>Description</title>
36
37 <para>The <command>neon-config</command> script provides
38 information about an installed copy of the neon library. The
39 <option>--cflags</option> and <option>--libs</option> options instruct
40 how to compile and link an application against the library; the
41 <option>--version</option> and <option>--support</option> options can
42 help determine whether the library meets the applications
43 requirements.</para>
44
45 </refsect1>
46
47 <refsect1>
48 <title>Options</title>
49
50 <variablelist>
51
52 <varlistentry>
53 <term><option>--cflags</option></term>
54 <listitem><simpara>Print the flags which should be passed to
55 the C compiler when compiling object files, when the object files use
56 neon header files.</simpara></listitem>
57 </varlistentry>
58
59 <varlistentry>
60 <term><option>--libs</option></term>
61 <listitem><simpara>Print the flags which should be passed to
62 the linker when linking an application which uses the neon
63 library</simpara></listitem>
64 </varlistentry>
65
66 <varlistentry>
67 <term><option>--la-file</option></term>
68 <listitem><simpara>Print the location of the libtool library
69 script, <filename>libneon.la</filename>, which can be used to link against
70 &neon; by applications using libtool.</simpara></listitem>
71 </varlistentry>
72
73 <varlistentry>
74 <term><option>--version</option></term>
75 <listitem><simpara>Print the version of the library</simpara></listitem>
76 </varlistentry>
77
78 <varlistentry>
79 <term><option>--prefix</option> <replaceable>dir</replaceable></term>
80 <listitem><simpara>If <replaceable>dir</replaceable> is given; relocate output of
81 <option>--cflags</option> and <option>--libs</option> as if neon was
82 installed in given prefix directory. Otherwise, print the
83 installation prefix of the library.</simpara></listitem>
84 </varlistentry>
85
86 <varlistentry>
87 <term><option>--support</option> <replaceable>feature</replaceable></term>
88 <listitem><simpara>The script exits with success if
89 <replaceable>feature</replaceable> is supported by the
90 library.</simpara></listitem>
91 </varlistentry>
92
93 <varlistentry>
94 <term><option>--help</option></term>
95 <listitem><simpara>Print help message; includes list of known
96 features and whether they are supported or not.</simpara></listitem>
97 </varlistentry>
98
99 </variablelist>
100
101 </refsect1>
102
103 <refsect1 id="example">
104 <title>Example</title>
105
106 <para>Below is a Makefile fragment which could be used to
107 build an application against an installed neon library, when the
108 <command>neon-config</command> script can be found in
109 <envar>$PATH</envar>.</para>
110
111 <programlisting>CFLAGS = `neon-config --cflags`
112 LIBS = `neon-config --libs`
113 OBJECTS = myapp.o
114 TARGET = myapp
115
116 $(TARGET): $(OBJECTS)
117 $(CC) $(LDFLAGS) -o $(TARGET) $(OBJECTS) $(LIBS)
118
119 myapp.o: myapp.c
120 $(CC) $(CFLAGS) -c myapp.c -o myapp.o</programlisting>
121
122 </refsect1>
123
124 </refentry>