dropbear: dbclient.1 annotate

annotate dbclient.1 @ 1283:3017bc7d6238

move m_burn and function attributes to dbhelpers use m_burn for libtomcrypt zeromem() too

author	Matt Johnston <matt@ucc.asn.au>
date	Thu, 17 Mar 2016 23:21:33 +0800
parents	f7d565054e5f
children	f787f60f8e45

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
821 f8b28a3de6cb Don't say "SSH 2" any more since protocol version 1 is irrelevant Matt Johnston <matt@ucc.asn.au> parents: 784 diff changeset	3 dbclient \- lightweight SSH client
180 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
1174 80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	6 [\fIflag arguments\fR] [\-p
180 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
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	9 .I l\fR:\fIh\fR:\fIp\fR] [\-R
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	10 .I l\fR:\fIh\fR:\fIp\fR] [\-l
180 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
1174 80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	13 .RI [ \fImore\ flags\fR ]
501 d58c478bd399 Add support for [email protected] delayed compression. Matt Johnston <matt@ucc.asn.au> parents: 472 diff changeset	14 .RI [ command ]
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	15
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	16 .B dbclient
1174 80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	17 [\fIargs\fR]
80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	18 [\fIuser1\fR]@\fIhost1\fR[^\fIport1\fR],[\fIuser2\fR]@\fIhost2\fR[^\fIport2\fR],...
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	19
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	20 .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	21 .B dbclient
946 17d874ae93a1 Add '-V' for version Matt Johnston <matt@ucc.asn.au> parents: 895 diff changeset	22 is a small SSH client
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	23 .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	24 .TP
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	25 .TP
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	26 .B command
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	27 A command to run on the remote host. This will normally be run by the remote host
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	28 using the user's shell. The command begins at the first hyphen argument after the
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	29 host argument. If no command is specified an interactive terminal will be opened
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	30 (see -t and -T).
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	31 .TP
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	32 .B \-p \fIport
783 34e69908b3f7 Use '#' for host#port separator, document it. This fixes scp Matt Johnston <matt@ucc.asn.au> parents: 774 diff changeset	33 Connect to
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 .I port
895 5608a5a61c2a Change port separator to ^ since % is used in ipv6 addresses Matt Johnston <matt@ucc.asn.au> parents: 821 diff changeset	35 on the remote host. Alternatively a port can be specified as hostname^port.
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	36 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	37 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	38 .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	39 Identity file.
821 f8b28a3de6cb Don't say "SSH 2" any more since protocol version 1 is irrelevant Matt Johnston <matt@ucc.asn.au> parents: 784 diff changeset	40 Read the identity key from file
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 .I idfile
821 f8b28a3de6cb Don't say "SSH 2" any more since protocol version 1 is irrelevant Matt Johnston <matt@ucc.asn.au> parents: 784 diff changeset	42 (multiple allowed). This file is created with dropbearkey(1) or converted
999 295a08e9d07e Document ~/.ssh/id_dropbear Matt Johnston <matt@ucc.asn.au> parents: 946 diff changeset	43 from OpenSSH with dropbearconvert(1). The default path ~/.ssh/id_dropbear is used
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	44 .TP
1174 80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	45 .B \-L\fR [\fIlistenaddress\fR]:\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	46 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	47 Forward the port
327 1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	48 .I listenport
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	49 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	50 .I port
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	51 on the host
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	52 .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	53 .TP
1174 80cacacfec23 Fix minor manpage formatting issues Guilhem Moulin <guilhem@fripost.org> parents: 1172 diff changeset	54 .B \-R\fR [\fIlistenaddress\fR]:\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	55 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	56 Forward the port
327 1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	57 .I listenport
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	58 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	59 .I port
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	60 on the host
1857c2c551ea Bring in changes from Debian 0.48.1-1 Matt Johnston <matt@ucc.asn.au> parents: 326 diff changeset	61 .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	62 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	63 .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	64 Username.
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	65 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	66 .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	67 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	68 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	69 .B \-t
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	70 Allocate a PTY. This is the default when no command is given, it gives a full
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	71 interactive remote session. The main effect is that keystrokes are sent remotely
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	72 immediately as opposed to local line-based editing.
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	73 .TP
743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	74 .B \-T
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	75 Don't allocate a PTY. This is the default a command is given. See -t.
258 306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local Matt Johnston <matt@ucc.asn.au> parents: 180 diff changeset	76 .TP
325 0e4f225b7e07 Add -N "no remote command" dbclient option. Matt Johnston <matt@ucc.asn.au> parents: 258 diff changeset	77 .B \-N
0e4f225b7e07 Add -N "no remote command" dbclient option. Matt Johnston <matt@ucc.asn.au> parents: 258 diff changeset	78 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	79 .TP
326 d965110e3f5c add -f background option to dbclient Matt Johnston <matt@ucc.asn.au> parents: 325 diff changeset	80 .B \-f
d965110e3f5c add -f background option to dbclient Matt Johnston <matt@ucc.asn.au> parents: 325 diff changeset	81 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	82 This is useful when using password authentication.
d965110e3f5c add -f background option to dbclient Matt Johnston <matt@ucc.asn.au> parents: 325 diff changeset	83 .TP
258 306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local Matt Johnston <matt@ucc.asn.au> parents: 180 diff changeset	84 .B \-g
306499676384 * add -g (dbclient) and -a (dropbear) options for allowing non-local Matt Johnston <matt@ucc.asn.au> parents: 180 diff changeset	85 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	86 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	87 by the ssh server.
437 7319d229799a 0.49 probably done Matt Johnston <matt@ucc.asn.au> parents: 327 diff changeset	88 .TP
7319d229799a 0.49 probably done Matt Johnston <matt@ucc.asn.au> parents: 327 diff changeset	89 .B \-y
7319d229799a 0.49 probably done Matt Johnston <matt@ucc.asn.au> parents: 327 diff changeset	90 Always accept hostkeys if they are unknown. If a hostkey mismatch occurs the
772 7fc0aeada79c -y -y to disable hostkey checking Matt Johnston <matt@ucc.asn.au> parents: 697 diff changeset	91 connection will abort as normal. If specified a second time no host key checking
7fc0aeada79c -y -y to disable hostkey checking Matt Johnston <matt@ucc.asn.au> parents: 697 diff changeset	92 is performed at all, this is usually undesirable.
449 3e6c536bc023 Add -W <windowsize> argument and document it. Matt Johnston <matt@ucc.asn.au> parents: 446 diff changeset	93 .TP
560 52d7301e46bd Agent forwarding works Matt Johnston <matt@ucc.asn.au> parents: 516 diff changeset	94 .B \-A
52d7301e46bd Agent forwarding works Matt Johnston <matt@ucc.asn.au> parents: 516 diff changeset	95 Forward agent connections to the remote host. dbclient will use any
52d7301e46bd Agent forwarding works Matt Johnston <matt@ucc.asn.au> parents: 516 diff changeset	96 OpenSSH-style agent program if available ($SSH_AUTH_SOCK will be set) for
52d7301e46bd Agent forwarding works Matt Johnston <matt@ucc.asn.au> parents: 516 diff changeset	97 public key authentication. Forwarding is only enabled if -A is specified.
52d7301e46bd Agent forwarding works Matt Johnston <matt@ucc.asn.au> parents: 516 diff changeset	98 .TP
449 3e6c536bc023 Add -W <windowsize> argument and document it. Matt Johnston <matt@ucc.asn.au> parents: 446 diff changeset	99 .B \-W \fIwindowsize
3e6c536bc023 Add -W <windowsize> argument and document it. Matt Johnston <matt@ucc.asn.au> parents: 446 diff changeset	100 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	101 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	102 default buffer size.
454 7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient Matt Johnston <matt@ucc.asn.au> parents: 449 diff changeset	103 .TP
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient Matt Johnston <matt@ucc.asn.au> parents: 449 diff changeset	104 .B \-K \fItimeout_seconds
7e43f5e473b9 - Add -K keepalive flag for dropbear and dbclient Matt Johnston <matt@ucc.asn.au> parents: 449 diff changeset	105 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	106 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	107 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	108 closed if there is a temporary lapse of network connectivity. A setting
946 17d874ae93a1 Add '-V' for version Matt Johnston <matt@ucc.asn.au> parents: 895 diff changeset	109 if 0 disables keepalives. If no response is received for 3 consecutive keepalives the connection will be closed.
515 fe30d2a2d626 - Document idle_timeout Matt Johnston <matt@ucc.asn.au> parents: 510 diff changeset	110 .TP
fe30d2a2d626 - Document idle_timeout Matt Johnston <matt@ucc.asn.au> parents: 510 diff changeset	111 .B \-I \fIidle_timeout
fe30d2a2d626 - Document idle_timeout Matt Johnston <matt@ucc.asn.au> parents: 510 diff changeset	112 Disconnect the session if no traffic is transmitted or received for \fIidle_timeout\fR seconds.
fe30d2a2d626 - Document idle_timeout Matt Johnston <matt@ucc.asn.au> parents: 510 diff changeset	113 .TP
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	114 .B \-J \fIproxy_command
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	115 Use the standard input/output of the program \fIproxy_command\fR rather than using
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	116 a normal TCP connection. A hostname should be still be provided, as this is used for
1221 f7d565054e5f use exec for proxycommand Matt Johnston <matt@ucc.asn.au> parents: 1212 diff changeset	117 comparing saved hostkeys. This command will be executed as "exec proxy_command ..." with the
f7d565054e5f use exec for proxycommand Matt Johnston <matt@ucc.asn.au> parents: 1212 diff changeset	118 default shell.
515 fe30d2a2d626 - Document idle_timeout Matt Johnston <matt@ucc.asn.au> parents: 510 diff changeset	119 .TP
516 7fc4ba3c1cbb - Bump to 0.52 Matt Johnston <matt@ucc.asn.au> parents: 515 diff changeset	120 .B \-B \fIendhost:endport
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	121 "Netcat-alike" mode, where Dropbear will connect to the given host, then create a
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	122 forwarded connection to \fIendhost\fR. This will then be presented as dbclient's
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	123 standard input/output.
690 4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	124 .TP
4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	125 .B \-c \fIcipherlist
4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	126 Specify a comma separated list of ciphers to enable. Use \fI-c help\fR to list possibilities.
4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	127 .TP
4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	128 .B \-m \fIMAClist
4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	129 Specify a comma separated list of authentication MACs to enable. Use \fI-m help\fR to list possibilities.
697 aadfa8de977d improve subsystem/sftp documentation, and multi-hop manual formatting Matt Johnston <matt@ucc.asn.au> parents: 690 diff changeset	130 .TP
1206 2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	131 .B \-o \fIoption
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	132 Can be used to give options in the format used by OpenSSH config file. This is
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	133 useful for specifying options for which there is no separate command-line flag.
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	134 For full details of the options listed below, and their possible values, see
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	135 ssh_config(5).
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	136
1212 bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	137 For now following options have been implemented:
1206 2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	138 .RS
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	139 .TP
1212 bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	140 .B ExitOnForwardFailure
bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	141 Specifies whether dbclient should terminate the connection if it cannot set up all requested local and remote port forwardings. The argument must be “yes” or “no”. The default is “no”.
bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	142 .TP
bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	143 .B UseSyslog
bf626d259eb1 Support syslog logging in dbclient. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1206 diff changeset	144 Send dbclient log messages to syslog in addition to stderr.
1206 2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	145 .RE
2907c658fa76 Implemented ExitOnForwardFailure option for local and remote forwarding. Konstantin Tokarev <ktokarev@smartlabs.tv> parents: 1174 diff changeset	146 .TP
697 aadfa8de977d improve subsystem/sftp documentation, and multi-hop manual formatting Matt Johnston <matt@ucc.asn.au> parents: 690 diff changeset	147 .B \-s
aadfa8de977d improve subsystem/sftp documentation, and multi-hop manual formatting Matt Johnston <matt@ucc.asn.au> parents: 690 diff changeset	148 The specified command will be requested as a subsystem, used for sftp. Dropbear doesn't implement sftp itself but the OpenSSH sftp client can be used eg \fIsftp -S dbclient user@host\fR
946 17d874ae93a1 Add '-V' for version Matt Johnston <matt@ucc.asn.au> parents: 895 diff changeset	149 .TP
17d874ae93a1 Add '-V' for version Matt Johnston <matt@ucc.asn.au> parents: 895 diff changeset	150 .B \-V
17d874ae93a1 Add '-V' for version Matt Johnston <matt@ucc.asn.au> parents: 895 diff changeset	151 Print the version
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	152
697 aadfa8de977d improve subsystem/sftp documentation, and multi-hop manual formatting Matt Johnston <matt@ucc.asn.au> parents: 690 diff changeset	153 .SH MULTI-HOP
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	154 Dropbear will also allow multiple "hops" to be specified, separated by commas. In
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	155 this case a connection will be made to the first host, then a TCP forwarded
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	156 connection will be made through that to the second host, and so on. Hosts other than
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	157 the final destination will not see anything other than the encrypted SSH stream.
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	158 A port for a host can be specified with a caret (eg matt@martello^44 ).
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	159 This syntax can also be used with scp or rsync (specifying dbclient as the
510 b85507ade010 - Update manuals, include section on authorized_keys Matt Johnston <matt@ucc.asn.au> parents: 509 diff changeset	160 ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg
b85507ade010 - Update manuals, include section on authorized_keys Matt Johnston <matt@ucc.asn.au> parents: 509 diff changeset	161
b85507ade010 - Update manuals, include section on authorized_keys Matt Johnston <matt@ucc.asn.au> parents: 509 diff changeset	162 scp -S dbclient matt@martello,root@wrt,canyons:/tmp/dump .
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	163
516 7fc4ba3c1cbb - Bump to 0.52 Matt Johnston <matt@ucc.asn.au> parents: 515 diff changeset	164 Note that hostnames are resolved by the prior hop (so "canyons" would be resolved by the host "wrt")
7fc4ba3c1cbb - Bump to 0.52 Matt Johnston <matt@ucc.asn.au> parents: 515 diff changeset	165 in the example above, the same way as other -L TCP forwarded hosts are. Host keys are
7fc4ba3c1cbb - Bump to 0.52 Matt Johnston <matt@ucc.asn.au> parents: 515 diff changeset	166 checked locally based on the given hostname.
7fc4ba3c1cbb - Bump to 0.52 Matt Johnston <matt@ucc.asn.au> parents: 515 diff changeset	167
774 e8b2ca448928 Document escape chars Matt Johnston <matt@ucc.asn.au> parents: 772 diff changeset	168 .SH ESCAPE CHARACTERS
e8b2ca448928 Document escape chars Matt Johnston <matt@ucc.asn.au> parents: 772 diff changeset	169 Typing a newline followed by the key sequence \fI~.\fR (tilde, dot) will terminate a connection.
e8b2ca448928 Document escape chars Matt Johnston <matt@ucc.asn.au> parents: 772 diff changeset	170 The sequence \fI~^Z\fR (tilde, ctrl-z) will background the connection. This behaviour only
e8b2ca448928 Document escape chars Matt Johnston <matt@ucc.asn.au> parents: 772 diff changeset	171 applies when a PTY is used.
e8b2ca448928 Document escape chars Matt Johnston <matt@ucc.asn.au> parents: 772 diff changeset	172
472 d7b0c015fdc7 Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 454 diff changeset	173 .SH ENVIRONMENT
d7b0c015fdc7 Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 454 diff changeset	174 .TP
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	175 .B DROPBEAR_PASSWORD
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	176 A password to use for remote authentication can be specified in the environment
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	177 variable DROPBEAR_PASSWORD. Care should be taken that the password is not
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	178 exposed to other users on a multi-user system, or stored in accessible files.
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	179 .TP
472 d7b0c015fdc7 Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 454 diff changeset	180 .B SSH_ASKPASS
d7b0c015fdc7 Add SSH_ASKPASS and DROPBEAR_PASSWORD to the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 454 diff changeset	181 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	182 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	183 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	184 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	185 set.
1172 a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	186 .SH NOTES
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	187 If compiled with zlib support and if the server supports it, dbclient will
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	188 always use compression.
a44747e5a05a Improve dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: 1161 diff changeset	189
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	190 .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	191 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	192 .br
509 4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	193 Mihnea Stoenescu wrote initial Dropbear client support
4e251543b941 LICENSE - Update copyright to 2008 Matt Johnston <matt@ucc.asn.au> parents: 501 diff changeset	194 .br
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	195 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	196 .SH SEE ALSO
821 f8b28a3de6cb Don't say "SSH 2" any more since protocol version 1 is irrelevant Matt Johnston <matt@ucc.asn.au> parents: 784 diff changeset	197 dropbear(8), dropbearkey(1)
180 743fce568f49 Merge in Debian package changes from 0.45-3, grab the dbclient manpage Matt Johnston <matt@ucc.asn.au> parents: diff changeset	198 .P
690 4b47ff154ff6 Document "-m" and "-c" Matt Johnston <matt@ucc.asn.au> parents: 597 diff changeset	199 https://matt.ucc.asn.au/dropbear/dropbear.html

Mercurial > dropbear

annotate dbclient.1 @ 1283:3017bc7d6238