Mercurial > dropbear

comparison dbclient.1 @ 1172:a44747e5a05a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve dbclient manpage
author Matt Johnston <matt@ucc.asn.au>
date Mon, 23 Nov 2015 23:02:03 +0800
parents b8f362078209
children 80cacacfec23
comparison
equal deleted inserted replaced
1171:c745f720ae2e 1172:a44747e5a05a
4 .SH SYNOPSIS 4 .SH SYNOPSIS
5 .B dbclient 5 .B dbclient
6 [flag arguments] [\-p 6 [flag arguments] [\-p
7 .I port\fR] [\-i 7 .I port\fR] [\-i
8 .I id\fR] [\-L 8 .I id\fR] [\-L
9 .I l\fR:\fIh\fR:\fIr\fR] [\-R 9 .I l\fR:\fIh\fR:\fIp\fR] [\-R
10 .I l\fR:\fIh\fR:\fIr\fR] [\-l 10 .I l\fR:\fIh\fR:\fIp\fR] [\-l
11 .IR user ] 11 .IR user ]
12 .I host 12 .I host
13 .RI [ more\ flags ]
13 .RI [ command ] 14 .RI [ command ]
14 15
15 .B dbclient 16 .B dbclient
16 [ 17 [
17 .I args ] 18 .I args ]
18 .I [user1]@host1[^port1],[user2]@host2[^port2],... 19 .I [user1]@host1[^port1],[user2]@host2[^port2],...
19 20
20 .SH DESCRIPTION 21 .SH DESCRIPTION
21 .B dbclient 22 .B dbclient
22 is a small SSH client 23 is a small SSH client
23 .P
24 If compiled with zlib support and if the server supports it, dbclient will
25 always use compression.
26 .SH OPTIONS 24 .SH OPTIONS
25 .TP
26 .TP
27 .B command
28 A command to run on the remote host. This will normally be run by the remote host
29 using the user's shell. The command begins at the first hyphen argument after the
30 host argument. If no command is specified an interactive terminal will be opened
31 (see -t and -T).
27 .TP 32 .TP
28 .B \-p \fIport 33 .B \-p \fIport
29 Connect to 34 Connect to
30 .I port 35 .I port
31 on the remote host. Alternatively a port can be specified as hostname^port. 36 on the remote host. Alternatively a port can be specified as hostname^port.
61 Login as 66 Login as
62 .I user 67 .I user
63 on the remote host. 68 on the remote host.
64 .TP 69 .TP
65 .B \-t 70 .B \-t
66 Allocate a PTY. 71 Allocate a PTY. This is the default when no command is given, it gives a full
72 interactive remote session. The main effect is that keystrokes are sent remotely
73 immediately as opposed to local line-based editing.
67 .TP 74 .TP
68 .B \-T 75 .B \-T
69 Don't allocate a PTY. 76 Don't allocate a PTY. This is the default a command is given. See -t.
70 .TP 77 .TP
71 .B \-N 78 .B \-N
72 Don't request a remote shell or run any commands. Any command arguments are ignored. 79 Don't request a remote shell or run any commands. Any command arguments are ignored.
73 .TP 80 .TP
74 .B \-f 81 .B \-f
130 .SH MULTI-HOP 137 .SH MULTI-HOP
131 Dropbear will also allow multiple "hops" to be specified, separated by commas. In 138 Dropbear will also allow multiple "hops" to be specified, separated by commas. In
132 this case a connection will be made to the first host, then a TCP forwarded 139 this case a connection will be made to the first host, then a TCP forwarded
133 connection will be made through that to the second host, and so on. Hosts other than 140 connection will be made through that to the second host, and so on. Hosts other than
134 the final destination will not see anything other than the encrypted SSH stream. 141 the final destination will not see anything other than the encrypted SSH stream.
135 A port for a host can be specified with a hash (eg matt@martello^44 ). 142 A port for a host can be specified with a caret (eg matt@martello^44 ).
136 This syntax can also be used with scp or rsync (specifying dbclient as the 143 This syntax can also be used with scp or rsync (specifying dbclient as the
137 ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg 144 ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg
138 145
139 scp -S dbclient matt@martello,root@wrt,canyons:/tmp/dump . 146 scp -S dbclient matt@martello,root@wrt,canyons:/tmp/dump .
140 147
158 dbclient can use an external program to request a password from a user. 165 dbclient can use an external program to request a password from a user.
159 SSH_ASKPASS should be set to the path of a program that will return a password 166 SSH_ASKPASS should be set to the path of a program that will return a password
160 on standard output. This program will only be used if either DISPLAY is set and 167 on standard output. This program will only be used if either DISPLAY is set and
161 standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is 168 standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is
162 set. 169 set.
170 .SH NOTES
171 If compiled with zlib support and if the server supports it, dbclient will
172 always use compression.
173
163 .SH AUTHOR 174 .SH AUTHOR
164 Matt Johnston ([email protected]). 175 Matt Johnston ([email protected]).
165 .br 176 .br
166 Mihnea Stoenescu wrote initial Dropbear client support 177 Mihnea Stoenescu wrote initial Dropbear client support
167 .br 178 .br