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