Mercurial > dropbear
annotate dbclient.1 @ 508:d4bbc0039008
- Set a default path, since bash won't export one otherwise (though it will set
one, leading to mysterious problems)
- Rearrange some options
| author | Matt Johnston <matt@ucc.asn.au> |
|---|---|
| date | Wed, 05 Nov 2008 13:30:23 +0000 |
| parents | d58c478bd399 |
| children | 4e251543b941 |
| 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 |
|
501
d58c478bd399
Add support for [email protected] delayed compression.
Matt Johnston <matt@ucc.asn.au>
parents:
472
diff
changeset
|
13 .RI [ command ] |
|
180
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
14 .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
|
15 .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
|
16 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
|
17 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
|
18 .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
|
19 .TP |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
20 .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
|
21 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
|
22 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
|
23 .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
|
24 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
|
25 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
|
26 .TP |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
27 .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
|
28 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
|
29 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
|
30 .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
|
31 (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
|
32 .TP |
|
327
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
33 .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
|
34 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
|
35 Forward the port |
|
327
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
36 .I listenport |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
37 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
|
38 .I port |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
39 on the host |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
40 .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
|
41 .TP |
|
327
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
42 .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
|
43 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
|
44 Forward the port |
|
327
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
45 .I listenport |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
46 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
|
47 .I port |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
48 on the host |
|
1857c2c551ea
Bring in changes from Debian 0.48.1-1
Matt Johnston <matt@ucc.asn.au>
parents:
326
diff
changeset
|
49 .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
|
50 .TP |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
51 .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
|
52 Username. |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
53 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
|
54 .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
|
55 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
|
56 .TP |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
57 .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
|
58 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
|
59 .TP |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
60 .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
|
61 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
|
62 .TP |
|
325
0e4f225b7e07
Add -N "no remote command" dbclient option.
Matt Johnston <matt@ucc.asn.au>
parents:
258
diff
changeset
|
63 .B \-N |
|
0e4f225b7e07
Add -N "no remote command" dbclient option.
Matt Johnston <matt@ucc.asn.au>
parents:
258
diff
changeset
|
64 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
|
65 .TP |
|
326
d965110e3f5c
add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
325
diff
changeset
|
66 .B \-f |
|
d965110e3f5c
add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
325
diff
changeset
|
67 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
|
68 This is useful when using password authentication. |
|
d965110e3f5c
add -f background option to dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
325
diff
changeset
|
69 .TP |
|
258
306499676384
* add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents:
180
diff
changeset
|
70 .B \-g |
|
306499676384
* add -g (dbclient) and -a (dropbear) options for allowing non-local
Matt Johnston <matt@ucc.asn.au>
parents:
180
diff
changeset
|
71 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
|
72 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
|
73 by the ssh server. |
| 437 | 74 .TP |
| 75 .B \-y | |
| 76 Always accept hostkeys if they are unknown. If a hostkey mismatch occurs the | |
| 77 connection will abort as normal. | |
|
449
3e6c536bc023
Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents:
446
diff
changeset
|
78 .TP |
|
3e6c536bc023
Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents:
446
diff
changeset
|
79 .B \-W \fIwindowsize |
|
3e6c536bc023
Add -W <windowsize> argument and document it.
Matt Johnston <matt@ucc.asn.au>
parents:
446
diff
changeset
|
80 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
|
81 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
|
82 default buffer size. |
|
454
7e43f5e473b9
- Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
449
diff
changeset
|
83 .TP |
|
7e43f5e473b9
- Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
449
diff
changeset
|
84 .B \-K \fItimeout_seconds |
|
7e43f5e473b9
- Add -K keepalive flag for dropbear and dbclient
Matt Johnston <matt@ucc.asn.au>
parents:
449
diff
changeset
|
85 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
|
86 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
|
87 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
|
88 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
|
89 if 0 disables keepalives. |
|
472
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
90 .SH ENVIRONMENT |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
91 .TP |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
92 .B SSH_ASKPASS |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
93 dbclient can use an external program to request a password from a user. |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
94 SSH_ASKPASS should be set to the path of a program that will return a password |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
95 on standard output. This program will only be used if either DISPLAY is set and |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
96 standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
97 set. |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
98 .TP |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
99 .B DROPBEAR_PASSWORD |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
100 A password to use for remote authentication can be specified in the environment |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
101 variable DROPBEAR_PASSWORD. Care should be taken that the password is not |
|
d7b0c015fdc7
Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
454
diff
changeset
|
102 exposed to other users on a multi-user system, or stored in accessible files. |
|
180
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
103 .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
|
104 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
|
105 .br |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
106 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
|
107 .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
|
108 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
|
109 .P |
|
743fce568f49
Merge in Debian package changes from 0.45-3, grab the dbclient manpage
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
110 http://matt.ucc.asn.au/dropbear/dropbear.html |