release/src/router/dropbear/dbclient.1

   1 .TH dbclient 1
   2 .SH NAME
   3 dbclient \- lightweight SSH2 client
   4 .SH SYNOPSIS
   5 .B dbclient
   6 [\-Tt] [\-p
   7 .I port\fR] [\-i
   8 .I id\fR] [\-L
   9 .I l\fR:\fIh\fR:\fIr\fR] [\-R
  10 .I l\fR:\fIh\fR:\fIr\fR] [\-l
  11 .IR user ]
  12 .I host
  13 .RI [ command ]
  14
  15 .B dbclient
  16 [
  17 .I args ]
  18 .I [user1]@host1[/port1],[user2]@host2[/port2],...
  19
  20 .SH DESCRIPTION
  21 .B dbclient
  22 is a SSH 2 client designed to be small enough to be used in small memory
  23 environments, while still being functional and secure enough for general use.
  24 .SH OPTIONS
  25 .TP
  26 .B \-p \fIport
  27 Remote port.
  28 Connect to port
  29 .I port
  30 on the remote host.
  31 Default is 22.
  32 .TP
  33 .B \-i \fIidfile
  34 Identity file.
  35 Read the identity from file
  36 .I idfile
  37 (multiple allowed).
  38 .TP
  39 .B \-L [\fIlistenaddress\fR]:\fIlistenport\fR:\fIhost\fR:\fIport\fR
  40 Local port forwarding.
  41 Forward the port
  42 .I listenport
  43 on the local host through the SSH connection to port
  44 .I port
  45 on the host
  46 .IR host .
  47 .TP
  48 .B \-R [\fIlistenaddress\fR]:\fIlistenport\fR:\fIhost\fR:\fIport\fR
  49 Remote port forwarding.
  50 Forward the port
  51 .I listenport
  52 on the remote host through the SSH connection to port
  53 .I port
  54 on the host
  55 .IR host .
  56 .TP
  57 .B \-l \fIuser
  58 Username.
  59 Login as
  60 .I user
  61 on the remote host.
  62 .TP
  63 .B \-t
  64 Allocate a pty.
  65 .TP
  66 .B \-T
  67 Don't allocate a pty.
  68 .TP
  69 .B \-N
  70 Don't request a remote shell or run any commands. Any command arguments are ignored.
  71 .TP
  72 .B \-f
  73 Fork into the background after authentication. A command argument (or -N) is required.
  74 This is useful when using password authentication.
  75 .TP
  76 .B \-g
  77 Allow non-local hosts to connect to forwarded ports. Applies to -L and -R
  78 forwarded ports, though remote connections to -R forwarded ports may be limited
  79 by the ssh server.
  80 .TP
  81 .B \-y
  82 Always accept hostkeys if they are unknown. If a hostkey mismatch occurs the
  83 connection will abort as normal.
  84 .TP
  85 .B \-A
  86 Forward agent connections to the remote host. dbclient will use any
  87 OpenSSH-style agent program if available ($SSH_AUTH_SOCK will be set) for
  88 public key authentication.  Forwarding is only enabled if -A is specified.
  89 .TP
  90 .B \-W \fIwindowsize
  91 Specify the per-channel receive window buffer size. Increasing this
  92 may improve network performance at the expense of memory use. Use -h to see the
  93 default buffer size.
  94 .TP
  95 .B \-K \fItimeout_seconds
  96 Ensure that traffic is transmitted at a certain interval in seconds. This is
  97 useful for working around firewalls or routers that drop connections after
  98 a certain period of inactivity. The trade-off is that a session may be
  99 closed if there is a temporary lapse of network connectivity. A setting
 100 if 0 disables keepalives.
 101 .TP
 102 .B \-I \fIidle_timeout
 103 Disconnect the session if no traffic is transmitted or received for \fIidle_timeout\fR seconds.
 104 .TP
 105 .B \-J \fIproxy_command
 106 Use the standard input/output of the program \fIproxy_command\fR rather than using
 107 a normal TCP connection. A hostname should be still be provided, as this is used for
 108 comparing saved hostkeys.
 109 .TP
 110 .B \-B \fIendhost:endport
 111 "Netcat-alike" mode, where Dropbear will connect to the given host, then create a
 112 forwarded connection to \fIendhost\fR. This will then be presented as dbclient's
 113 standard input/output.
 114
 115 Dropbear will also allow multiple "hops" to be specified, separated by commas. In
 116 this case a connection will be made to the first host, then a TCP forwarded
 117 connection will be made through that to the second host, and so on. Hosts other than
 118 the final destination will not see anything other than the encrypted SSH stream.
 119 A port for a host can be specified with a slash (eg matt@martello/44 ).
 120 This syntax can also be used with scp or rsync (specifying dbclient as the
 121 ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg
 122
 123 scp -S dbclient matt@martello,root@wrt,canyons:/tmp/dump .
 124
 125 Note that hostnames are resolved by the prior hop (so "canyons" would be resolved by the host "wrt")
 126 in the example above, the same way as other -L TCP forwarded hosts are. Host keys are
 127 checked locally based on the given hostname.
 128
 129 .SH ENVIRONMENT
 130 .TP
 131 .B DROPBEAR_PASSWORD
 132 A password to use for remote authentication can be specified in the environment
 133 variable DROPBEAR_PASSWORD. Care should be taken that the password is not
 134 exposed to other users on a multi-user system, or stored in accessible files.
 135 .TP
 136 .B SSH_ASKPASS
 137 dbclient can use an external program to request a password from a user.
 138 SSH_ASKPASS should be set to the path of a program that will return a password
 139 on standard output. This program will only be used if either DISPLAY is set and
 140 standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is
 141 set.
 142 .SH AUTHOR
 143 Matt Johnston (matt@ucc.asn.au).
 144 .br
 145 Mihnea Stoenescu wrote initial Dropbear client support
 146 .br
 147 Gerrit Pape (pape@smarden.org) wrote this manual page.
 148 .SH SEE ALSO
 149 dropbear(8), dropbearkey(8)
 150 .P
 151 http://matt.ucc.asn.au/dropbear/dropbear.html