config.xml 3.7 KB

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