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