cvs commit: ant/docs/manual/OptionalTasks scp.html

[bodewig]

bodewig     2003/03/11 05:56:58

  Modified:    docs/manual/OptionalTasks scp.html
  Log:
  document new scp functionality
  
  Revision  Changes    Path
  1.3       +42 -2     ant/docs/manual/OptionalTasks/scp.html
  
  Index: scp.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/OptionalTasks/scp.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- scp.html  7 Mar 2003 14:53:36 -0000       1.2
  +++ scp.html  11 Mar 2003 13:56:58 -0000      1.3
  @@ -28,14 +28,18 @@
     <tr>
       <td valign="top">file</td>
       <td valign="top">The file to copy.  This can be a local path or a
  -    remote path of the form <i>user:[EMAIL 
PROTECTED]:/directory/path.</i></td>
  +    remote path of the form <i>user[:[EMAIL PROTECTED]:/directory/path</i>.
  +    <i>:password</i> can be ommitted if you use key based
  +    authentication or specify the password attribute.</td>
       <td valign="top" align="center">Yes, unless a nested
       <code>&lt;fileset&gt;</code> element is used.</td>
     </tr>
     <tr>
       <td valign="top">todir</td>
       <td valign="top">The directory to copy to.  This can be a local path
  -    or a remote path of the form <i>user:[EMAIL 
PROTECTED]:/directory/path</i></td>
  +    or a remote path of the form <i>user[:[EMAIL 
PROTECTED]:/directory/path</i>.
  +    <i>:password</i> can be ommitted if you use key based
  +    authentication or specify the password attribute.</td>
       <td valian="top" align="center">Yes</td>
     </tr>
     <tr>
  @@ -63,6 +67,25 @@
        </td>
        <td valign="top" align="center">No; defaults to true.</td>
     </tr>
  +  <tr>
  +    <td valign="top">password</td>
  +     <td valign="top">The password.</td>
  +     <td valign="top" align="center">Not if you are using key based
  +     authentication or the password has been given in the file or
  +     todir attribute.</td>
  +  </tr>
  +  <tr>
  +    <td valign="top">keyfile</td>
  +     <td valign="top">Location of the file holding the private key.</td>
  +     <td valign="top" align="center">Yes, if you are using key based
  +     authentication.</td>
  +  </tr>
  +  <tr>
  +    <td valign="top">passphrase</td>
  +     <td valign="top">Passphrase for your private key.</td>
  +     <td valign="top" align="center">Yes, if you are using key based
  +     authentication.</td>
  +  </tr>
   </table>
   <h3>Parameters specified as nested elements</h3>
   
  @@ -76,6 +99,23 @@
   <pre>
     &lt;scp file=&quot;myfile.txt&quot; todir=&quot;user:[EMAIL 
PROTECTED]:/home/chuck&quot;/&gt;
   </pre>
  +
  +<p><b>Copy a single local file to a remote machine with separate
  +password attribute</b></p>
  +<pre>
  +  &lt;scp file=&quot;myfile.txt&quot; todir=&quot;[EMAIL 
PROTECTED]:/home/chuck&quot; password=&quot;password&quot;/&gt;
  +</pre>
  +
  +<p><b>Copy a single local file to a remote machine using key base
  +authentication.</b></p>
  +<pre>
  +  &lt;scp file=&quot;myfile.txt&quot;
  +       todir=&quot;[EMAIL PROTECTED]:/home/chuck&quot; 
  +       keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  +       passphrase=&quot;my extremely secret passphrase&quot;
  +  /&gt;
  +</pre>
  +
   <p><b>Copy a single remote file to a local directory</b></p>
   <pre>
     &lt;scp file=&quot;user:[EMAIL PROTECTED]:/home/chuck/myfile.txt&quot; 
todir=&quot;../some/other/dir&quot;/&gt;