File: ssh_ssh.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (34 lines) | stat: -rw-r--r-- 710 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.TH ssh_ssh 3 "ssh  0.9.9.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
ssh_ssh \- SSH client\&.
.SH DESCRIPTION
.LP
This module implements a simple SSH client in erlang, providing an interactive shell to another computer\&.

.SH EXPORTS
.LP
.B
connect(Host) -> ok
.br
.B
connect(Host, Options) -> ok
.br
.B
connect(Host, Port, Options) -> ok
.br
.RS
.TP
Types
Host = string()
.br
Port = integer()
.br
Options = [Option]
.br
.RE
.RS
.LP
\fIconnect\fR starts an interactive shell to an SSH server on the given \fIHost\fR\&. The function waits for user input, and will not return until the remote shell is ended\&.(e\&.g\&. on \fIexit\fR from the shell)\&.
.LP
For options, see \fIssh_cm:connect\fR
.RE