libssh/doc/introduction.dox

50 lines
1.6 KiB
Plaintext
Raw Normal View History

/**
@page libssh_tutorial The Tutorial
2010-08-23 23:00:35 +04:00
@section introduction Introduction
libssh is a C library that enables you to write a program that uses the
SSH protocol. With it, you can remotely execute programs, transfer
files, or use a secure and transparent tunnel for your remote programs.
The SSH protocol is encrypted, ensures data integrity, and provides strong
means of authenticating both the server of the client. The library hides
a lot of technical details from the SSH protocol, but this does not
mean that you should not try to know about and understand these details.
libssh is a Free Software / Open Source project. The libssh library
is distributed under LGPL license. The libssh project has nothing to do with
"libssh2", which is a completly different and independant project.
2011-08-28 15:17:39 +04:00
libssh can run on top of either libgcrypt or libcrypto,
two general-purpose cryptographic libraries.
2010-08-27 13:11:08 +04:00
2010-08-23 23:00:35 +04:00
This tutorial concentrates for its main part on the "client" side of libssh.
To learn how to accept incoming SSH connexions (how to write a SSH server),
you'll have to jump to the end of this document.
2011-05-27 15:37:52 +04:00
This tutorial describes libssh version 0.5.0. This version is a little different
from the 0.4.X series. However, the examples should work with
2010-08-23 23:00:35 +04:00
little changes on versions like 0.4.2 and later.
Table of contents:
@subpage libssh_tutor_guided_tour
2010-08-23 23:00:35 +04:00
@subpage libssh_tutor_authentication
2010-08-23 23:00:35 +04:00
@subpage libssh_tutor_shell
2010-08-23 23:00:35 +04:00
@subpage libssh_tutor_command
2010-08-23 23:00:35 +04:00
@subpage libssh_tutor_sftp
2010-08-23 23:00:35 +04:00
@subpage libssh_tutor_scp
2010-08-27 13:11:08 +04:00
@subpage libssh_tutor_forwarding
2010-08-27 18:20:17 +04:00
@subpage libssh_tutor_threads
2010-09-13 00:34:38 +04:00
@subpage libssh_tutor_todo
2010-08-23 23:00:35 +04:00
*/