]> asedeno.scripts.mit.edu Git - PuTTY.git/blobdiff - doc/plink.but
Document the three new configuration options I've added tonight
[PuTTY.git] / doc / plink.but
index cd8e31d38cf7e1ccc4f9f1aecf34e543c11b516f..7a5d845e6a67dd9dd05abfb615d29d5a59a94620 100644 (file)
@@ -1,21 +1,10 @@
-\versionid $Id: plink.but,v 1.4 2001/02/19 23:24:01 owen Exp $
+\versionid $Id: plink.but,v 1.11 2001/11/25 17:32:39 simon Exp $
 
 \C{plink} Using the command-line connection tool Plink
 
-\# Explain Plink
-
-\# Explain that Plink is probably not what you want if you want to
-\# run an interactive session in a Command Prompt window
-
-\# Explain that Plink is really for batch-file use, and that
-\# therefore it works best with public-key authentication; link to
-\# that chapter
-
-\# Give instructions on how to set up Plink with CVS
-
-\i{Plink} (PuTTY Link), is a command-line connection tool similar to
-UNIX \c{ssh}.  It is probably not what you want if you want to run an
-interactive session in a console window.
+\i{Plink} (PuTTY Link) is a command-line connection tool similar to
+UNIX \c{ssh}.  It is probably not what you want if you want to run
+an interactive session in a console window.
 
 \H{plink-starting} Starting Plink
 
@@ -30,7 +19,7 @@ To start Plink it will need either to be on your \i{\c{PATH}} or in your
 current directory.  To add the directory containing Plink to your
 \c{PATH} environment variable, type into the console window:
 
-\c set PATH C:\path\to\putty\directory;%PATH%
+\c set PATH=C:\path\to\putty\directory;%PATH%
 
 This will only work for the lifetime of that particular console
 window.  To set your \c{PATH} more permanently on Windows NT, use the
@@ -104,10 +93,11 @@ You also need to arrange to be able to connect to a remote host
 without a password.  To do this, either:
 
 \b Run PuTTY, and create a PuTTY saved session (see
-\k{config-saving}) which specifies your private key file (see
-\k{config-auth}). You will probably also want to specify a username
-to log in as (see \k{config-username}).  You should then be able to
-run CVS as follows:
+\k{config-saving}) with the protocol set to SSH (see
+\k{config-hostname}) and specifies your private key file (see
+\k{config-ssh-privkey}). You will probably also want to specify a
+username to log in as (see \k{config-username}). You should then be
+able to run CVS as follows:
 
 \c cvs -d :ext:user@sessionname:/path/to/repository co module
 
@@ -120,6 +110,10 @@ Alternatively, you can use Pageant if Pageant is running (see
 
 \b Ensure Pageant is running, and has your private key stored in it.
 
+\b Set the environment variable \cw{PLINK_PROTOCOL} to the string
+\c{ssh}, to make sure Plink will try to connect using SSH instead of
+Telnet.
+
 \b Run CVS as follows:
 
 \c cvs -d :ext:user@hostname:/path/to/repository co module
@@ -130,19 +124,19 @@ Plink can also be used with WinCVS.  Firstly, arrange for Plink to be
 able to connect to a remote host without a password.  \k{plink-cvs}
 has instructions on this.
 
-In WinCVS, bring up the \e{Preferences} dialogue box from the
-\e{Admin} menu, and switch to the \e{Ports} tab. Tick the box there
-labelled \e{Check for an alternate rsh name} and in the text entry
+In WinCVS, bring up the \q{Preferences} dialogue box from the
+\e{Admin} menu, and switch to the \q{Ports} tab. Tick the box there
+labelled \q{Check for an alternate rsh name} and in the text entry
 field to the right enter the full path to \c{plink.exe}.  Select
-\e{OK} on the \e{Preferences} dialogue box.
+\q{OK} on the \q{Preferences} dialogue box.
 
-Next, select \e{Command Line} from the WinCVS \e{Admin} menu, and type 
+Next, select \q{Command Line} from the WinCVS \q{Admin} menu, and type 
 a CVS command as in \k{plink-cvs}, for example:
 
 \c cvs -d :ext:user@hostname:/path/to/repository co module
 
-Select the folder you want to check out to with the \e{Change Folder}
-button, and click \e{OK} to check out your module.  Once you've got
+Select the folder you want to check out to with the \q{Change Folder}
+button, and click \q{OK} to check out your module.  Once you've got
 modules checked out, WinCVS will happily invoke plink from the GUI for
 CVS operations.