~ubuntu-branches/ubuntu/vivid/libssh2/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/libssh2_agent_connect.3

  • Committer: Bazaar Package Importer
  • Author(s): Mikhail Gusarov
  • Date: 2010-02-28 13:11:14 UTC
  • mto: (1.1.6 upstream) (2.1.8 sid)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: james.westby@ubuntu.com-20100228131114-g8d2ps9p1u8i80s3
Tags: upstream-1.2.4
ImportĀ upstreamĀ versionĀ 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"
 
2
.\" Copyright (c) 2009 by Daiki Ueno
 
3
.\"
 
4
.TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual"
 
5
.SH NAME
 
6
libssh2_agent_connect - connect to an ssh-agent
 
7
.SH SYNOPSIS
 
8
#include <libssh2.h>
 
9
 
 
10
int libssh2_agent_connect(LIBSSH2_AGENT *agent);
 
11
.SH DESCRIPTION
 
12
Connect to an ssh-agent running on the system.
 
13
 
 
14
Call \fBlibssh2_agent_disconnect(3)\fP to close the connection after
 
15
you're doing using it.
 
16
.SH RETURN VALUE
 
17
Returns 0 if succeeded, or a negative value for error.
 
18
.SH AVAILABILITY
 
19
Added in libssh2 1.2
 
20
.SH SEE ALSO
 
21
.BR libssh2_agent_init(3)
 
22
.BR libssh2_agent_disconnect(3)
 
23