aa8929b09a5d313e2435da0512a6eab8ada6b552
[freeside.git] / htdocs / docs / man / FS / SSH.html
1 <HTML>
2 <HEAD>
3 <TITLE>FS::SSH - Subroutines to call ssh and scp</TITLE>
4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
5 </HEAD>
6
7 <BODY>
8
9 <!-- INDEX BEGIN -->
10
11 <UL>
12
13         <LI><A HREF="#NAME">NAME</A>
14         <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15         <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16         <LI><A HREF="#SUBROUTINES">SUBROUTINES</A>
17         <LI><A HREF="#BUGS">BUGS</A>
18         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
19 </UL>
20 <!-- INDEX END -->
21
22 <HR>
23 <P>
24 <H1><A NAME="NAME">NAME</A></H1>
25 <P>
26 FS::SSH - Subroutines to call ssh and scp
27
28 <P>
29 <HR>
30 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
31 <P>
32 <PRE>  use FS::SSH qw(ssh scp issh iscp sshopen2 sshopen3);
33 </PRE>
34 <P>
35 <PRE>  ssh($host, $command);
36 </PRE>
37 <P>
38 <PRE>  issh($host, $command);
39 </PRE>
40 <P>
41 <PRE>  scp($source, $destination);
42 </PRE>
43 <P>
44 <PRE>  iscp($source, $destination);
45 </PRE>
46 <P>
47 <PRE>  sshopen2($host, $reader, $writer, $command);
48 </PRE>
49 <P>
50 <PRE>  sshopen3($host, $reader, $writer, $error, $command);
51 </PRE>
52 <P>
53 <HR>
54 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
55 <P>
56 <PRE>  Simple wrappers around ssh and scp commands.
57 </PRE>
58 <P>
59 <HR>
60 <H1><A NAME="SUBROUTINES">SUBROUTINES</A></H1>
61 <DL>
62 <DT><STRONG><A NAME="item_ssh">ssh HOST, COMMAND</A></STRONG><DD>
63 <P>
64 Calls ssh in batch mode.
65
66 <DT><STRONG><A NAME="item_issh">issh HOST, COMMAND</A></STRONG><DD>
67 <P>
68 Prints the ssh command to be executed, waits for the user to confirm, and
69 (optionally) executes the command.
70
71 <DT><STRONG><A NAME="item_scp">scp SOURCE, DESTINATION</A></STRONG><DD>
72 <P>
73 Calls scp in batch mode.
74
75 <DT><STRONG><A NAME="item_iscp">iscp SOURCE, DESTINATION</A></STRONG><DD>
76 <P>
77 Prints the scp command to be executed, waits for the user to confirm, and
78 (optionally) executes the command.
79
80 <DT><STRONG><A NAME="item_sshopen2">sshopen2 HOST, READER, WRITER, COMMAND</A></STRONG><DD>
81 <P>
82 Connects the supplied filehandles to the ssh process (in batch mode).
83
84 <DT><STRONG><A NAME="item_sshopen3">sshopen3 HOST, WRITER, READER, ERROR, COMMAND</A></STRONG><DD>
85 <P>
86 Connects the supplied filehandles to the ssh process (in batch mode).
87
88 <H1><A NAME="BUGS">BUGS</A></H1>
89 <P>
90 Not OO.
91
92 <P>
93 scp stuff should transparantly use rsync-over-ssh instead.
94
95 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
96 <P>
97 <EM>ssh</EM>, <EM>scp</EM>, <A HREF="../IPC/Open2.html">IPC::Open2</A>, <A HREF="../IPC/Open3.html">IPC::Open3</A>
98
99
100
101 </DL>
102 </BODY>
103
104 </HTML>