Mercurial > dropbear
diff dbclient.1 @ 1172:a44747e5a05a
Improve dbclient manpage
author | Matt Johnston <matt@ucc.asn.au> |
---|---|
date | Mon, 23 Nov 2015 23:02:03 +0800 |
parents | b8f362078209 |
children | 80cacacfec23 |
line wrap: on
line diff
--- a/dbclient.1 Mon Nov 23 22:47:43 2015 +0800 +++ b/dbclient.1 Mon Nov 23 23:02:03 2015 +0800 @@ -6,10 +6,11 @@ [flag arguments] [\-p .I port\fR] [\-i .I id\fR] [\-L -.I l\fR:\fIh\fR:\fIr\fR] [\-R -.I l\fR:\fIh\fR:\fIr\fR] [\-l +.I l\fR:\fIh\fR:\fIp\fR] [\-R +.I l\fR:\fIh\fR:\fIp\fR] [\-l .IR user ] .I host +.RI [ more\ flags ] .RI [ command ] .B dbclient @@ -20,11 +21,15 @@ .SH DESCRIPTION .B dbclient is a small SSH client -.P -If compiled with zlib support and if the server supports it, dbclient will -always use compression. .SH OPTIONS .TP +.TP +.B command +A command to run on the remote host. This will normally be run by the remote host +using the user's shell. The command begins at the first hyphen argument after the +host argument. If no command is specified an interactive terminal will be opened +(see -t and -T). +.TP .B \-p \fIport Connect to .I port @@ -63,10 +68,12 @@ on the remote host. .TP .B \-t -Allocate a PTY. +Allocate a PTY. This is the default when no command is given, it gives a full +interactive remote session. The main effect is that keystrokes are sent remotely +immediately as opposed to local line-based editing. .TP .B \-T -Don't allocate a PTY. +Don't allocate a PTY. This is the default a command is given. See -t. .TP .B \-N Don't request a remote shell or run any commands. Any command arguments are ignored. @@ -132,7 +139,7 @@ this case a connection will be made to the first host, then a TCP forwarded connection will be made through that to the second host, and so on. Hosts other than the final destination will not see anything other than the encrypted SSH stream. -A port for a host can be specified with a hash (eg matt@martello^44 ). +A port for a host can be specified with a caret (eg matt@martello^44 ). This syntax can also be used with scp or rsync (specifying dbclient as the ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg @@ -160,6 +167,10 @@ on standard output. This program will only be used if either DISPLAY is set and standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is set. +.SH NOTES +If compiled with zlib support and if the server supports it, dbclient will +always use compression. + .SH AUTHOR Matt Johnston ([email protected]). .br