What was that rogue man-mindepth directive doing in here?
[u/mdw/putty] / doc / man-pl.but
CommitLineData
e3e5784e 1\cfg{man-identity}{plink}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
e3e5784e 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
20The command-line options supported by \cw{plink} are:
21
22\dt \cw{-v}
23
24\dd Show verbose messages.
25
26\dt \cw{-load} \e{session}
27
28\dd Load settings from saved session.
29
30\dt \cw{-ssh}
31
32\dd Force use of SSH protocol (default).
33
34\dt \cw{-telnet}
35
36\dd Force use of Telnet protocol.
37
38\dt \cw{-rlogin}
39
40\dd Force use of rlogin protocol.
41
42\dt \cw{-raw}
43
44\dd Force raw mode.
45
46\dt \cw{-P} \e{port}
47
48\dd Connect to port \e{port}.
49
50\dt \cw{-l} \e{user}
51
52\dd Set remote username to \e{user}.
53
54\dt \cw{-m} \e{path}
55
56\dd Read remote command(s) from local file \e{path}.
57
58\dt \cw{-batch}
59
60\dd Disable interactive prompts.
61
62\dt \cw{-pw} \e{password}
63
64\dd Set remote password to \e{password}.
65
66\dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
67
68\dd Set up a local port forwarding: listen on \e{srcport} (or
69\e{srcaddr}:\e{srcport} if specified), and forward any connections
70over the SSH connection to the destination address
71\e{desthost}:\e{destport}. Only works in SSH.
72
73\dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
74
75\dd Set up a remote port forwarding: ask the SSH server to listen on
76\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
77forward any connections back over the SSH connection where the
78client will pass them on to the destination address
79\e{desthost}:\e{destport}. Only works in SSH.
80
81\dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
82
83\dd Set up dynamic port forwarding. The client listens on
84\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
85implements a SOCKS server. So you can point SOCKS-aware applications
86at this port and they will automatically use the SSH connection to
87tunnel all their connections. Only works in SSH.
88
89\dt \cw{-X}
90
91\dd Enable X11 forwarding.
92
93\dt \cw{-x}
94
95\dd Disable X11 forwarding (default).
96
97\dt \cw{-A}
98
99\dd Enable agent forwarding.
100
101\dt \cw{-a}
102
103\dd Disable agent forwarding (default).
104
105\dt \cw{-t}
106
107\dd Enable pty allocation (default if a command is NOT specified).
108
109\dt \cw{-T}
110
111\dd Disable pty allocation (default if a command is specified).
112
113\dt \cw{-1}
114
115\dd Force use of SSH protocol version 1.
116
117\dt \cw{-2}
118
119\dd Force use of SSH protocol version 2.
120
121\dt \cw{-C}
122
123\dd Enable SSH compression.
124
125\dt \cw{-i} \e{path}
126
127\dd Private key file for authentication.
128
129\dt \cw{-s}
130
131\dd Remote command is SSH subsystem (SSH-2 only).
132
133\S{plink-manpage-more-information} MORE INFORMATION
134
135For more information on plink, it's probably best to go and look at
136the manual on the PuTTY web page:
137
138\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
139
140\S{plink-manpage-bugs} BUGS
141
142This man page isn't terribly complete. See the above web link for
143better documentation.