annotate dbclient.1 @ 458:c1e9c81d1d27 agent-client

propagate from branch 'au.asn.ucc.matt.dropbear' (head 8a7db1e2fdc5636abb338adb636babc32f465739) to branch 'au.asn.ucc.matt.dropbear.cli-agent' (head d82c25da2f7e4fb6da510d806c64344e80bb270d)
author Matt Johnston <matt@ucc.asn.au>
date Thu, 16 Aug 2007 13:34:37 +0000
parents 7e43f5e473b9
children d7b0c015fdc7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
1 .TH dbclient 1
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
2 .SH NAME
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
3 dbclient \- lightweight SSH2 client
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
4 .SH SYNOPSIS
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 .B dbclient
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6 [\-Tt] [\-p
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
7 .I port\fR] [\-i
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
8 .I id\fR] [\-L
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
9 .I l\fR:\fIh\fR:\fIr\fR] [\-R
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
10 .I l\fR:\fIh\fR:\fIr\fR] [\-l
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
11 .IR user ]
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
12 .I host
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
13 .SH DESCRIPTION
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
14 .B dbclient
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
15 is a SSH 2 client designed to be small enough to be used in small memory
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
16 environments, while still being functional and secure enough for general use.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
17 .SH OPTIONS
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
19 .B \-p \fIport
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
20 Remote port.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
21 Connect to port
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
22 .I port
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23 on the remote host.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24 Default is 22.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
25 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26 .B \-i \fIidfile
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 Identity file.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28 Read the identity from file
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 .I idfile
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
30 (multiple allowed).
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 .TP
327
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
32 .B \-L \fIlistenport\fR:\fIhost\fR:\fIport\fR
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
33 Local port forwarding.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34 Forward the port
327
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
35 .I listenport
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
36 on the local host through the SSH connection to port
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
37 .I port
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
38 on the host
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
39 .IR host .
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
40 .TP
327
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
41 .B \-R \fIlistenport\fR:\fIhost\fR:\fIport\fR
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
42 Remote port forwarding.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
43 Forward the port
327
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
44 .I listenport
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
45 on the remote host through the SSH connection to port
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
46 .I port
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
47 on the host
1857c2c551ea Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents: 326
diff changeset
48 .IR host .
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
49 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
50 .B \-l \fIuser
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
51 Username.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
52 Login as
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
53 .I user
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
54 on the remote host.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
55 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
56 .B \-t
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
57 Allocate a pty.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
58 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
59 .B \-T
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
60 Don't allocate a pty.
258
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents: 180
diff changeset
61 .TP
325
0e4f225b7e07 Add -N "no remote command" dbclient option.
Matt Johnston <matt@ucc.asn.au>
parents: 258
diff changeset
62 .B \-N
0e4f225b7e07 Add -N "no remote command" dbclient option.
Matt Johnston <matt@ucc.asn.au>
parents: 258
diff changeset
63 Don't request a remote shell or run any commands. Any command arguments are ignored.
0e4f225b7e07 Add -N "no remote command" dbclient option.
Matt Johnston <matt@ucc.asn.au>
parents: 258
diff changeset
64 .TP
326
d965110e3f5c add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 325
diff changeset
65 .B \-f
d965110e3f5c add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 325
diff changeset
66 Fork into the background after authentication. A command argument (or -N) is required.
d965110e3f5c add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 325
diff changeset
67 This is useful when using password authentication.
d965110e3f5c add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 325
diff changeset
68 .TP
258
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents: 180
diff changeset
69 .B \-g
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents: 180
diff changeset
70 Allow non-local hosts to connect to forwarded ports. Applies to -L and -R
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents: 180
diff changeset
71 forwarded ports, though remote connections to -R forwarded ports may be limited
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents: 180
diff changeset
72 by the ssh server.
437
7319d229799a 0.49 probably done
Matt Johnston <matt@ucc.asn.au>
parents: 327
diff changeset
73 .TP
7319d229799a 0.49 probably done
Matt Johnston <matt@ucc.asn.au>
parents: 327
diff changeset
74 .B \-y
7319d229799a 0.49 probably done
Matt Johnston <matt@ucc.asn.au>
parents: 327
diff changeset
75 Always accept hostkeys if they are unknown. If a hostkey mismatch occurs the
7319d229799a 0.49 probably done
Matt Johnston <matt@ucc.asn.au>
parents: 327
diff changeset
76 connection will abort as normal.
449
3e6c536bc023 Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents: 446
diff changeset
77 .TP
3e6c536bc023 Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents: 446
diff changeset
78 .B \-W \fIwindowsize
3e6c536bc023 Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents: 446
diff changeset
79 Specify the per-channel receive window buffer size. Increasing this
3e6c536bc023 Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents: 446
diff changeset
80 may improve network performance at the expense of memory use. Use -h to see the
3e6c536bc023 Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents: 446
diff changeset
81 default buffer size.
454
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
82 .TP
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
83 .B \-K \fItimeout_seconds
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
84 Ensure that traffic is transmitted at a certain interval in seconds. This is
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
85 useful for working around firewalls or routers that drop connections after
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
86 a certain period of inactivity. The trade-off is that a session may be
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
87 closed if there is a temporary lapse of network connectivity. A setting
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents: 449
diff changeset
88 if 0 disables keepalives.
180
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
89 .SH AUTHOR
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90 Matt Johnston ([email protected]).
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
91 .br
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
92 Gerrit Pape ([email protected]) wrote this manual page.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
93 .SH SEE ALSO
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
94 dropbear(8), dropbearkey(8)
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
95 .P
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
96 http://matt.ucc.asn.au/dropbear/dropbear.html