git.distorted.org.uk Git - u/mdw/putty/blob - doc/plink.but

   1 \versionid $Id: plink.but,v 1.3 2001/02/07 11:20:15 owen Exp $
   2
   3 \C{plink} Using the command-line connection tool Plink
   4
   5 \# Explain Plink
   6
   7 \# Explain that Plink is probably not what you want if you want to
   8 \# run an interactive session in a Command Prompt window
   9
  10 \# Explain that Plink is really for batch-file use, and that
  11 \# therefore it works best with public-key authentication; link to
  12 \# that chapter
  13
  14 \# Give instructions on how to set up Plink with CVS
  15
  16 \i{Plink} (PuTTY Link), is a command-line connection tool similar to
  17 UNIX \c{ssh}.  It is probably not what you want if you want to run an
  18 interactive session in a console window.
  19
  20 \H{plink-starting} Starting Plink
  21
  22 Plink is a command line application.  This means that you cannot just
  23 double-click on its icon to run it and instead you have to bring up a
  24 \i{console window}.  With Windows 95, 98, and ME, this is called an
  25 \q{MS-DOS Prompt} and with Windows NT and 2000 it is called a
  26 \q{Command Prompt}.  It should be available from the Programs section
  27 of your Start Menu.
  28
  29 To start Plink it will need either to be on your \i{\c{PATH}} or in your
  30 current directory.  To add the directory containing Plink to your
  31 \c{PATH} environment variable, type into the console window:
  32
  33 \c set PATH C:\path\to\putty\directory;%PATH%
  34
  35 This will only work for the lifetime of that particular console
  36 window.  To set your \c{PATH} more permanently on Windows NT, use the
  37 Environment tab of the System Control Panel.  On Windows 95, 98, and
  38 ME, you will need to edit your \c{AUTOEXEC.BAT} to include a \c{set}
  39 command like the one above.
  40
  41 \H{plink-usage} Plink Usage
  42
  43 Once you've got a console window to type into, you can just type
  44 \c{plink} on its own to bring up a usage message.  This tells you the
  45 version of Plink you're using, and gives you a brief summary of how to
  46 use Plink:
  47
  48 \c Z:\sysosd>plink
  49 \c PuTTY Link: command-line connection utility
  50 \c Release 0.50
  51 \c Usage: plink [options] [user@]host [command]
  52 \c Options:
  53 \c   -v        show verbose messages
  54 \c   -ssh      force use of ssh protocol
  55 \c   -P port   connect to specified port
  56 \c   -pw passw login with specified password
  57
  58 \S{plink-usage-basics} The basics
  59
  60 \S{plink-usage-options} Options
  61
  62 These are the command line options that Plink accepts.
  63
  64 \H{plink-pubkey} Public key authentication
  65
  66 \H{plink-batch} Using Plink in \i{batch files} and \i{scripts}
  67
  68 \H{plink-cvs} Using Plink with \i{CVS}
  69
  70 To use Plink with CVS, you need to do something like the following:
  71
  72 \c set CVS_RSH=\path\to\plink.exe
  73 \c cvs -d :ext:user@hostname:/path/to/repository co module
  74
  75 This should work, provided the command \c{plink hostname -l user} works
  76 without requiring a password.
  77
  78 You can arrange for that to be the case by:
  79
  80 \b running Pageant (see \k{pageant}) and putting a valid RSA key in it
  81
  82 \b using a saved session name in place of \c{hostname}, and having that saved
  83    session specify a valid RSA key. (If you do this, you can also leave out
  84    \c{user@}, provided you specify it in the saved session.)
  85
  86 \H{plink-whatelse} Using Plink with... ?
  87