putty/DOC/MAN-PL.BUT

   1 \cfg{man-identity}{plink}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}\r
   2 \r
   3 \H{plink-manpage} Man page for Plink\r
   4 \r
   5 \S{plink-manpage-name} NAME\r
   6 \r
   7 \cw{plink} \- PuTTY link, command line network connection tool\r
   8 \r
   9 \S{plink-manpage-synopsis} SYNOPSIS\r
  10 \r
  11 \c plink [options] [user@]host [command]\r
  12 \e bbbbb  iiiiiii   iiiib iiii  iiiiiii\r
  13 \r
  14 \S{plink-manpage-description} DESCRIPTION\r
  15 \r
  16 \cw{plink} is a network connection tool supporting several protocols.\r
  17 \r
  18 \S{plink-manpage-options} OPTIONS\r
  19 \r
  20 The command-line options supported by \cw{plink} are:\r
  21 \r
  22 \dt \cw{-V}\r
  23 \r
  24 \dd Show version information and exit.\r
  25 \r
  26 \dt \cw{-pgpfp}\r
  27 \r
  28 \dd Display the fingerprints of the PuTTY PGP Master Keys and exit,\r
  29 to aid in verifying new files released by the PuTTY team.\r
  30 \r
  31 \dt \cw{-v}\r
  32 \r
  33 \dd Show verbose messages.\r
  34 \r
  35 \dt \cw{-load} \e{session}\r
  36 \r
  37 \dd Load settings from saved session.\r
  38 \r
  39 \dt \cw{-ssh}\r
  40 \r
  41 \dd Force use of SSH protocol (default).\r
  42 \r
  43 \dt \cw{-telnet}\r
  44 \r
  45 \dd Force use of Telnet protocol.\r
  46 \r
  47 \dt \cw{-rlogin}\r
  48 \r
  49 \dd Force use of rlogin protocol.\r
  50 \r
  51 \dt \cw{-raw}\r
  52 \r
  53 \dd Force raw mode.\r
  54 \r
  55 \dt \cw{-serial}\r
  56 \r
  57 \dd Force serial mode.\r
  58 \r
  59 \dt \cw{-P} \e{port}\r
  60 \r
  61 \dd Connect to port \e{port}.\r
  62 \r
  63 \dt \cw{-l} \e{user}\r
  64 \r
  65 \dd Set remote username to \e{user}.\r
  66 \r
  67 \dt \cw{-m} \e{path}\r
  68 \r
  69 \dd Read remote command(s) from local file \e{path}.\r
  70 \r
  71 \dt \cw{-batch}\r
  72 \r
  73 \dd Disable interactive prompts.\r
  74 \r
  75 \dt \cw{-pw} \e{password}\r
  76 \r
  77 \dd Set remote password to \e{password}. \e{CAUTION:} this will likely\r
  78 make the password visible to other users of the local machine (via\r
  79 commands such as \q{\c{w}}).\r
  80 \r
  81 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}\r
  82 \r
  83 \dd Set up a local port forwarding: listen on \e{srcport} (or\r
  84 \e{srcaddr}:\e{srcport} if specified), and forward any connections\r
  85 over the SSH connection to the destination address\r
  86 \e{desthost}:\e{destport}. Only works in SSH.\r
  87 \r
  88 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}\r
  89 \r
  90 \dd Set up a remote port forwarding: ask the SSH server to listen on\r
  91 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to\r
  92 forward any connections back over the SSH connection where the\r
  93 client will pass them on to the destination address\r
  94 \e{desthost}:\e{destport}. Only works in SSH.\r
  95 \r
  96 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}\r
  97 \r
  98 \dd Set up dynamic port forwarding. The client listens on\r
  99 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and\r
 100 implements a SOCKS server. So you can point SOCKS-aware applications\r
 101 at this port and they will automatically use the SSH connection to\r
 102 tunnel all their connections. Only works in SSH.\r
 103 \r
 104 \dt \cw{-X}\r
 105 \r
 106 \dd Enable X11 forwarding.\r
 107 \r
 108 \dt \cw{-x}\r
 109 \r
 110 \dd Disable X11 forwarding (default).\r
 111 \r
 112 \dt \cw{-A}\r
 113 \r
 114 \dd Enable agent forwarding.\r
 115 \r
 116 \dt \cw{-a}\r
 117 \r
 118 \dd Disable agent forwarding (default).\r
 119 \r
 120 \dt \cw{-t}\r
 121 \r
 122 \dd Enable pty allocation (default if a command is NOT specified).\r
 123 \r
 124 \dt \cw{-T}\r
 125 \r
 126 \dd Disable pty allocation (default if a command is specified).\r
 127 \r
 128 \dt \cw{-1}\r
 129 \r
 130 \dd Force use of SSH protocol version 1.\r
 131 \r
 132 \dt \cw{-2}\r
 133 \r
 134 \dd Force use of SSH protocol version 2.\r
 135 \r
 136 \dt \cw{-C}\r
 137 \r
 138 \dd Enable SSH compression.\r
 139 \r
 140 \dt \cw{-i} \e{path}\r
 141 \r
 142 \dd Private key file for authentication.\r
 143 \r
 144 \dt \cw{-s}\r
 145 \r
 146 \dd Remote command is SSH subsystem (SSH-2 only).\r
 147 \r
 148 \dt \cw{-N}\r
 149 \r
 150 \dd Don't start a remote command or shell at all (SSH-2 only).\r
 151 \r
 152 \dt \cw{\-sercfg} \e{configuration-string}\r
 153 \r
 154 \dd Specify the configuration parameters for the serial port, in\r
 155 \cw{-serial} mode. \e{configuration-string} should be a\r
 156 comma-separated list of configuration parameters as follows:\r
 157 \r
 158 \lcont{\r
 159 \r
 160 \b Any single digit from 5 to 9 sets the number of data bits.\r
 161 \r
 162 \b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.\r
 163 \r
 164 \b Any other numeric string is interpreted as a baud rate.\r
 165 \r
 166 \b A single lower-case letter specifies the parity: \cq{n} for none,\r
 167 \cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.\r
 168 \r
 169 \b A single upper-case letter specifies the flow control: \cq{N} for\r
 170 none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for\r
 171 DSR/DTR.\r
 172 \r
 173 }\r
 174 \r
 175 \S{plink-manpage-more-information} MORE INFORMATION\r
 176 \r
 177 For more information on plink, it's probably best to go and look at\r
 178 the manual on the PuTTY web page:\r
 179 \r
 180 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\r
 181 \r
 182 \S{plink-manpage-bugs} BUGS\r
 183 \r
 184 This man page isn't terribly complete. See the above web link for\r
 185 better documentation.\r