path: root/doc
diff options
authorAndreas Schneider <asn@cynapses.org>2010-12-10 20:17:57 +0100
committerAndreas Schneider <asn@cynapses.org>2010-12-10 20:17:57 +0100
commit37eeb854e4b0a51b0e51d571404630e156efa819 (patch)
tree7e0087ac7271d295547e1b9c29a727bae6d45776 /doc
parent57d752a1c31d64ef197444d6bf8f1f2726776661 (diff)
doc: Started to write a linking howto.
Diffstat (limited to 'doc')
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/linking.dox b/doc/linking.dox
new file mode 100644
index 0000000..f558b62
--- /dev/null
+++ b/doc/linking.dox
@@ -0,0 +1,24 @@
+@page libssh_linking The Linking HowTo
+@section dynamic Dynamic Linking
+On UNIX and Windows systems its the same, you need at least the libssh.h
+header file and the libssh shared library.
+@section static Static Linking
+@warning The libssh library is licensed under the LGPL! Make sure you
+understand what this means to your codebase if you want to distribute
+binaries and link statically against LGPL code!
+On UNIX systems linking against the static version of the library is the
+same as linking against the shared library. Both have the same name. Some
+build system require to use the full path to the static library.
+On Windows you need to define LIBSSH_STATIC in the compiler command line
+This is required cause the dynamic library needs to specify the dllimport
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 4da67c0..40aa0f0 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -5,6 +5,11 @@
This is the online reference for developing with the libssh library. It
documents the libssh C API and the C++ wrapper.
+@section main-linking Linking
+We created a small howto how to link libssh against your application, read
+@subpage libssh_linking.
@section main-tutorial Tutorial
You should start by reading @subpage libssh_tutorial, then reading the documentation of