Initial revision
[freeside.git] / htdocs / docs / man / SSH.txt
1 NAME
2     FS::SSH - Subroutines to call ssh and scp
3
4 SYNOPSIS
5       use FS::SSH qw(ssh scp issh iscp sshopen2 sshopen3);
6
7       ssh($host, $command);
8
9       issh($host, $command);
10
11       scp($source, $destination);
12
13       iscp($source, $destination);
14
15       sshopen2($host, $reader, $writer, $command);
16
17       sshopen3($host, $reader, $writer, $error, $command);
18
19 DESCRIPTION
20       Simple wrappers around ssh and scp commands.
21
22 SUBROUTINES
23     ssh HOST, COMMAND
24         Calls ssh in batch mode.
25
26     issh HOST, COMMAND
27         Prints the ssh command to be executed, waits for the user to
28         confirm, and (optionally) executes the command.
29
30     scp SOURCE, DESTINATION
31         Calls scp in batch mode.
32
33     iscp SOURCE, DESTINATION
34         Prints the scp command to be executed, waits for the user to
35         confirm, and (optionally) executes the command.
36
37     sshopen2 HOST, READER, WRITER, COMMAND
38         Connects the supplied filehandles to the ssh process (in
39         batch mode).
40
41     sshopen3 HOST, WRITER, READER, ERROR, COMMAND
42         Connects the supplied filehandles to the ssh process (in
43         batch mode).
44
45 BUGS
46         Not OO.
47
48         scp stuff should transparantly use rsync-over-ssh instead.
49
50 SEE ALSO
51         the ssh manpage, the scp manpage, the IPC::Open2 manpage,
52         the IPC::Open3 manpage
53
54 HISTORY
55         ivan@voicenet.com 97-jul-17
56
57         added sshopen2 and sshopen3 ivan@sisd.com 98-mar-9
58
59         added iscp ivan@sisd.com 98-jul-25 now iscp asks y/n, issh
60         and took out path ivan@sisd.com 98-jul-30
61
62         pod ivan@sisd.com 98-sep-21
63