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