Home Explore Help
Register Sign In
Apq
/
winscp
mirror of https://github.com/winscp/winscp.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 5dda53f478
Branches Tags
winscp
/
libs
/
neon
/
doc
/
html
/
using.html

using.html 4.7 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940 
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>How to use neon from your application</title><link rel="stylesheet" type="text/css" href="manual.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="neon HTTP/WebDAV client library"><link rel="up" href="intro.html" title="Chapter 1. Introduction"><link rel="prev" href="features.html" title="Feature list"><link rel="next" href="example.html" title="Example application"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">How to use neon from your application</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="features.html">Prev</a> </td><th width="60%" align="center">Chapter 1. Introduction</th><td width="20%" align="right"> <a accesskey="n" href="example.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="using"></a>How to use neon from your application</h2></div></div></div><p>This section describes how to add neon support to an
    2. 

  2.       application.  If you just want to quickly try out neon, use
    3. 

  3.       the <a class="xref" href="refconfig.html" title="neon-config"><span class="refentrytitle">neon-config</span></a> script.</p><p>The neon source code is designed to be easily embedded
    4. 

  4.       into an application source tree.  neon has no dependencies on
    5. 

  5.       libraries other than an SSL toolkit and XML parser, though the
    6. 

  6.       source tree can be configured to have no support for SSL or XML
    7. 

  7.       if desired.  To configure the neon source code some <a class="ulink" href="http://www.gnu.org/software/autoconf/" target="_top">GNU autoconf</a>
    8. 

  8.       macros are supplied, which can be used in a number of ways, as
    9. 

  9.       follows:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>autoconf macros are distributed in the 'macros'
    10. 

  10. 	  subdirectory of the neon distribution.  Use the NEON_LIBRARY
    11. 

  11. 	  macro from your configure.in to check for the presence of
    12. 

  12. 	  the neon library installed on the system.  The macro adds an
    13. 

  13. 	  '--with-neon=...'  argument to configure, which allows the
    14. 

  14. 	  user to specify a location for the library (the standard
    15. 

  15. 	  /usr and /usr/local directories are checked automatically
    16. 

  16. 	  without having to be specified).</p></li><li class="listitem"><p>The 'src' directory of the neon package can be
    17. 

  17. 	  imported directly into your application, if you do not wish
    18. 

  18. 	  to add an external dependency.  If you wish to bundle, use
    19. 

  19. 	  the NEON_BUNDLED macro to configure neon in your application:
    20. 

  20. 	  here, the neon sources are bundled in a directory called
    21. 

  21. 	  'libneon':</p><pre class="programlisting">NEON_BUNDLED(libneon, ...)</pre><p>If your application supports builds where srcdir != builddir,
    22. 

  22. 	  you should use the NEON_VPATH_BUNDLED macro like this:</p><pre class="programlisting">NEON_VPATH_BUNDLED(${srcdir}/libneon, libneon, ...)</pre><p>If you use this macro, a '--with-included-neon' option
    23. 

  23. 	  will be added to the generated configure script.  This
    24. 

  24. 	  allows the user to force the bundled neon to be used in the
    25. 

  25. 	  application, rather than any neon library found on the
    26. 

  26. 	  system. If you allow neon to be configured this way, you
    27. 

  27. 	  must also configure an XML parser. Use the NEON_XML_PARSER
    28. 

  28. 	  macro to do this.</p></li><li class="listitem"><p>The final argument to the _BUNDLED macros is a
    29. 

  29. 	  set of actions which are executed if the bundled build *is*
    30. 

  30. 	  chosen (rather than an external neon which might have been
    31. 

  31. 	  found on the user's system).  In here, use either the
    32. 

  32. 	  NEON_LIBTOOL_BUILD or NEON_NORMAL_BUILD macro to set up the
    33. 

  33. 	  neon Makefile appropriately: including adding the neon source
    34. 

  34. 	  directory to the recursive make.</p></li></ul></div><p>A full fragment might be:</p><pre class="programlisting">NEON_BUNDLED(libneon, [
    35. 

  35.   NEON_NORMAL_BUILD
    36. 

  36.   NEON_XML_PARSER
    37. 

  37.   SUBDIRS="libneon $SUBDIRS"
    38. 

  38. ])</pre><p>This means the bundled neon source directory (called 'libneon')
    39. 

  39. 	is used if no neon is found on the system, and the standard XML
    40. 

  40. 	parser search is used.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="features.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="intro.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="example.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Feature list </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Example application</td></tr></table></div></body></html>
    41.