Blame doc/introduction.dox

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