Blame doc/introduction.dox

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